Add support to add Return objects via AML that pass a single integer
argument to the named method.
Reviewed-by: Swatisri Kantamsetti
Reviewed-by: Ashish Singhal
---
.../Include/Library/AmlLib/AmlLib.h | 54 +
.../Common/AmlLib/CodeGen/AmlCodeGen.c| 224 ++
2 files changed, 278 insertions(+)
diff --git a/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
b/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
index d201ae9499fa..b82c7a3ce874 100644
--- a/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
+++ b/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
@@ -1194,6 +1194,60 @@ AmlCodeGenMethodRetInteger (
OUT AML_OBJECT_NODE_HANDLE *NewObjectNodeOPTIONAL
);
+/** AML code generation for a method returning a NameString that takes an
+integer argument.
+
+ AmlCodeGenMethodRetNameStringIntegerArgument (
+"MET0", "MET1", 1, TRUE, 3, 5, ParentNode, NewObjectNode
+);
+ is equivalent of the following ASL code:
+Method(MET0, 1, Serialized, 3) {
+ Return (MET1 (5))
+}
+
+ The ASL parameters "ReturnType" and "ParameterTypes" are not asked
+ in this function. They are optional parameters in ASL.
+
+ @param [in] MethodNameString The new Method's name.
+Must be a NULL-terminated ASL NameString
+e.g.: "MET0", "_SB.MET0", etc.
+The input string is copied.
+ @param [in] ReturnedNameString The name of the object returned by the
+method. Optional parameter, can be:
+ - NULL (ignored).
+ - A NULL-terminated ASL NameString.
+ e.g.: "MET0", "_SB.MET0", etc.
+ The input string is copied.
+ @param [in] NumArgs Number of arguments.
+Must be 0 <= NumArgs <= 6.
+ @param [in] IsSerialized TRUE is equivalent to Serialized.
+FALSE is equivalent to NotSerialized.
+Default is NotSerialized in ASL spec.
+ @param [in] SyncLevelSynchronization level for the method.
+Must be 0 <= SyncLevel <= 15.
+Default is 0 in ASL.
+ @param [in] IntegerArgument Argument to pass to the NameString.
+ @param [in] ParentNode If provided, set ParentNode as the parent
+of the node created.
+ @param [out] NewObjectNodeIf success, contains the created node.
+
+ @retval EFI_SUCCESS Success.
+ @retval EFI_INVALID_PARAMETER Invalid parameter.
+ @retval EFI_OUT_OF_RESOURCESFailed to allocate memory.
+**/
+EFI_STATUS
+EFIAPI
+AmlCodeGenMethodRetNameStringIntegerArgument (
+ IN CONST CHAR8 *MethodNameString,
+ IN CONST CHAR8 *ReturnedNameString OPTIONAL,
+ INUINT8 NumArgs,
+ INBOOLEAN IsSerialized,
+ INUINT8 SyncLevel,
+ INUINT64 IntegerArgument,
+ INAML_NODE_HANDLE ParentNode OPTIONAL,
+ OUT AML_OBJECT_NODE_HANDLE *NewObjectNodeOPTIONAL
+ );
+
/** Create a _LPI name.
AmlCreateLpiNode ("_LPI", 0, 1, ParentNode, ) is
diff --git a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
index 88537b7e2d27..d31a86e98c4c 100644
--- a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
+++ b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
@@ -1881,6 +1881,118 @@ AmlCodeGenReturnInteger (
return Status;
}
+/** AML code generation for a Return object node,
+returning the object as an input NameString with a integer argument.
+
+ AmlCodeGenReturn ("NAM1", 6, ParentNode, NewObjectNode) is
+ equivalent of the following ASL code:
+Return(NAM1 (6))
+
+ The ACPI 6.3 specification, s20.2.5.3 "Type 1 Opcodes Encoding" states:
+DefReturn := ReturnOp ArgObject
+ReturnOp := 0xA4
+ArgObject := TermArg => DataRefObject
+
+ Thus, the ReturnNode must be evaluated as a DataRefObject. It can
+ be a NameString referencing an object. As this CodeGen Api doesn't
+ do semantic checking, it is strongly advised to check the AML bytecode
+ generated by this function against an ASL compiler.
+
+ The ReturnNode must be generated inside a Method body scope.
+
+ @param [in] NameString The object referenced by this NameString
+ is returned by the Return ASL statement.
+ Must be a NULL-terminated ASL NameString
+ e.g.: "NAM1", "_SB.NAM1", etc.
+ The input string is copied.
+ @param [in]
