Re: [PATCH v1 3/7] DynamicTablesPkg: AML Code generation to create a named ResourceTemplate()

["Sami Mujawar" <sami.mujawar@arm.com>]

Hi Pierre,

This patch looks good to me.

Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>

Regards,

Sami Mujawar


On 23/06/2021 12:58 PM, Pierre.Gondois@arm.com wrote:
> From: Pierre Gondois <Pierre.Gondois@arm.com>
>
> Add AmlCodeGenNameResourceTemplate() to generate code for a
> ResourceTemplate().
>
> AmlCodeGenNameResourceTemplate ("REST", ParentNode, NewObjectNode) is
> equivalent of the following ASL code:
>    Name(REST, ResourceTemplate () {})
>
> Signed-off-by: Pierre Gondois <Pierre.Gondois@arm.com>
> ---
>   .../Include/Library/AmlLib/AmlLib.h           | 28 ++++++++++
>   .../Common/AmlLib/CodeGen/AmlCodeGen.c        | 55 +++++++++++++++++++
>   2 files changed, 83 insertions(+)
>
> diff --git a/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h b/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
> index 412db886e1f2..544bc670c455 100644
> --- a/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
> +++ b/DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
> @@ -880,6 +880,34 @@ AmlCodeGenNamePackage (
>     OUT       AML_OBJECT_NODE_HANDLE  * NewObjectNode   OPTIONAL
>     );
>   
> +/** AML code generation for a Name object node, containing a ResourceTemplate.
> +
> +  AmlCodeGenNameResourceTemplate ("PRS0", ParentNode, NewObjectNode) is
> +  equivalent of the following ASL code:
> +    Name(PRS0, ResourceTemplate () {})
> +
> +  @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]  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
> +AmlCodeGenNameResourceTemplate (
> +  IN  CONST CHAR8                   * NameString,
> +  IN        AML_NODE_HANDLE           ParentNode,     OPTIONAL
> +  OUT       AML_OBJECT_NODE_HANDLE  * NewObjectNode   OPTIONAL
> +  );
> +
>   /** AML code generation for a Device object node.
>   
>     AmlCodeGenDevice ("COM0", ParentNode, NewObjectNode) is
> diff --git a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
> index f9175c623622..eaa49a5834c2 100644
> --- a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
> +++ b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
> @@ -802,6 +802,61 @@ AmlCodeGenNamePackage (
>     return Status;
>   }
>   
> +/** AML code generation for a Name object node, containing a ResourceTemplate.
> +
> +  AmlCodeGenNameResourceTemplate ("PRS0", ParentNode, NewObjectNode) is
> +  equivalent of the following ASL code:
> +    Name(PRS0, ResourceTemplate () {})
> +
> +  @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]  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
> +AmlCodeGenNameResourceTemplate (
> +  IN  CONST CHAR8              * NameString,
> +  IN        AML_NODE_HEADER    * ParentNode,     OPTIONAL
> +  OUT       AML_OBJECT_NODE   ** NewObjectNode   OPTIONAL
> +  )
> +{
> +  EFI_STATUS          Status;
> +  AML_OBJECT_NODE   * ResourceTemplateNode;
> +
> +  if ((NameString == NULL)  ||
> +      ((ParentNode == NULL) && (NewObjectNode == NULL))) {
> +    ASSERT (0);
> +    return EFI_INVALID_PARAMETER;
> +  }
> +
> +  Status = AmlCodeGenResourceTemplate (&ResourceTemplateNode);
> +  if (EFI_ERROR (Status)) {
> +    ASSERT (0);
> +    return Status;
> +  }
> +
> +  Status = AmlCodeGenName (
> +             NameString,
> +             ResourceTemplateNode,
> +             ParentNode,
> +             NewObjectNode
> +             );
> +  if (EFI_ERROR (Status)) {
> +    ASSERT (0);
> +    AmlDeleteTree ((AML_NODE_HEADER*)ResourceTemplateNode);
> +  }
> +
> +  return Status;
> +}
> +
>   /** AML code generation for a Device object node.
>   
>     AmlCodeGenDevice ("COM0", ParentNode, NewObjectNode) is