Re: [PATCH 1/4] DynamicTablesPkg: Add ThermalZone CodeGen function

["PierreGondois" <pierre.gondois@arm.com>]

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