From: "PierreGondois" <pierre.gondois@arm.com>
To: devel@edk2.groups.io, Sami Mujawar <sami.mujawar@arm.com>,
Alexei.Fedorov@arm.com
Subject: [PATCH v2 05/21] DynamicTablesPkg: Add AmlSetRdListCheckSum()
Date: Thu, 7 Oct 2021 16:31:54 +0100 [thread overview]
Message-ID: <20211007153210.26608-6-Pierre.Gondois@arm.com> (raw)
In-Reply-To: <20211007153210.26608-1-Pierre.Gondois@arm.com>
From: Pierre Gondois <Pierre.Gondois@arm.com>
Lists of Resource Data elements end with an EndTag (most of the time).
This function finds the EndTag (if present) in a list of Resource Data
elements and sets the checksum.
ACPI 6.4, s6.4.2.9 "End Tag":
"This checksum is generated such that adding it to the sum of all the data
bytes will produce a zero sum."
"If the checksum field is zero, the resource data is treated as if the
checksum operation succeeded. Configuration proceeds normally."
Signed-off-by: Pierre Gondois <Pierre.Gondois@arm.com>
---
.../Library/Common/AmlLib/Utils/AmlUtility.c | 76 +++++++++++++++++++
.../Library/Common/AmlLib/Utils/AmlUtility.h | 32 ++++++++
2 files changed, 108 insertions(+)
diff --git a/DynamicTablesPkg/Library/Common/AmlLib/Utils/AmlUtility.c b/DynamicTablesPkg/Library/Common/AmlLib/Utils/AmlUtility.c
index 7ebd08f945c0..ef159e3b831e 100644
--- a/DynamicTablesPkg/Library/Common/AmlLib/Utils/AmlUtility.c
+++ b/DynamicTablesPkg/Library/Common/AmlLib/Utils/AmlUtility.c
@@ -904,3 +904,79 @@ AmlPropagateInformation (
return EFI_SUCCESS;
}
+
+/** Find and set the EndTag's Checksum of a list of Resource Data elements.
+
+ Lists of Resource Data elements end with an EndTag (most of the time). This
+ function finds the EndTag (if present) in a list of Resource Data elements
+ and sets the checksum.
+
+ ACPI 6.4, s6.4.2.9 "End Tag":
+ "This checksum is generated such that adding it to the sum of all the data
+ bytes will produce a zero sum."
+ "If the checksum field is zero, the resource data is treated as if the
+ checksum operation succeeded. Configuration proceeds normally."
+
+ To avoid re-computing checksums, if a new resource data elements is
+ added/removed/modified in a list of resource data elements, the AmlLib
+ resets the checksum to 0.
+
+ @param [in] BufferOpNode Node having a list of Resource Data elements.
+ @param [in] CheckSum CheckSum to store in the EndTag.
+ To ignore/avoid computing the checksum,
+ give 0.
+
+ @retval EFI_SUCCESS The function completed successfully.
+ @retval EFI_INVALID_PARAMETER Invalid parameter.
+ @retval EFI_NOT_FOUND No EndTag found.
+**/
+EFI_STATUS
+EFIAPI
+AmlSetRdListCheckSum (
+ IN AML_OBJECT_NODE * BufferOpNode,
+ IN UINT8 CheckSum
+ )
+{
+ EFI_STATUS Status;
+ AML_DATA_NODE * LastRdNode;
+ AML_RD_HEADER RdDataType;
+
+ if (!AmlNodeCompareOpCode (BufferOpNode, AML_BUFFER_OP, 0)) {
+ ASSERT (0);
+ return EFI_INVALID_PARAMETER;
+ }
+
+ // Get the last Resource data node in the variable list of
+ // argument of the BufferOp node.
+ LastRdNode = (AML_DATA_NODE*)AmlGetPreviousVariableArgument (
+ (AML_NODE_HEADER*)BufferOpNode,
+ NULL
+ );
+ if ((LastRdNode == NULL) ||
+ !IS_AML_DATA_NODE (LastRdNode) ||
+ (LastRdNode->DataType != EAmlNodeDataTypeResourceData)) {
+ ASSERT (0);
+ return EFI_INVALID_PARAMETER;
+ }
+
+ Status = AmlGetResourceDataType (LastRdNode, &RdDataType);
+ if (EFI_ERROR (Status)) {
+ ASSERT (0);
+ return Status;
+ }
+
+ // Check the LastRdNode is an EndTag.
+ // It is possible to have only one Resource Data in a BufferOp with
+ // no EndTag. Return EFI_NOT_FOUND is such case.
+ if (!AmlRdCompareDescId (
+ &RdDataType,
+ AML_RD_BUILD_SMALL_DESC_ID (ACPI_SMALL_END_TAG_DESCRIPTOR_NAME))) {
+ ASSERT (0);
+ return EFI_NOT_FOUND;
+ }
+
+ Status = AmlRdSetEndTagChecksum (LastRdNode->Buffer, CheckSum);
+ ASSERT_EFI_ERROR (Status);
+
+ return Status;
+}
diff --git a/DynamicTablesPkg/Library/Common/AmlLib/Utils/AmlUtility.h b/DynamicTablesPkg/Library/Common/AmlLib/Utils/AmlUtility.h
index c57d780140d4..4667f57d7f08 100644
--- a/DynamicTablesPkg/Library/Common/AmlLib/Utils/AmlUtility.h
+++ b/DynamicTablesPkg/Library/Common/AmlLib/Utils/AmlUtility.h
@@ -91,5 +91,37 @@ AmlPropagateInformation (
IN UINT8 NodeCount
);
+/** Find and set the EndTag's Checksum of a list of Resource Data elements.
+
+ Lists of Resource Data elements end with an EndTag (most of the time). This
+ function finds the EndTag (if present) in a list of Resource Data elements
+ and sets the checksum.
+
+ ACPI 6.4, s6.4.2.9 "End Tag":
+ "This checksum is generated such that adding it to the sum of all the data
+ bytes will produce a zero sum."
+ "If the checksum field is zero, the resource data is treated as if the
+ checksum operation succeeded. Configuration proceeds normally."
+
+ To avoid re-computing checksums, if a new resource data elements is
+ added/removed/modified in a list of resource data elements, the AmlLib
+ resets the checksum to 0.
+
+ @param [in] BufferOpNode Node having a list of Resource Data elements.
+ @param [in] CheckSum CheckSum to store in the EndTag.
+ To ignore/avoid computing the checksum,
+ give 0.
+
+ @retval EFI_SUCCESS The function completed successfully.
+ @retval EFI_INVALID_PARAMETER Invalid parameter.
+ @retval EFI_NOT_FOUND No EndTag found.
+**/
+EFI_STATUS
+EFIAPI
+AmlSetRdListCheckSum (
+ IN AML_OBJECT_NODE * BufferOpNode,
+ IN UINT8 CheckSum
+ );
+
#endif // AML_UTILITY_H_
--
2.17.1
next prev parent reply other threads:[~2021-10-07 15:32 UTC|newest]
Thread overview: 38+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-10-07 15:31 [PATCH v2 00/21] Create a SSDT CPU topology generator PierreGondois
2021-10-07 15:31 ` [PATCH v2 01/21] DynamicTablesPkg: Remove unnecessary includes PierreGondois
2021-10-08 14:06 ` Sami Mujawar
2021-10-07 15:31 ` [PATCH v2 02/21] DynamicTablesPkg: Add missing parameter check PierreGondois
2021-10-08 14:06 ` Sami Mujawar
2021-10-07 15:31 ` [PATCH v2 03/21] DynamicTablesPkg: Add AddSsdtAcpiHeader() PierreGondois
2021-10-08 14:06 ` Sami Mujawar
2021-10-07 15:31 ` [PATCH v2 04/21] DynamicTablesPkg: Add AmlRdSetEndTagChecksum() PierreGondois
2021-10-08 14:06 ` Sami Mujawar
2021-10-07 15:31 ` PierreGondois [this message]
2021-10-08 14:06 ` [PATCH v2 05/21] DynamicTablesPkg: Add AmlSetRdListCheckSum() Sami Mujawar
2021-10-07 15:31 ` [PATCH v2 06/21] DynamicTablesPkg: Set EndTag's Checksum if RdList is modified PierreGondois
2021-10-08 14:06 ` Sami Mujawar
2021-10-07 15:31 ` [PATCH v2 07/21] DynamicTablesPkg: Clear pointer in node creation fcts PierreGondois
2021-10-08 14:06 ` Sami Mujawar
2021-10-07 15:31 ` [PATCH v2 08/21] DynamicTablesPkg: Update error handling for node creation PierreGondois
2021-10-08 14:06 ` Sami Mujawar
2021-10-07 15:31 ` [PATCH v2 09/21] DynamicTablesPkg: Make AmlNodeGetIntegerValue public PierreGondois
2021-10-07 15:31 ` [PATCH v2 10/21] DynamicTablesPkg: AML Code generation for Register() PierreGondois
2021-10-07 15:32 ` [PATCH v2 11/21] DynamicTablesPkg: AML Code generation for Resource data EndTag PierreGondois
2021-10-08 14:07 ` Sami Mujawar
2021-10-07 15:32 ` [PATCH v2 12/21] DynamicTablesPkg: AML code generation for a Package PierreGondois
2021-10-08 14:06 ` Sami Mujawar
2021-10-07 15:32 ` [PATCH v2 13/21] DynamicTablesPkg: Helper function to compute package length PierreGondois
2021-10-07 15:32 ` [PATCH v2 14/21] DynamicTablesPkg: AML code generation for a ResourceTemplate PierreGondois
2021-10-08 14:07 ` Sami Mujawar
2021-10-07 15:32 ` [PATCH v2 15/21] DynamicTablesPkg: AML code generation for a Method PierreGondois
2021-10-08 14:07 ` Sami Mujawar
2021-10-07 15:32 ` [PATCH v2 16/21] DynamicTablesPkg: AML code generation to Return a NameString PierreGondois
2021-10-08 13:28 ` Sami Mujawar
2021-10-07 15:32 ` [PATCH v2 17/21] DynamicTablesPkg: AML code generation for a Method returning a NS PierreGondois
2021-10-08 14:17 ` Sami Mujawar
2021-10-07 15:32 ` [PATCH v2 18/21] DynamicTablesPkg: AML code generation for a _LPI object PierreGondois
2021-10-08 14:24 ` Sami Mujawar
2021-10-07 15:32 ` [PATCH v2 19/21] DynamicTablesPkg: AML code generation to add an _LPI state PierreGondois
2021-10-08 14:29 ` Sami Mujawar
2021-10-07 15:32 ` [PATCH v2 20/21] DynamicTablesPkg: Add CM_ARM_LPI_INFO object PierreGondois
2021-10-07 15:32 ` [PATCH v2 21/21] DynamicTablesPkg: SSDT CPU topology and LPI state generator PierreGondois
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=20211007153210.26608-6-Pierre.Gondois@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