* [PATCH 1/4] DynamicTablesPkg: Add ThermalZone CodeGen function
2023-06-29 23:01 [PATCH 0/4] Add support for generating ACPI ThermalZones Jeff Brasen
@ 2023-06-29 23:01 ` Jeff Brasen
2023-07-03 9:42 ` PierreGondois
2023-06-29 23:01 ` [PATCH 2/4] DynamicTablesPkg: Add support for simple method invocation Jeff Brasen
` (2 subsequent siblings)
3 siblings, 1 reply; 10+ messages in thread
From: Jeff Brasen @ 2023-06-29 23:01 UTC (permalink / raw)
To: devel
Cc: Sami.Mujawar, Alexei.Fedorov, pierre.gondois, Jeff Brasen,
Swatisri Kantamsetti, Ashish Singhal
Add API to generate a ThermalZone object to AmlLib.
Signed-off-by: Jeff Brasen <jbrasen@nvidia.com>
Reviewed-by: Swatisri Kantamsetti <swatisrik@nvidia.com>
Reviewed-by: Ashish Singhal <ashishsingha@nvidia.com>
---
.../Include/Library/AmlLib/AmlLib.h | 28 +++++
.../Common/AmlLib/CodeGen/AmlCodeGen.c | 116 ++++++++++++++++++
2 files changed, 144 insertions(+)
diff --git a/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h b/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
index 9210c50915..d201ae9499 100644
--- a/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
+++ b/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
@@ -1038,6 +1038,34 @@ AmlCodeGenDevice (
OUT AML_OBJECT_NODE_HANDLE *NewObjectNode OPTIONAL
);
+/** AML code generation for a ThermalZone object node.
+
+ AmlCodeGenThermalZone ("TZ00", ParentNode, NewObjectNode) is
+ equivalent of the following ASL code:
+ ThermalZone(TZ00) {}
+
+ @ingroup CodeGenApis
+
+ @param [in] NameString The new ThermalZone's name.
+ Must be a NULL-terminated ASL NameString
+ e.g.: "DEV0", "DV15.DEV0", etc.
+ The input string is copied.
+ @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
+AmlCodeGenThermalZone (
+ IN CONST CHAR8 *NameString,
+ IN AML_NODE_HANDLE ParentNode OPTIONAL,
+ OUT AML_OBJECT_NODE_HANDLE *NewObjectNode OPTIONAL
+ );
+
/** AML code generation for a Scope object node.
AmlCodeGenScope ("_SB", ParentNode, NewObjectNode) is
diff --git a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
index 0b223379fa..88537b7e2d 100644
--- a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
+++ b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
@@ -1218,6 +1218,122 @@ error_handler1:
return Status;
}
+/** AML code generation for a ThermalZone object node.
+
+ AmlCodeGenThermalZone ("TZ00", ParentNode, NewObjectNode) is
+ equivalent of the following ASL code:
+ ThermalZone(TZ00) {}
+
+ @ingroup CodeGenApis
+
+ @param [in] NameString The new ThermalZone's name.
+ Must be a NULL-terminated ASL NameString
+ e.g.: "DEV0", "DV15.DEV0", etc.
+ The input string is copied.
+ @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
+AmlCodeGenThermalZone (
+ IN CONST CHAR8 *NameString,
+ IN AML_NODE_HANDLE ParentNode OPTIONAL,
+ OUT AML_OBJECT_NODE_HANDLE *NewObjectNode OPTIONAL
+ )
+{
+ EFI_STATUS Status;
+ AML_OBJECT_NODE *ObjectNode;
+ AML_DATA_NODE *DataNode;
+ CHAR8 *AmlNameString;
+ UINT32 AmlNameStringSize;
+
+ if ((NameString == NULL) ||
+ ((ParentNode == NULL) && (NewObjectNode == NULL)))
+ {
+ ASSERT (0);
+ return EFI_INVALID_PARAMETER;
+ }
+
+ ObjectNode = NULL;
+ DataNode = NULL;
+ AmlNameString = NULL;
+
+ Status = ConvertAslNameToAmlName (NameString, &AmlNameString);
+ if (EFI_ERROR (Status)) {
+ ASSERT (0);
+ return Status;
+ }
+
+ Status = AmlGetNameStringSize (AmlNameString, &AmlNameStringSize);
+ if (EFI_ERROR (Status)) {
+ ASSERT (0);
+ goto error_handler1;
+ }
+
+ Status = AmlCreateObjectNode (
+ AmlGetByteEncodingByOpCode (AML_EXT_OP, AML_EXT_THERMAL_ZONE_OP),
+ AmlNameStringSize + AmlComputePkgLengthWidth (AmlNameStringSize),
+ &ObjectNode
+ );
+ if (EFI_ERROR (Status)) {
+ ASSERT (0);
+ goto error_handler1;
+ }
+
+ Status = AmlCreateDataNode (
+ EAmlNodeDataTypeNameString,
+ (UINT8 *)AmlNameString,
+ AmlNameStringSize,
+ &DataNode
+ );
+ if (EFI_ERROR (Status)) {
+ ASSERT (0);
+ goto error_handler2;
+ }
+
+ Status = AmlSetFixedArgument (
+ ObjectNode,
+ EAmlParseIndexTerm0,
+ (AML_NODE_HEADER *)DataNode
+ );
+ if (EFI_ERROR (Status)) {
+ ASSERT (0);
+ AmlDeleteTree ((AML_NODE_HEADER *)DataNode);
+ goto error_handler2;
+ }
+
+ Status = LinkNode (
+ ObjectNode,
+ ParentNode,
+ NewObjectNode
+ );
+ if (EFI_ERROR (Status)) {
+ ASSERT (0);
+ goto error_handler2;
+ }
+
+ // Free AmlNameString before returning as it is copied
+ // in the call to AmlCreateDataNode().
+ goto error_handler1;
+
+error_handler2:
+ if (ObjectNode != NULL) {
+ AmlDeleteTree ((AML_NODE_HEADER *)ObjectNode);
+ }
+
+error_handler1:
+ if (AmlNameString != NULL) {
+ FreePool (AmlNameString);
+ }
+
+ return Status;
+}
+
/** AML code generation for a Scope object node.
AmlCodeGenScope ("_SB", ParentNode, NewObjectNode) is
--
2.25.1
^ permalink raw reply related [flat|nested] 10+ messages in thread* Re: [PATCH 1/4] DynamicTablesPkg: Add ThermalZone CodeGen function
2023-06-29 23:01 ` [PATCH 1/4] DynamicTablesPkg: Add ThermalZone CodeGen function Jeff Brasen
@ 2023-07-03 9:42 ` PierreGondois
0 siblings, 0 replies; 10+ messages in thread
From: PierreGondois @ 2023-07-03 9:42 UTC (permalink / raw)
To: Jeff Brasen, devel
Cc: Sami.Mujawar, Alexei.Fedorov, Swatisri Kantamsetti,
Ashish Singhal
Hello Jeff,
Reviewed-by: Pierre Gondois <pierre.gondois@arm.com>
On 6/30/23 01:01, Jeff Brasen wrote:
> Add API to generate a ThermalZone object to AmlLib.
>
> Signed-off-by: Jeff Brasen <jbrasen@nvidia.com>
> Reviewed-by: Swatisri Kantamsetti <swatisrik@nvidia.com>
> Reviewed-by: Ashish Singhal <ashishsingha@nvidia.com>
> ---
> .../Include/Library/AmlLib/AmlLib.h | 28 +++++
> .../Common/AmlLib/CodeGen/AmlCodeGen.c | 116 ++++++++++++++++++
> 2 files changed, 144 insertions(+)
>
> diff --git a/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h b/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
> index 9210c50915..d201ae9499 100644
> --- a/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
> +++ b/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
> @@ -1038,6 +1038,34 @@ AmlCodeGenDevice (
> OUT AML_OBJECT_NODE_HANDLE *NewObjectNode OPTIONAL
> );
>
> +/** AML code generation for a ThermalZone object node.
> +
> + AmlCodeGenThermalZone ("TZ00", ParentNode, NewObjectNode) is
> + equivalent of the following ASL code:
> + ThermalZone(TZ00) {}
> +
> + @ingroup CodeGenApis
> +
> + @param [in] NameString The new ThermalZone's name.
> + Must be a NULL-terminated ASL NameString
> + e.g.: "DEV0", "DV15.DEV0", etc.
> + The input string is copied.
> + @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
> +AmlCodeGenThermalZone (
> + IN CONST CHAR8 *NameString,
> + IN AML_NODE_HANDLE ParentNode OPTIONAL,
> + OUT AML_OBJECT_NODE_HANDLE *NewObjectNode OPTIONAL
> + );
> +
> /** AML code generation for a Scope object node.
>
> AmlCodeGenScope ("_SB", ParentNode, NewObjectNode) is
> diff --git a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
> index 0b223379fa..88537b7e2d 100644
> --- a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
> +++ b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
> @@ -1218,6 +1218,122 @@ error_handler1:
> return Status;
> }
>
> +/** AML code generation for a ThermalZone object node.
> +
> + AmlCodeGenThermalZone ("TZ00", ParentNode, NewObjectNode) is
> + equivalent of the following ASL code:
> + ThermalZone(TZ00) {}
> +
> + @ingroup CodeGenApis
> +
> + @param [in] NameString The new ThermalZone's name.
> + Must be a NULL-terminated ASL NameString
> + e.g.: "DEV0", "DV15.DEV0", etc.
> + The input string is copied.
> + @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
> +AmlCodeGenThermalZone (
> + IN CONST CHAR8 *NameString,
> + IN AML_NODE_HANDLE ParentNode OPTIONAL,
> + OUT AML_OBJECT_NODE_HANDLE *NewObjectNode OPTIONAL
> + )
> +{
> + EFI_STATUS Status;
> + AML_OBJECT_NODE *ObjectNode;
> + AML_DATA_NODE *DataNode;
> + CHAR8 *AmlNameString;
> + UINT32 AmlNameStringSize;
> +
> + if ((NameString == NULL) ||
> + ((ParentNode == NULL) && (NewObjectNode == NULL)))
> + {
> + ASSERT (0);
> + return EFI_INVALID_PARAMETER;
> + }
> +
> + ObjectNode = NULL;
> + DataNode = NULL;
> + AmlNameString = NULL;
> +
> + Status = ConvertAslNameToAmlName (NameString, &AmlNameString);
> + if (EFI_ERROR (Status)) {
> + ASSERT (0);
> + return Status;
> + }
> +
> + Status = AmlGetNameStringSize (AmlNameString, &AmlNameStringSize);
> + if (EFI_ERROR (Status)) {
> + ASSERT (0);
> + goto error_handler1;
> + }
> +
> + Status = AmlCreateObjectNode (
> + AmlGetByteEncodingByOpCode (AML_EXT_OP, AML_EXT_THERMAL_ZONE_OP),
> + AmlNameStringSize + AmlComputePkgLengthWidth (AmlNameStringSize),
> + &ObjectNode
> + );
> + if (EFI_ERROR (Status)) {
> + ASSERT (0);
> + goto error_handler1;
> + }
> +
> + Status = AmlCreateDataNode (
> + EAmlNodeDataTypeNameString,
> + (UINT8 *)AmlNameString,
> + AmlNameStringSize,
> + &DataNode
> + );
> + if (EFI_ERROR (Status)) {
> + ASSERT (0);
> + goto error_handler2;
> + }
> +
> + Status = AmlSetFixedArgument (
> + ObjectNode,
> + EAmlParseIndexTerm0,
> + (AML_NODE_HEADER *)DataNode
> + );
> + if (EFI_ERROR (Status)) {
> + ASSERT (0);
> + AmlDeleteTree ((AML_NODE_HEADER *)DataNode);
> + goto error_handler2;
> + }
> +
> + Status = LinkNode (
> + ObjectNode,
> + ParentNode,
> + NewObjectNode
> + );
> + if (EFI_ERROR (Status)) {
> + ASSERT (0);
> + goto error_handler2;
> + }
> +
> + // Free AmlNameString before returning as it is copied
> + // in the call to AmlCreateDataNode().
> + goto error_handler1;
> +
> +error_handler2:
> + if (ObjectNode != NULL) {
> + AmlDeleteTree ((AML_NODE_HEADER *)ObjectNode);
> + }
> +
> +error_handler1:
> + if (AmlNameString != NULL) {
> + FreePool (AmlNameString);
> + }
> +
> + return Status;
> +}
> +
> /** AML code generation for a Scope object node.
>
> AmlCodeGenScope ("_SB", ParentNode, NewObjectNode) is
^ permalink raw reply [flat|nested] 10+ messages in thread
* [PATCH 2/4] DynamicTablesPkg: Add support for simple method invocation.
2023-06-29 23:01 [PATCH 0/4] Add support for generating ACPI ThermalZones Jeff Brasen
2023-06-29 23:01 ` [PATCH 1/4] DynamicTablesPkg: Add ThermalZone CodeGen function Jeff Brasen
@ 2023-06-29 23:01 ` Jeff Brasen
2023-07-03 9:42 ` PierreGondois
2023-06-29 23:01 ` [PATCH 3/4] DynamicTablesPkg: Add support to add Strings to package Jeff Brasen
2023-06-29 23:01 ` [PATCH 4/4] DynamicTablesPkg: Add Aml NameUnicodeString API Jeff Brasen
3 siblings, 1 reply; 10+ messages in thread
From: Jeff Brasen @ 2023-06-29 23:01 UTC (permalink / raw)
To: devel
Cc: Sami.Mujawar, Alexei.Fedorov, pierre.gondois, Jeff Brasen,
Swatisri Kantamsetti, Ashish Singhal
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>
Reviewed-by: Swatisri Kantamsetti <swatisrik@nvidia.com>
Reviewed-by: Ashish Singhal <ashishsingha@nvidia.com>
---
.../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 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..2b95839e4c 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] 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;
+
+ 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);
+ return Status;
+ }
+
+ // AmlCodeGenReturn() deletes DataNode if error.
+ Status = AmlCodeGenReturn (
+ (AML_NODE_HEADER *)DataNode,
+ ParentNode,
+ &ObjectNode
+ );
+ ASSERT_EFI_ERROR (Status);
+
+ Status = AmlVarListAddTail (
+ (AML_NODE_HANDLE)ObjectNode,
+ (AML_NODE_HANDLE)IntNode
+ );
+ if (EFI_ERROR (Status)) {
+ ASSERT (0);
+ return Status;
+ }
+
+ if (NewObjectNode != 0) {
+ *NewObjectNode = ObjectNode;
+ }
+
+exit_handler:
+ if (AmlNameString != NULL) {
+ FreePool (AmlNameString);
+ }
+
+ return Status;
+}
+
/** AML code generation for a method returning a NameString.
AmlCodeGenMethodRetNameString (
@@ -1989,6 +2101,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 (
--
2.25.1
^ permalink raw reply related [flat|nested] 10+ messages in thread* Re: [PATCH 2/4] DynamicTablesPkg: Add support for simple method invocation.
2023-06-29 23:01 ` [PATCH 2/4] DynamicTablesPkg: Add support for simple method invocation Jeff Brasen
@ 2023-07-03 9:42 ` PierreGondois
0 siblings, 0 replies; 10+ messages in thread
From: PierreGondois @ 2023-07-03 9:42 UTC (permalink / raw)
To: Jeff Brasen, devel
Cc: Sami.Mujawar, Alexei.Fedorov, Swatisri Kantamsetti,
Ashish Singhal
Hello Jeff,
On 6/30/23 01:01, 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>
> Reviewed-by: Swatisri Kantamsetti <swatisrik@nvidia.com>
> Reviewed-by: Ashish Singhal <ashishsingha@nvidia.com>
> ---
> .../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 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..2b95839e4c 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] 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;
> +
> + 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);
I think AmlNameString still need to be freed, so it should be
+ goto exit_handler;
> + return Status;
> + }
> +
> + // AmlCodeGenReturn() deletes DataNode if error.
> + Status = AmlCodeGenReturn (
> + (AML_NODE_HEADER *)DataNode,
> + ParentNode,
> + &ObjectNode
> + );
> + ASSERT_EFI_ERROR (Status);
> +
> + Status = AmlVarListAddTail (
> + (AML_NODE_HANDLE)ObjectNode,
> + (AML_NODE_HANDLE)IntNode
> + );
> + if (EFI_ERROR (Status)) {
> + ASSERT (0);
similar remark here
> + return Status;
> + }
> +
> + if (NewObjectNode != 0) {
> + *NewObjectNode = ObjectNode;
> + }
> +
> +exit_handler:
> + if (AmlNameString != NULL) {
> + FreePool (AmlNameString);
> + }
> +
> + return Status;
> +}
> +
<snip>
^ permalink raw reply [flat|nested] 10+ messages in thread
* [PATCH 3/4] DynamicTablesPkg: Add support to add Strings to package
2023-06-29 23:01 [PATCH 0/4] Add support for generating ACPI ThermalZones Jeff Brasen
2023-06-29 23:01 ` [PATCH 1/4] DynamicTablesPkg: Add ThermalZone CodeGen function Jeff Brasen
2023-06-29 23:01 ` [PATCH 2/4] DynamicTablesPkg: Add support for simple method invocation Jeff Brasen
@ 2023-06-29 23:01 ` Jeff Brasen
2023-07-03 9:42 ` PierreGondois
2023-06-29 23:01 ` [PATCH 4/4] DynamicTablesPkg: Add Aml NameUnicodeString API Jeff Brasen
3 siblings, 1 reply; 10+ messages in thread
From: Jeff Brasen @ 2023-06-29 23:01 UTC (permalink / raw)
To: devel
Cc: Sami.Mujawar, Alexei.Fedorov, pierre.gondois, Jeff Brasen,
Swatisri Kantamsetti, Ashish Singhal
Add API to add a String to a package created with NamedPackage API.
Signed-off-by: Jeff Brasen <jbrasen@nvidia.com>
Reviewed-by: Swatisri Kantamsetti <swatisrik@nvidia.com>
Reviewed-by: Ashish Singhal <ashishsingha@nvidia.com>
---
.../Include/Library/AmlLib/AmlLib.h | 17 ++++
.../Common/AmlLib/CodeGen/AmlCodeGen.c | 82 +++++++++++++++++++
2 files changed, 99 insertions(+)
diff --git a/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h b/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
index b82c7a3ce8..043e7ee901 100644
--- a/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
+++ b/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
@@ -1472,4 +1472,21 @@ AmlCreateCpcNode (
OUT AML_OBJECT_NODE_HANDLE *NewCpcNode OPTIONAL
);
+/** AML code generation to add a string to the package in a named node.
+
+
+ @param [in] String String to add
+ @param [in] NamedNode Node to add the string to the included package.
+
+ @retval EFI_SUCCESS Success.
+ @retval EFI_INVALID_PARAMETER Invalid parameter.
+ @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
+**/
+EFI_STATUS
+EFIAPI
+AmlAddStringToNamedPackage (
+ IN CHAR8 *String,
+ IN AML_OBJECT_NODE_HANDLE NamedNode
+ );
+
#endif // AML_LIB_H_
diff --git a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
index 2b95839e4c..a0d01032d5 100644
--- a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
+++ b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
@@ -3665,3 +3665,85 @@ error_handler:
AmlDeleteTree ((AML_NODE_HANDLE)CpcNode);
return Status;
}
+
+/** AML code generation to add a string to the package in a named node.
+
+
+ @param [in] Name String to add
+ @param [in] NamedNode Node to add the string to the included package.
+
+ @retval EFI_SUCCESS Success.
+ @retval EFI_INVALID_PARAMETER Invalid parameter.
+ @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
+**/
+EFI_STATUS
+EFIAPI
+AmlAddStringToNamedPackage (
+ IN CHAR8 *String,
+ IN AML_OBJECT_NODE_HANDLE NamedNode
+ )
+{
+ EFI_STATUS Status;
+ AML_DATA_NODE *DataNode;
+ CHAR8 *AmlNameString;
+ UINT32 AmlNameStringSize;
+ AML_OBJECT_NODE_HANDLE PackageNode;
+
+ DataNode = NULL;
+
+ if ((NamedNode == NULL) ||
+ (AmlGetNodeType ((AML_NODE_HANDLE)NamedNode) != EAmlNodeObject) ||
+ (!AmlNodeHasOpCode (NamedNode, AML_NAME_OP, 0)))
+ {
+ ASSERT (0);
+ return EFI_INVALID_PARAMETER;
+ }
+
+ PackageNode = (AML_OBJECT_NODE_HANDLE)AmlGetFixedArgument (
+ NamedNode,
+ EAmlParseIndexTerm1
+ );
+ if ((PackageNode == NULL) ||
+ (AmlGetNodeType ((AML_NODE_HANDLE)PackageNode) != EAmlNodeObject) ||
+ (!AmlNodeHasOpCode (PackageNode, AML_PACKAGE_OP, 0)))
+ {
+ ASSERT (0);
+ return EFI_INVALID_PARAMETER;
+ }
+
+ Status = ConvertAslNameToAmlName (String, &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 = AmlVarListAddTail (
+ (AML_NODE_HANDLE)PackageNode,
+ (AML_NODE_HANDLE)DataNode
+ );
+ ASSERT_EFI_ERROR (Status);
+
+exit_handler:
+ if (AmlNameString != NULL) {
+ FreePool (AmlNameString);
+ }
+
+ return Status;
+}
--
2.25.1
^ permalink raw reply related [flat|nested] 10+ messages in thread* Re: [PATCH 3/4] DynamicTablesPkg: Add support to add Strings to package
2023-06-29 23:01 ` [PATCH 3/4] DynamicTablesPkg: Add support to add Strings to package Jeff Brasen
@ 2023-07-03 9:42 ` PierreGondois
0 siblings, 0 replies; 10+ messages in thread
From: PierreGondois @ 2023-07-03 9:42 UTC (permalink / raw)
To: Jeff Brasen, devel
Cc: Sami.Mujawar, Alexei.Fedorov, Swatisri Kantamsetti,
Ashish Singhal
Hello Jeff,
On 6/30/23 01:01, Jeff Brasen wrote:
> Add API to add a String to a package created with NamedPackage API.
>
> Signed-off-by: Jeff Brasen <jbrasen@nvidia.com>
> Reviewed-by: Swatisri Kantamsetti <swatisrik@nvidia.com>
> Reviewed-by: Ashish Singhal <ashishsingha@nvidia.com>
> ---
> .../Include/Library/AmlLib/AmlLib.h | 17 ++++
> .../Common/AmlLib/CodeGen/AmlCodeGen.c | 82 +++++++++++++++++++
> 2 files changed, 99 insertions(+)
>
> diff --git a/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h b/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
> index b82c7a3ce8..043e7ee901 100644
> --- a/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
> +++ b/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
> @@ -1472,4 +1472,21 @@ AmlCreateCpcNode (
> OUT AML_OBJECT_NODE_HANDLE *NewCpcNode OPTIONAL
> );
>
> +/** AML code generation to add a string to the package in a named node.
> +
> +
> + @param [in] String String to add
> + @param [in] NamedNode Node to add the string to the included package.
> +
> + @retval EFI_SUCCESS Success.
> + @retval EFI_INVALID_PARAMETER Invalid parameter.
> + @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
> +**/
> +EFI_STATUS
> +EFIAPI
> +AmlAddStringToNamedPackage (
> + IN CHAR8 *String,
> + IN AML_OBJECT_NODE_HANDLE NamedNode
> + );
> +
> #endif // AML_LIB_H_
> diff --git a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
> index 2b95839e4c..a0d01032d5 100644
> --- a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
> +++ b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
> @@ -3665,3 +3665,85 @@ error_handler:
> AmlDeleteTree ((AML_NODE_HANDLE)CpcNode);
> return Status;
> }
> +
> +/** AML code generation to add a string to the package in a named node.
> +
> +
> + @param [in] Name String to add
> + @param [in] NamedNode Node to add the string to the included package.
> +
> + @retval EFI_SUCCESS Success.
> + @retval EFI_INVALID_PARAMETER Invalid parameter.
> + @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
> +**/
> +EFI_STATUS
> +EFIAPI
> +AmlAddStringToNamedPackage (
> + IN CHAR8 *String,
> + IN AML_OBJECT_NODE_HANDLE NamedNode
> + )
> +{
> + EFI_STATUS Status;
> + AML_DATA_NODE *DataNode;
> + CHAR8 *AmlNameString;
> + UINT32 AmlNameStringSize;
> + AML_OBJECT_NODE_HANDLE PackageNode;
> +
> + DataNode = NULL;
> +
> + if ((NamedNode == NULL) ||
> + (AmlGetNodeType ((AML_NODE_HANDLE)NamedNode) != EAmlNodeObject) ||
> + (!AmlNodeHasOpCode (NamedNode, AML_NAME_OP, 0)))
> + {
> + ASSERT (0);
> + return EFI_INVALID_PARAMETER;
> + }
> +
> + PackageNode = (AML_OBJECT_NODE_HANDLE)AmlGetFixedArgument (
> + NamedNode,
> + EAmlParseIndexTerm1
> + );
> + if ((PackageNode == NULL) ||
> + (AmlGetNodeType ((AML_NODE_HANDLE)PackageNode) != EAmlNodeObject) ||
> + (!AmlNodeHasOpCode (PackageNode, AML_PACKAGE_OP, 0)))
> + {
> + ASSERT (0);
> + return EFI_INVALID_PARAMETER;
> + }
> +
> + Status = ConvertAslNameToAmlName (String, &AmlNameString);
> + if (EFI_ERROR (Status)) {
> + ASSERT (0);
> + return Status;
> + }
IIUC, the function adds a NameString to the package,
is it possible to rename the funciton to:
AmlAddNameStringToNamedPackage ()
^ permalink raw reply [flat|nested] 10+ messages in thread
* [PATCH 4/4] DynamicTablesPkg: Add Aml NameUnicodeString API
2023-06-29 23:01 [PATCH 0/4] Add support for generating ACPI ThermalZones Jeff Brasen
` (2 preceding siblings ...)
2023-06-29 23:01 ` [PATCH 3/4] DynamicTablesPkg: Add support to add Strings to package Jeff Brasen
@ 2023-06-29 23:01 ` Jeff Brasen
2023-07-03 9:42 ` PierreGondois
2023-07-03 12:27 ` PierreGondois
3 siblings, 2 replies; 10+ messages in thread
From: Jeff Brasen @ 2023-06-29 23:01 UTC (permalink / raw)
To: devel
Cc: Sami.Mujawar, Alexei.Fedorov, pierre.gondois, Jeff Brasen,
Swatisri Kantamsetti, Ashish Singhal
Add API to generate a Name that contains a Unicode string buffer.
Change-Id: I0116b2921cbbbecc3420ff7a42a7ab6e01852534
Reviewed-by: Swatisri Kantamsetti <swatisrik@nvidia.com>
Reviewed-by: Ashish Singhal <ashishsingha@nvidia.com>
---
.../Include/Library/AmlLib/AmlLib.h | 31 +++++++
.../Common/AmlLib/CodeGen/AmlCodeGen.c | 86 +++++++++++++++++++
2 files changed, 117 insertions(+)
diff --git a/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h b/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
index 043e7ee901..5150aa4870 100644
--- a/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
+++ b/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
@@ -958,6 +958,37 @@ AmlCodeGenNameResourceTemplate (
OUT AML_OBJECT_NODE_HANDLE *NewObjectNode OPTIONAL
);
+/** AML code generation for a Name object node, containing a String.
+
+ AmlCodeGenNameUnicodeString ("_STR", L"String", ParentNode, NewObjectNode) is
+ equivalent of the following ASL code:
+ Name(_STR, Unicode ("String"))
+
+ @ingroup CodeGenApis
+
+ @param [in] NameString The new variable name.
+ Must be a NULL-terminated ASL NameString
+ e.g.: "DEV0", "DV15.DEV0", etc.
+ The input string is copied.
+ @param [in] String NULL terminated Unicode String to associate 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
+AmlCodeGenNameUnicodeString (
+ IN CONST CHAR8 *NameString,
+ IN CHAR16 *String,
+ IN AML_NODE_HANDLE ParentNode OPTIONAL,
+ OUT AML_OBJECT_NODE_HANDLE *NewObjectNode OPTIONAL
+ );
+
/** Add a _PRT entry.
AmlCodeGenPrtEntry (0x0FFFF, 0, "LNKA", 0, PrtNameNode) is
diff --git a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
index a0d01032d5..20ddad031d 100644
--- a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
+++ b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
@@ -869,6 +869,92 @@ AmlCodeGenNameResourceTemplate (
return Status;
}
+/** AML code generation for a Name object node, containing a String.
+
+ AmlCodeGenNameUnicodeString ("_STR", L"String", ParentNode, NewObjectNode) is
+ equivalent of the following ASL code:
+ Name(_STR, Unicode ("String"))
+
+ @ingroup CodeGenApis
+
+ @param [in] NameString The new variable name.
+ Must be a NULL-terminated ASL NameString
+ e.g.: "DEV0", "DV15.DEV0", etc.
+ The input string is copied.
+ @param [in] String NULL terminated Unicode String to associate 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
+AmlCodeGenNameUnicodeString (
+ IN CONST CHAR8 *NameString,
+ IN CHAR16 *String,
+ IN AML_NODE_HANDLE ParentNode OPTIONAL,
+ OUT AML_OBJECT_NODE_HANDLE *NewObjectNode OPTIONAL
+ )
+{
+ EFI_STATUS Status;
+ AML_OBJECT_NODE *ObjectNode;
+ AML_DATA_NODE *DataNode;
+
+ if ((NameString == NULL) ||
+ (String == NULL) ||
+ ((ParentNode == NULL) && (NewObjectNode == NULL)))
+ {
+ ASSERT (0);
+ return EFI_INVALID_PARAMETER;
+ }
+
+ Status = AmlCodeGenBuffer (NULL, 0, &ObjectNode);
+ if (EFI_ERROR (Status)) {
+ ASSERT_EFI_ERROR (Status);
+ return Status;
+ }
+
+ Status = AmlCreateDataNode (
+ EAmlNodeDataTypeRaw,
+ (CONST UINT8 *)String,
+ StrSize (String),
+ &DataNode
+ );
+ if (EFI_ERROR (Status)) {
+ ASSERT_EFI_ERROR (Status);
+ AmlDeleteTree ((AML_NODE_HEADER *)ObjectNode);
+ return Status;
+ }
+
+ Status = AmlVarListAddTail (
+ (AML_NODE_HEADER *)ObjectNode,
+ (AML_NODE_HEADER *)DataNode
+ );
+ if (EFI_ERROR (Status)) {
+ ASSERT_EFI_ERROR (Status);
+ AmlDeleteTree ((AML_NODE_HEADER *)ObjectNode);
+ AmlDeleteTree ((AML_NODE_HANDLE)DataNode);
+ return Status;
+ }
+
+ Status = AmlCodeGenName (
+ NameString,
+ ObjectNode,
+ ParentNode,
+ NewObjectNode
+ );
+ if (EFI_ERROR (Status)) {
+ ASSERT (0);
+ AmlDeleteTree ((AML_NODE_HEADER *)ObjectNode);
+ }
+
+ return Status;
+}
+
/** Add a _PRT entry.
AmlCodeGenPrtEntry (0x0FFFF, 0, "LNKA", 0, PrtNameNode) is
--
2.25.1
^ permalink raw reply related [flat|nested] 10+ messages in thread* Re: [PATCH 4/4] DynamicTablesPkg: Add Aml NameUnicodeString API
2023-06-29 23:01 ` [PATCH 4/4] DynamicTablesPkg: Add Aml NameUnicodeString API Jeff Brasen
@ 2023-07-03 9:42 ` PierreGondois
2023-07-03 12:27 ` PierreGondois
1 sibling, 0 replies; 10+ messages in thread
From: PierreGondois @ 2023-07-03 9:42 UTC (permalink / raw)
To: Jeff Brasen, devel
Cc: Sami.Mujawar, Alexei.Fedorov, Swatisri Kantamsetti,
Ashish Singhal
Hello Jeff,
Reviewed-by: Pierre Gondois <pierre.gondois@arm.com>
On 6/30/23 01:01, Jeff Brasen wrote:
> Add API to generate a Name that contains a Unicode string buffer.
>
> Change-Id: I0116b2921cbbbecc3420ff7a42a7ab6e01852534
> Reviewed-by: Swatisri Kantamsetti <swatisrik@nvidia.com>
> Reviewed-by: Ashish Singhal <ashishsingha@nvidia.com>
> ---
> .../Include/Library/AmlLib/AmlLib.h | 31 +++++++
> .../Common/AmlLib/CodeGen/AmlCodeGen.c | 86 +++++++++++++++++++
> 2 files changed, 117 insertions(+)
>
> diff --git a/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h b/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
> index 043e7ee901..5150aa4870 100644
> --- a/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
> +++ b/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
> @@ -958,6 +958,37 @@ AmlCodeGenNameResourceTemplate (
> OUT AML_OBJECT_NODE_HANDLE *NewObjectNode OPTIONAL
> );
>
> +/** AML code generation for a Name object node, containing a String.
> +
> + AmlCodeGenNameUnicodeString ("_STR", L"String", ParentNode, NewObjectNode) is
> + equivalent of the following ASL code:
> + Name(_STR, Unicode ("String"))
> +
> + @ingroup CodeGenApis
> +
> + @param [in] NameString The new variable name.
> + Must be a NULL-terminated ASL NameString
> + e.g.: "DEV0", "DV15.DEV0", etc.
> + The input string is copied.
> + @param [in] String NULL terminated Unicode String to associate 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
> +AmlCodeGenNameUnicodeString (
> + IN CONST CHAR8 *NameString,
> + IN CHAR16 *String,
> + IN AML_NODE_HANDLE ParentNode OPTIONAL,
> + OUT AML_OBJECT_NODE_HANDLE *NewObjectNode OPTIONAL
> + );
> +
> /** Add a _PRT entry.
>
> AmlCodeGenPrtEntry (0x0FFFF, 0, "LNKA", 0, PrtNameNode) is
> diff --git a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
> index a0d01032d5..20ddad031d 100644
> --- a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
> +++ b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
> @@ -869,6 +869,92 @@ AmlCodeGenNameResourceTemplate (
> return Status;
> }
>
> +/** AML code generation for a Name object node, containing a String.
> +
> + AmlCodeGenNameUnicodeString ("_STR", L"String", ParentNode, NewObjectNode) is
> + equivalent of the following ASL code:
> + Name(_STR, Unicode ("String"))
> +
> + @ingroup CodeGenApis
> +
> + @param [in] NameString The new variable name.
> + Must be a NULL-terminated ASL NameString
> + e.g.: "DEV0", "DV15.DEV0", etc.
> + The input string is copied.
> + @param [in] String NULL terminated Unicode String to associate 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
> +AmlCodeGenNameUnicodeString (
> + IN CONST CHAR8 *NameString,
> + IN CHAR16 *String,
> + IN AML_NODE_HANDLE ParentNode OPTIONAL,
> + OUT AML_OBJECT_NODE_HANDLE *NewObjectNode OPTIONAL
> + )
> +{
> + EFI_STATUS Status;
> + AML_OBJECT_NODE *ObjectNode;
> + AML_DATA_NODE *DataNode;
> +
> + if ((NameString == NULL) ||
> + (String == NULL) ||
> + ((ParentNode == NULL) && (NewObjectNode == NULL)))
> + {
> + ASSERT (0);
> + return EFI_INVALID_PARAMETER;
> + }
> +
> + Status = AmlCodeGenBuffer (NULL, 0, &ObjectNode);
> + if (EFI_ERROR (Status)) {
> + ASSERT_EFI_ERROR (Status);
> + return Status;
> + }
> +
> + Status = AmlCreateDataNode (
> + EAmlNodeDataTypeRaw,
> + (CONST UINT8 *)String,
> + StrSize (String),
> + &DataNode
> + );
> + if (EFI_ERROR (Status)) {
> + ASSERT_EFI_ERROR (Status);
> + AmlDeleteTree ((AML_NODE_HEADER *)ObjectNode);
> + return Status;
> + }
> +
> + Status = AmlVarListAddTail (
> + (AML_NODE_HEADER *)ObjectNode,
> + (AML_NODE_HEADER *)DataNode
> + );
> + if (EFI_ERROR (Status)) {
> + ASSERT_EFI_ERROR (Status);
> + AmlDeleteTree ((AML_NODE_HEADER *)ObjectNode);
> + AmlDeleteTree ((AML_NODE_HANDLE)DataNode);
> + return Status;
> + }
> +
> + Status = AmlCodeGenName (
> + NameString,
> + ObjectNode,
> + ParentNode,
> + NewObjectNode
> + );
> + if (EFI_ERROR (Status)) {
> + ASSERT (0);
> + AmlDeleteTree ((AML_NODE_HEADER *)ObjectNode);
> + }
> +
> + return Status;
> +}
> +
> /** Add a _PRT entry.
>
> AmlCodeGenPrtEntry (0x0FFFF, 0, "LNKA", 0, PrtNameNode) is
^ permalink raw reply [flat|nested] 10+ messages in thread* Re: [PATCH 4/4] DynamicTablesPkg: Add Aml NameUnicodeString API
2023-06-29 23:01 ` [PATCH 4/4] DynamicTablesPkg: Add Aml NameUnicodeString API Jeff Brasen
2023-07-03 9:42 ` PierreGondois
@ 2023-07-03 12:27 ` PierreGondois
1 sibling, 0 replies; 10+ messages in thread
From: PierreGondois @ 2023-07-03 12:27 UTC (permalink / raw)
To: Jeff Brasen, devel
Cc: Sami.Mujawar, Alexei.Fedorov, Swatisri Kantamsetti,
Ashish Singhal
On 6/30/23 01:01, Jeff Brasen wrote:
> Add API to generate a Name that contains a Unicode string buffer.
>
> Change-Id: I0116b2921cbbbecc3420ff7a42a7ab6e01852534
> Reviewed-by: Swatisri Kantamsetti <swatisrik@nvidia.com>
> Reviewed-by: Ashish Singhal <ashishsingha@nvidia.com>
Also I forgot: the 'Change-Id' should be removed,
Regards,
Pierre
^ permalink raw reply [flat|nested] 10+ messages in thread