From: "Sami Mujawar" <sami.mujawar@arm.com>
To: Jeff Brasen <jbrasen@nvidia.com>, devel@edk2.groups.io
Cc: pierre.gondois@arm.com, swatisrik@nvidia.com,
ashishsingha@nvidia.com, "nd@arm.com" <nd@arm.com>
Subject: Re: [edk2-devel] [PATCH v4 2/4] DynamicTablesPkg: Add support for simple method\r invocation.
Date: Thu, 21 Sep 2023 17:49:24 +0100 [thread overview]
Message-ID: <885016b1-c8f3-8951-8473-15a37cd640a2@arm.com> (raw)
In-Reply-To: <737650480edcab199927322064b2459f647f9f02.1695049337.git.jbrasen@nvidia.com>
[-- Attachment #1: Type: text/plain, Size: 16103 bytes --]
Hi Jeff,
Thank you for this patch.
Please see my response inline marked [SAMI].
Regards,
Sami Mujawar
On 18/09/2023 04:46 pm, Jeff Brasen wrote:
> Add support to add Return objects via AML that pass a single integer
>
> argument to the named method.
>
>
>
> Signed-off-by: Jeff Brasen<jbrasen@nvidia.com>
>
> ---
>
> .../Include/Library/AmlLib/AmlLib.h | 54 ++++
>
> .../Common/AmlLib/CodeGen/AmlCodeGen.c | 244 ++++++++++++++++++
>
> 2 files changed, 298 insertions(+)
>
>
>
> diff --git a/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h b/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
>
> index d201ae9499..b82c7a3ce8 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 *NewObjectNode OPTIONAL
>
> );
>
>
>
> +/** 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] SyncLevel Synchronization 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] 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
>
> +AmlCodeGenMethodRetNameStringIntegerArgument (
>
> + IN CONST CHAR8 *MethodNameString,
>
> + IN CONST CHAR8 *ReturnedNameString OPTIONAL,
>
> + IN UINT8 NumArgs,
>
> + IN BOOLEAN IsSerialized,
>
> + IN UINT8 SyncLevel,
>
> + IN UINT64 IntegerArgument,
>
> + IN AML_NODE_HANDLE ParentNode OPTIONAL,
>
> + OUT AML_OBJECT_NODE_HANDLE *NewObjectNode OPTIONAL
>
> + );
>
> +
>
> /** Create a _LPI name.
>
>
>
> AmlCreateLpiNode ("_LPI", 0, 1, ParentNode, &LpiNode) is
>
> diff --git a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
>
> index 88537b7e2d..ea519d1aa8 100644
>
> --- a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
>
> +++ b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
>
> @@ -1881,6 +1881,138 @@ 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] Integer Argument to pass to the NameString
>
> + @param [in] ParentNode If provided, set ParentNode as the parent
>
> + of the node created.
>
> + Must be a MethodOp node.
>
> + @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.
>
> +**/
>
> +STATIC
>
> +EFI_STATUS
>
> +EFIAPI
>
> +AmlCodeGenReturnNameStringIntegerArgument (
>
> + IN CONST CHAR8 *NameString,
>
> + IN UINT64 Integer,
>
> + IN AML_NODE_HEADER *ParentNode OPTIONAL,
>
> + OUT AML_OBJECT_NODE **NewObjectNode OPTIONAL
>
> + )
>
> +{
>
> + EFI_STATUS Status;
>
> + AML_DATA_NODE *DataNode;
>
> + AML_OBJECT_NODE *IntNode;
>
> + CHAR8 *AmlNameString;
>
> + UINT32 AmlNameStringSize;
>
> + AML_OBJECT_NODE *ObjectNode;
>
> +
>
> + DataNode = NULL;
>
> + IntNode = NULL;
>
> + ObjectNode = NULL;
>
> +
>
> + Status = ConvertAslNameToAmlName (NameString, &AmlNameString);
>
> + if (EFI_ERROR (Status)) {
>
> + ASSERT (0);
>
> + return Status;
>
> + }
>
> +
>
> + Status = AmlGetNameStringSize (AmlNameString, &AmlNameStringSize);
>
> + if (EFI_ERROR (Status)) {
>
> + ASSERT (0);
>
> + goto exit_handler;
>
> + }
>
> +
>
> + Status = AmlCreateDataNode (
>
> + EAmlNodeDataTypeNameString,
>
> + (UINT8 *)AmlNameString,
>
> + AmlNameStringSize,
>
> + &DataNode
>
> + );
>
> + if (EFI_ERROR (Status)) {
>
> + ASSERT (0);
>
> + goto exit_handler;
>
> + }
>
> +
>
> + Status = AmlCodeGenInteger (Integer, &IntNode);
>
> + if (EFI_ERROR (Status)) {
>
> + ASSERT (0);
>
> + goto exit_handler;
>
> + }
>
> +
>
> + // AmlCodeGenReturn() deletes DataNode if error.
>
> + Status = AmlCodeGenReturn (
>
> + (AML_NODE_HEADER *)DataNode,
>
> + ParentNode,
>
> + &ObjectNode
>
> + );
>
> +
>
> + // DataNode is either deleted or added to ObjectNode, set to NULL so we don't
>
> + // delete it again
>
> + DataNode = NULL;
>
> + if (EFI_ERROR (Status)) {
>
> + ASSERT (0);
>
> + goto exit_handler;
>
> + }
>
> +
>
> + Status = AmlVarListAddTail (
>
> + (AML_NODE_HANDLE)ObjectNode,
>
> + (AML_NODE_HANDLE)IntNode
>
> + );
>
> + if (EFI_ERROR (Status)) {
>
> + ASSERT (0);
>
> + goto exit_handler;
>
> + }
>
> +
>
> + if (NewObjectNode != 0) {
>
> + *NewObjectNode = ObjectNode;
>
> + }
>
> +
>
> +exit_handler:
>
> + if (AmlNameString != NULL) {
>
> + FreePool (AmlNameString);
>
> + }
>
> +
>
> + if (IntNode != NULL) {
>
> + AmlDeleteTree ((AML_NODE_HANDLE)IntNode);
>
> + }
>
> +
>
> + if (DataNode != NULL) {
>
> + AmlDeleteTree ((AML_NODE_HANDLE)DataNode);
>
> + }
>
> +
>
> + if (ObjectNode != NULL) {
>
> + AmlDeleteTree ((AML_NODE_HANDLE)ObjectNode);
>
> + }
>
> +
>
> + return Status;
>
> +}
[SAMI] I think the error handling in the above function can be
simplified as below:
...
STATIC
EFI_STATUS
EFIAPI
AmlCodeGenReturnNameStringIntegerArgument (
INCONSTCHAR8 *NameString,
IN UINT64 Integer,
IN AML_NODE_HEADER *ParentNode OPTIONAL,
OUT AML_OBJECT_NODE **NewObjectNode OPTIONAL
)
{
EFI_STATUS Status;
AML_DATA_NODE *DataNode;
AML_OBJECT_NODE *IntNode;
CHAR8 *AmlNameString;
UINT32 AmlNameStringSize;
AML_OBJECT_NODE *ObjectNode;
DataNode = NULL;
IntNode = NULL;
ObjectNode = NULL;
Status = ConvertAslNameToAmlName (NameString, &AmlNameString);
if(EFI_ERROR (Status)) {
ASSERT(0);
returnStatus;
}
Status = AmlGetNameStringSize (AmlNameString, &AmlNameStringSize);
if(EFI_ERROR (Status)) {
ASSERT(0);
gotoexit_handler;
}
Status = AmlCodeGenInteger (Integer, &IntNode);
if(EFI_ERROR (Status)) {
ASSERT(0);
gotoexit_handler;
}
Status = AmlCreateDataNode (
EAmlNodeDataTypeNameString,
(UINT8 *)AmlNameString,
AmlNameStringSize,
&DataNode
);
if(EFI_ERROR (Status)) {
ASSERT(0);
gotoexit_handler1;
}
// AmlCodeGenReturn() deletes DataNode if error.
Status = AmlCodeGenReturn (
(AML_NODE_HEADER *)DataNode,
ParentNode,
&ObjectNode
);
if(EFI_ERROR (Status)) {
ASSERT(0);
gotoexit_handler1;
}
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)ObjectNode,
(AML_NODE_HANDLE)IntNode
);
if(EFI_ERROR (Status)) {
// ObjectNode is already attached to ParentNode in AmlCodeGenReturn(),
// so no need to free it here, it will be deleted when deleting the
// ParentNode tree
ASSERT(0);
gotoexit_handler1;
}
if(NewObjectNode != 0) {
*NewObjectNode = ObjectNode;
}
gotoexit_handler;
exit_handler1:
if(IntNode != NULL) {
AmlDeleteTree ((AML_NODE_HANDLE)IntNode);
}
exit_handler:
if(AmlNameString != NULL) {
FreePool (AmlNameString);
}
returnStatus;
}
Please let me know if you agree with this, and I will make this change
before merging.
[/SAMI]
> +
>
> /** AML code generation for a method returning a NameString.
>
>
>
> AmlCodeGenMethodRetNameString (
>
> @@ -1989,6 +2121,118 @@ error_handler:
>
> return Status;
>
> }
>
>
>
> +/** 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] SyncLevel Synchronization 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] 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
>
> +AmlCodeGenMethodRetNameStringIntegerArgument (
>
> + IN CONST CHAR8 *MethodNameString,
>
> + IN CONST CHAR8 *ReturnedNameString OPTIONAL,
>
> + IN UINT8 NumArgs,
>
> + IN BOOLEAN IsSerialized,
>
> + IN UINT8 SyncLevel,
>
> + IN UINT64 IntegerArgument,
>
> + 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 = AmlCodeGenReturnNameStringIntegerArgument (
>
> + ReturnedNameString,
>
> + IntegerArgument,
>
> + (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;
>
> +}
>
> +
>
> /** AML code generation for a method returning an Integer.
>
>
>
> AmlCodeGenMethodRetInteger (
>
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#108955): https://edk2.groups.io/g/devel/message/108955
Mute This Topic: https://groups.io/mt/101436335/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-
[-- Attachment #2: Type: text/html, Size: 25488 bytes --]
next prev parent reply other threads:[~2023-09-21 16:49 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-09-18 15:46 [edk2-devel] [PATCH v4 0/4] Add support for generating ACPI ThermalZones Jeff Brasen via groups.io
2023-09-18 15:46 ` [edk2-devel] [PATCH v4 1/4] DynamicTablesPkg: Add ThermalZone CodeGen function Jeff Brasen via groups.io
2023-09-18 15:46 ` [edk2-devel] [PATCH v4 2/4] DynamicTablesPkg: Add support for simple method invocation Jeff Brasen via groups.io
2023-09-21 16:49 ` Sami Mujawar [this message]
2023-09-21 17:38 ` Jeff Brasen via groups.io
2023-09-21 20:07 ` Sami Mujawar
2023-09-21 20:48 ` Jeff Brasen via groups.io
2023-09-23 4:22 ` Attar, AbdulLateef (Abdul Lateef) via groups.io
2023-09-27 15:07 ` PierreGondois
2023-09-18 15:46 ` [edk2-devel] [PATCH v4 3/4] DynamicTablesPkg: Add support to add Strings to package Jeff Brasen via groups.io
2023-09-21 16:49 ` Sami Mujawar
2023-09-21 16:52 ` Jeff Brasen via groups.io
2023-09-18 15:47 ` [edk2-devel] [PATCH v4 4/4] DynamicTablesPkg: Add Aml NameUnicodeString API Jeff Brasen via groups.io
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=885016b1-c8f3-8951-8473-15a37cd640a2@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