DynamicTablesPkg: Dynamic AML: Add AmlLib library

ACPI Definition blocks are implemented using AML which has
a complex grammar making run-time generation of definition
blocks difficult. Dynamic AML is a feature of Dynamic Tables
framework that provides a solution for dynamic generation of
ACPI Definition block tables.

Since, AML bytecode represents complex AML grammar, an AmlLib
library is introduced to assist parsing and traversing of the
AML bytecode at run-time.

The AmlLib library parses a definition block and represents it
as an AML tree. The AML objects, methods and data are represented
as tree nodes. Since the AML data is represented as tree nodes,
it is possible to traverse the tree, locate a node and modify the
node data. The tree can then be serialized to a buffer (that
represents the definition block). This definition block containing
the fixed-up AML code can then be installed as an ACPI Definition
Block table.

Dynamic AML introduces the following techniques:
* AML Fixup
* AML Codegen
* AML Fixup + Codegen

AML Fixup is a technique that involves compiling an ASL template
file to generate AML bytecode. This template AML bytecode can be
parsed at run-time and a fixup code can update the required fields
in the AML template.

AML Codegen employs generating small segments of AML code.

AmlLib provides a rich set of APIs to operate on AML data for AML
Fixup and Codegen.

Signed-off-by: Pierre Gondois <pierre.gondois@arm.com>
Signed-off-by: Sami Mujawar <sami.mujawar@arm.com>
Reviewed-by: Alexei Fedorov <Alexei.Fedorov@arm.com>
This commit is contained in:
Pierre Gondois 2020-08-05 16:19:26 +01:00 committed by mergify[bot]
parent c85ac5245c
commit 095db69d4c
5 changed files with 88 additions and 3 deletions

View File

@ -13,6 +13,7 @@
RELEASE_*_*_CC_FLAGS = -DMDEPKG_NDEBUG
[LibraryClasses.common]
AmlLib|DynamicTablesPkg/Library/Common/AmlLib/AmlLib.inf
TableHelperLib|DynamicTablesPkg/Library/Common/TableHelperLib/TableHelperLib.inf
[Components.common]

View File

@ -1,7 +1,7 @@
## @file
# CI configuration for DynamicTablesPkg
#
# Copyright (c) 2020, ARM Limited. All rights reserved.<BR>
# Copyright (c) 2020, Arm Limited. All rights reserved.<BR>
# SPDX-License-Identifier: BSD-2-Clause-Patent
##
{
@ -69,11 +69,15 @@
"IgnoreFiles": [], # use gitignore syntax to ignore errors
# in matching files
"ExtendWords": [
"EISAID",
"CCIDX",
"CCSIDR",
"countof",
"EOBJECT",
"invoc",
"GTBLOCK",
"lgreater",
"lless",
"MPIDR",
"pytool",
"Roadmap",

View File

@ -1,7 +1,7 @@
## @file
# dec file for Dynamic Tables Framework.
#
# Copyright (c) 2017 - 2020, ARM Limited. All rights reserved.<BR>
# Copyright (c) 2017 - 2020, Arm Limited. All rights reserved.<BR>
#
# SPDX-License-Identifier: BSD-2-Clause-Patent
#
@ -17,6 +17,9 @@
Include
[LibraryClasses]
## @libraryclass Defines a set of APIs for Dynamic AML generation.
AmlLib|Include/Library/AmlLib/AmlLib.h
## @libraryclass Defines a set of helper methods.
TableHelperLib|Include/Library/TableHelperLib.h

View File

@ -2,7 +2,7 @@
# Dsc file for Dynamic Tables Framework.
#
# Copyright (c) 2019, Linaro Limited. All rights reserved.<BR>
# Copyright (c) 2019 - 2020, ARM Limited. All rights reserved.<BR>
# Copyright (c) 2019 - 2020, Arm Limited. All rights reserved.<BR>
#
# SPDX-License-Identifier: BSD-2-Clause-Patent
#
@ -36,6 +36,7 @@
PL011UartLib|ArmPlatformPkg/Library/PL011UartLib/PL011UartLib.inf
[Components.common]
DynamicTablesPkg/Library/Common/AmlLib/AmlLib.inf
DynamicTablesPkg/Library/Common/TableHelperLib/TableHelperLib.inf
[BuildOptions]

View File

@ -0,0 +1,76 @@
## @file
# AML Generation Library
#
# Copyright (c) 2019 - 2020, Arm Limited. All rights reserved.<BR>
#
# SPDX-License-Identifier: BSD-2-Clause-Patent
##
[Defines]
INF_VERSION = 0x0001001B
BASE_NAME = DynamicAmlLib
FILE_GUID = 23A6AFDA-F2A5-45EC-BEFF-420639D345B9
VERSION_STRING = 1.0
MODULE_TYPE = DXE_DRIVER
LIBRARY_CLASS = AmlLib
[Sources]
AmlCoreInterface.h
AmlDefines.h
AmlInclude.h
AmlNodeDefines.h
AmlDbgPrint/AmlDbgPrint.c
AmlDbgPrint/AmlDbgPrint.h
AmlEncoding/Aml.c
AmlEncoding/Aml.h
Api/AmlApi.c
Api/AmlApiHelper.c
Api/AmlApiHelper.h
Api/AmlResourceDataApi.c
CodeGen/AmlCodeGen.c
CodeGen/AmlResourceDataCodeGen.c
CodeGen/AmlResourceDataCodeGen.h
NameSpace/AmlNameSpace.c
NameSpace/AmlNameSpace.h
Parser/AmlFieldListParser.c
Parser/AmlFieldListParser.h
Parser/AmlMethodParser.c
Parser/AmlMethodParser.h
Parser/AmlParser.c
Parser/AmlParser.h
Parser/AmlResourceDataParser.c
Parser/AmlResourceDataParser.h
ResourceData/AmlResourceData.c
ResourceData/AmlResourceData.h
Serialize/AmlSerialize.c
Stream/AmlStream.c
Stream/AmlStream.h
String/AmlString.c
String/AmlString.h
Tree/AmlClone.c
Tree/AmlTreeIterator.h
Tree/AmlNode.c
Tree/AmlNode.h
Tree/AmlNodeInterface.c
Tree/AmlTree.c
Tree/AmlTree.h
Tree/AmlTreeEnumerator.c
Tree/AmlTreeIterator.c
Tree/AmlTreeTraversal.c
Tree/AmlTreeTraversal.h
Utils/AmlUtility.c
Utils/AmlUtility.h
[Packages]
MdePkg/MdePkg.dec
DynamicTablesPkg/DynamicTablesPkg.dec
[LibraryClasses]
BaseLib
[BuildOptions]
*_*_*_CC_FLAGS = -DAML_HANDLE
[Protocols]
[Guids]