From: "PierreGondois" <pierre.gondois@arm.com>
To: devel@edk2.groups.io, Sami Mujawar <sami.mujawar@arm.com>,
Alexei.Fedorov@arm.com
Subject: [PATCH v3 17/21] DynamicTablesPkg: AML code generation for a Method returning a NS
Date: Fri, 8 Oct 2021 15:46:28 +0100 [thread overview]
Message-ID: <20211008144632.31894-18-Pierre.Gondois@arm.com> (raw)
In-Reply-To: <20211008144632.31894-1-Pierre.Gondois@arm.com>
From: Pierre Gondois <Pierre.Gondois@arm.com>
Add AmlCodeGenMethodRetNameString() to generate AML code to create
a Method returning a NameString (NS).
AmlCodeGenMethodRetNameString (
"MET0", "_CRS", 1, TRUE, 3, ParentNode, NewObjectNode
);
is equivalent of the following ASL code:
Method(MET0, 1, Serialized, 3) {
Return (_CRS)
}
Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>
Signed-off-by: Pierre Gondois <Pierre.Gondois@arm.com>
---
.../Include/Library/AmlLib/AmlLib.h | 53 +++++++++
.../Common/AmlLib/CodeGen/AmlCodeGen.c | 106 ++++++++++++++++++
2 files changed, 159 insertions(+)
diff --git a/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h b/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
index 6824cf3a6c82..7740aac24470 100644
--- a/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
+++ b/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
@@ -619,6 +619,59 @@ AmlCodeGenScope (
OUT AML_OBJECT_NODE_HANDLE * NewObjectNode OPTIONAL
);
+/** AML code generation for a method returning a NameString.
+
+ AmlCodeGenMethodRetNameString (
+ "MET0", "_CRS", 1, TRUE, 3, ParentNode, NewObjectNode
+ );
+ is equivalent of the following ASL code:
+ Method(MET0, 1, Serialized, 3) {
+ Return (_CRS)
+ }
+
+ The ASL parameters "ReturnType" and "ParameterTypes" are not asked
+ in this function. They are optional parameters in ASL.
+
+ @ingroup CodeGenApis
+
+ @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] SyncLevel Synchronization level for the method.
+ Must be 0 <= SyncLevel <= 15.
+ Default is 0 in ASL.
+ @param [in] ParentNode If provided, set ParentNode as the parent
+ of the node created.
+ @param [out] NewObjectNode If success, contains the created node.
+
+ @retval EFI_SUCCESS Success.
+ @retval EFI_INVALID_PARAMETER Invalid parameter.
+ @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
+**/
+EFI_STATUS
+EFIAPI
+AmlCodeGenMethodRetNameString (
+ IN CONST CHAR8 * MethodNameString,
+ IN CONST CHAR8 * ReturnedNameString, OPTIONAL
+ IN UINT8 NumArgs,
+ IN BOOLEAN IsSerialized,
+ IN UINT8 SyncLevel,
+ IN AML_NODE_HANDLE ParentNode, OPTIONAL
+ OUT AML_OBJECT_NODE_HANDLE * NewObjectNode OPTIONAL
+ );
+
// DEPRECATED APIS
#ifndef DISABLE_NEW_DEPRECATED_INTERFACES
diff --git a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
index 93d4ba79e937..f59a9599930f 100644
--- a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
+++ b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
@@ -1335,3 +1335,109 @@ exit_handler:
}
return Status;
}
+
+/** AML code generation for a method returning a NameString.
+
+ AmlCodeGenMethodRetNameString (
+ "MET0", "_CRS", 1, TRUE, 3, ParentNode, NewObjectNode
+ );
+ is equivalent of the following ASL code:
+ Method(MET0, 1, Serialized, 3) {
+ Return (_CRS)
+ }
+
+ 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] SyncLevel Synchronization level for the method.
+ Must be 0 <= SyncLevel <= 15.
+ Default is 0 in ASL.
+ @param [in] ParentNode If provided, set ParentNode as the parent
+ of the node created.
+ @param [out] NewObjectNode If success, contains the created node.
+
+ @retval EFI_SUCCESS Success.
+ @retval EFI_INVALID_PARAMETER Invalid parameter.
+ @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
+**/
+EFI_STATUS
+EFIAPI
+AmlCodeGenMethodRetNameString (
+ IN CONST CHAR8 * MethodNameString,
+ IN CONST CHAR8 * ReturnedNameString, OPTIONAL
+ IN UINT8 NumArgs,
+ IN BOOLEAN IsSerialized,
+ IN UINT8 SyncLevel,
+ IN AML_NODE_HANDLE ParentNode, OPTIONAL
+ OUT AML_OBJECT_NODE_HANDLE * NewObjectNode OPTIONAL
+ )
+{
+ EFI_STATUS Status;
+ AML_OBJECT_NODE_HANDLE MethodNode;
+
+ if ((MethodNameString == NULL) ||
+ ((ParentNode == NULL) && (NewObjectNode == NULL))) {
+ ASSERT (0);
+ return EFI_INVALID_PARAMETER;
+ }
+
+ // Create a Method named MethodNameString.
+ Status = AmlCodeGenMethod (
+ MethodNameString,
+ NumArgs,
+ IsSerialized,
+ SyncLevel,
+ NULL,
+ &MethodNode
+ );
+ if (EFI_ERROR (Status)) {
+ ASSERT (0);
+ return Status;
+ }
+
+ // Return ReturnedNameString if provided.
+ if (ReturnedNameString != NULL) {
+ Status = AmlCodeGenReturnNameString (
+ ReturnedNameString,
+ (AML_NODE_HANDLE)MethodNode,
+ NULL
+ );
+ if (EFI_ERROR (Status)) {
+ ASSERT (0);
+ goto error_handler;
+ }
+ }
+
+ Status = LinkNode (
+ MethodNode,
+ ParentNode,
+ NewObjectNode
+ );
+ if (EFI_ERROR (Status)) {
+ ASSERT (0);
+ goto error_handler;
+ }
+
+ return Status;
+
+error_handler:
+ if (MethodNode != NULL) {
+ AmlDeleteTree ((AML_NODE_HANDLE)MethodNode);
+ }
+ return Status;
+}
--
2.17.1
next prev parent reply other threads:[~2021-10-08 14:47 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-10-08 14:46 [PATCH v3 00/21] Create a SSDT CPU topology generator PierreGondois
2021-10-08 14:46 ` [PATCH v3 01/21] DynamicTablesPkg: Remove unnecessary includes PierreGondois
2021-10-08 14:46 ` [PATCH v3 02/21] DynamicTablesPkg: Add missing parameter check PierreGondois
2021-10-08 14:46 ` [PATCH v3 03/21] DynamicTablesPkg: Add AddSsdtAcpiHeader() PierreGondois
2021-10-08 14:46 ` [PATCH v3 04/21] DynamicTablesPkg: Add AmlRdSetEndTagChecksum() PierreGondois
2021-10-08 14:46 ` [PATCH v3 05/21] DynamicTablesPkg: Add AmlSetRdListCheckSum() PierreGondois
2021-10-08 14:46 ` [PATCH v3 06/21] DynamicTablesPkg: Set EndTag's Checksum if RdList is modified PierreGondois
2021-10-08 14:46 ` [PATCH v3 07/21] DynamicTablesPkg: Clear pointer in node creation fcts PierreGondois
2021-10-08 14:46 ` [PATCH v3 08/21] DynamicTablesPkg: Update error handling for node creation PierreGondois
2021-10-08 14:46 ` [PATCH v3 09/21] DynamicTablesPkg: Make AmlNodeGetIntegerValue public PierreGondois
2021-10-08 14:46 ` [PATCH v3 10/21] DynamicTablesPkg: AML Code generation for Register() PierreGondois
2021-10-08 14:46 ` [PATCH v3 11/21] DynamicTablesPkg: AML Code generation for Resource data EndTag PierreGondois
2021-10-08 14:46 ` [PATCH v3 12/21] DynamicTablesPkg: AML code generation for a Package PierreGondois
2021-10-08 14:46 ` [PATCH v3 13/21] DynamicTablesPkg: Helper function to compute package length PierreGondois
2021-10-08 14:46 ` [PATCH v3 14/21] DynamicTablesPkg: AML code generation for a ResourceTemplate PierreGondois
2021-10-08 14:46 ` [PATCH v3 15/21] DynamicTablesPkg: AML code generation for a Method PierreGondois
2021-10-08 14:46 ` [PATCH v3 16/21] DynamicTablesPkg: AML code generation to Return a NameString PierreGondois
2021-10-08 14:46 ` PierreGondois [this message]
2021-10-08 14:46 ` [PATCH v3 18/21] DynamicTablesPkg: AML code generation for a _LPI object PierreGondois
2021-10-08 14:46 ` [PATCH v3 19/21] DynamicTablesPkg: AML code generation to add an _LPI state PierreGondois
2021-10-08 14:46 ` [PATCH v3 20/21] DynamicTablesPkg: Add CM_ARM_LPI_INFO object PierreGondois
2021-10-08 14:46 ` [PATCH v3 21/21] DynamicTablesPkg: SSDT CPU topology and LPI state generator PierreGondois
2021-10-08 16:05 ` [PATCH v3 00/21] Create a SSDT CPU topology generator Sami Mujawar
2021-10-11 1:16 ` 回复: [edk2-devel] " gaoliming
2021-10-11 7:40 ` PierreGondois
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-list from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20211008144632.31894-18-Pierre.Gondois@arm.com \
--to=devel@edk2.groups.io \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox