From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by mx.groups.io with SMTP id smtpd.web10.23602.1688377382617157416 for ; Mon, 03 Jul 2023 02:43:02 -0700 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: arm.com, ip: 217.140.110.172, mailfrom: pierre.gondois@arm.com) Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id 434281FB; Mon, 3 Jul 2023 02:43:44 -0700 (PDT) Received: from [10.34.100.101] (e126645.nice.arm.com [10.34.100.101]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPSA id AF13C3F762; Mon, 3 Jul 2023 02:43:00 -0700 (PDT) Message-ID: Date: Mon, 3 Jul 2023 11:42:56 +0200 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101 Thunderbird/102.11.0 From: "PierreGondois" Subject: Re: [PATCH 4/4] DynamicTablesPkg: Add Aml NameUnicodeString API To: Jeff Brasen , devel@edk2.groups.io Cc: Sami.Mujawar@arm.com, Alexei.Fedorov@arm.com, Swatisri Kantamsetti , Ashish Singhal References: In-Reply-To: Content-Language: en-US Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit Hello Jeff, Reviewed-by: Pierre Gondois 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 > Reviewed-by: Ashish Singhal > --- > .../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