#include <Utils/AmlUtility.h>
#include <AmlCoreInterface.h>
#include <Tree/AmlNode.h>
#include <Tree/AmlTree.h>

Functions
EFI_STATUS EFIAPI	AcpiPlatformChecksum (IN EFI_ACPI_DESCRIPTION_HEADER *AcpiTable)

STATIC BOOLEAN EFIAPI	AmlComputeSizeCallback (IN AML_NODE_HEADER Node, IN OUT VOID Context, IN OUT EFI_STATUS *Status OPTIONAL)

EFI_STATUS EFIAPI	AmlComputeSize (IN CONST AML_NODE_HEADER Node, IN OUT UINT32 Size)

EFI_STATUS EFIAPI	AmlNodeGetIntegerValue (IN AML_OBJECT_NODE Node, OUT UINT64 Value)

STATIC EFI_STATUS EFIAPI	AmlUnwindSpecialInteger (IN AML_OBJECT_NODE *Node)

EFI_STATUS EFIAPI	AmlNodeSetIntegerValue (IN AML_OBJECT_NODE Node, IN UINT64 NewValue, OUT INT8 ValueWidthDiff)

STATIC EFI_STATUS EFIAPI	AmlNodeUpdateIntegerValue (IN AML_OBJECT_NODE IntegerNode, IN BOOLEAN IsIncrement, IN UINT64 Diff, OUT INT8 ValueWidthDiff)

STATIC EFI_STATUS EFIAPI	AmlPropagateSize (IN AML_NODE_HEADER Node, IN BOOLEAN IsIncrement, IN UINT32 Diff)

STATIC EFI_STATUS EFIAPI	AmlPropagateNodeCount (IN AML_OBJECT_NODE ObjectNode, IN BOOLEAN IsIncrement, IN UINT8 NodeCount, OUT INT8 FieldWidthChange)

EFI_STATUS EFIAPI	AmlPropagateInformation (IN AML_NODE_HEADER *Node, IN BOOLEAN IsIncrement, IN UINT32 Diff, IN UINT8 NodeCount)

EFI_STATUS EFIAPI	AmlSetRdListCheckSum (IN AML_OBJECT_NODE *BufferOpNode, IN UINT8 CheckSum)

Detailed Description

AML Utility.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file AmlUtility.c.

Function Documentation

◆ AcpiPlatformChecksum()

EFI_STATUS EFIAPI AcpiPlatformChecksum ( IN EFI_ACPI_DESCRIPTION_HEADER * AcpiTable )

This function computes and updates the ACPI table checksum.

Parameters

[in] AcpiTable Pointer to an Acpi table.

Return values

EFI_SUCCESS	The function completed successfully.
EFI_INVALID_PARAMETER	Invalid parameter.

Definition at line 24 of file AmlUtility.c.

◆ AmlComputeSize()

EFI_STATUS EFIAPI AmlComputeSize	(	IN CONST AML_NODE_HEADER *	Node,
		IN OUT UINT32 *	Size
	)

Compute the size of a tree/sub-tree.

Parameters

[in]	Node	Node to compute the size.
[in,out]	Size	Pointer holding the computed size.

Return values

EFI_SUCCESS	The function completed successfully.
EFI_INVALID_PARAMETER	Invalid parameter.

Definition at line 169 of file AmlUtility.c.

◆ AmlComputeSizeCallback()

STATIC BOOLEAN EFIAPI AmlComputeSizeCallback	(	IN AML_NODE_HEADER *	Node,
		IN OUT VOID *	Context,
		IN OUT EFI_STATUS *Status	OPTIONAL
	)

A callback function that computes the size of a Node and adds it to the Size pointer stored in the Context. Calling this function on the root node will compute the total size of the AML bytestream.

Parameters

[in]	Node	Node to compute the size.
[in,out]	Context	Pointer holding the computed size. (UINT32 *) Context.
[in,out]	Status	Pointer holding: At entry, the Status returned by the last call to this exact function during the enumeration; At exit, he returned status of the call to this function. Optional, can be NULL.

Return values

TRUE	if the enumeration can continue or has finished without interruption.
FALSE	if the enumeration needs to stopped or has stopped.

Definition at line 78 of file AmlUtility.c.

◆ AmlNodeGetIntegerValue()

EFI_STATUS EFIAPI AmlNodeGetIntegerValue	(	IN AML_OBJECT_NODE *	Node,
		OUT UINT64 *	Value
	)

Get the value contained in an integer node.

Parameters

[in]	Node	Pointer to an integer node. Must be an object node.
[out]	Value	Value contained in the integer node.

Return values

EFI_SUCCESS	The function completed successfully.
EFI_INVALID_PARAMETER	Invalid parameter.

Definition at line 206 of file AmlUtility.c.

◆ AmlNodeSetIntegerValue()

EFI_STATUS EFIAPI AmlNodeSetIntegerValue	(	IN AML_OBJECT_NODE *	Node,
		IN UINT64	NewValue,
		OUT INT8 *	ValueWidthDiff
	)

Set the value contained in an integer node.

The OpCode is updated accordingly to the new value (e.g.: If the original value was a UINT8 value, then the OpCode would be AML_BYTE_PREFIX. If it the new value is a UINT16 value then the OpCode will be updated to AML_WORD_PREFIX).

Parameters

[in]	Node	Pointer to an integer node. Must be an object node.
[in]	NewValue	New value to write in the integer node.
[out]	ValueWidthDiff	Difference in number of bytes used to store the new value. Can be negative.

Return values

EFI_SUCCESS	The function completed successfully.
EFI_INVALID_PARAMETER	Invalid parameter.
EFI_OUT_OF_RESOURCES	Could not allocate memory.

Definition at line 374 of file AmlUtility.c.

◆ AmlNodeUpdateIntegerValue()

STATIC EFI_STATUS EFIAPI AmlNodeUpdateIntegerValue	(	IN AML_OBJECT_NODE *	IntegerNode,
		IN BOOLEAN	IsIncrement,
		IN UINT64	Diff,
		OUT INT8 *	ValueWidthDiff
	)

Increment/decrement the value contained in the IntegerNode.

Parameters

[in]	IntegerNode	Pointer to an object node containing an integer.
[in]	IsIncrement	Choose the operation to do: TRUE: Increment the Node's size and the Node's count; FALSE: Decrement the Node's size and the Node's count.
[in]	Diff	Value to add/subtract to the integer.
[out]	ValueWidthDiff	When modifying the integer, it can be promoted/demoted, e.g. from UINT8 to UINT16. Stores the change in width. Can be negative.

Return values

EFI_SUCCESS	The function completed successfully.
EFI_INVALID_PARAMETER	Invalid parameter.

Definition at line 522 of file AmlUtility.c.

◆ AmlPropagateInformation()

EFI_STATUS EFIAPI AmlPropagateInformation	(	IN AML_NODE_HEADER *	Node,
		IN BOOLEAN	IsIncrement,
		IN UINT32	Diff,
		IN UINT8	NodeCount
	)

Propagate information up the tree.

The information can be a new size, a new number of arguments.

Parameters

[in]	Node	Pointer to a node. Must be a root node or an object node.
[in]	IsIncrement	Choose the operation to do: TRUE: Increment the Node's size and the Node's count; FALSE: Decrement the Node's size and the Node's count.
[in]	Diff	Value to add/subtract to the Node's size.
[in]	NodeCount	Number of nodes added/removed.

Return values

EFI_SUCCESS	The function completed successfully.
EFI_INVALID_PARAMETER	Invalid parameter.

Definition at line 870 of file AmlUtility.c.

◆ AmlPropagateNodeCount()

STATIC EFI_STATUS EFIAPI AmlPropagateNodeCount	(	IN AML_OBJECT_NODE *	ObjectNode,
		IN BOOLEAN	IsIncrement,
		IN UINT8	NodeCount,
		OUT INT8 *	FieldWidthChange
	)

Propagate the node count information up the tree.

Parameters

[in]	ObjectNode	Pointer to an object node.
[in]	IsIncrement	Choose the operation to do: TRUE: Increment the Node's size and the Node's count; FALSE: Decrement the Node's size and the Node's count.
[in]	NodeCount	Number of nodes added/removed (depends on the value of Operation).
[out]	FieldWidthChange	When modifying the integer, it can be promoted/demoted, e.g. from UINT8 to UINT16. Stores the change in width. Can be negative.

Return values

EFI_SUCCESS	The function completed successfully.
EFI_INVALID_PARAMETER	Invalid parameter.

Definition at line 785 of file AmlUtility.c.

◆ AmlPropagateSize()

STATIC EFI_STATUS EFIAPI AmlPropagateSize	(	IN AML_NODE_HEADER *	Node,
		IN BOOLEAN	IsIncrement,
		IN UINT32 *	Diff
	)

Propagate the size information up the tree.

The length of the ACPI table is updated in the RootNode, but not the checksum.

Parameters

[in]	Node	Pointer to a node. Must be a root node or an object node.
[in]	IsIncrement	Choose the operation to do: TRUE: Increment the Node's size and the Node's count; FALSE: Decrement the Node's size and the Node's count.
[in]	Diff	Value to add/subtract to the Node's size.

Return values

EFI_SUCCESS	The function completed successfully.
EFI_INVALID_PARAMETER	Invalid parameter.

Definition at line 589 of file AmlUtility.c.

◆ AmlSetRdListCheckSum()

EFI_STATUS EFIAPI AmlSetRdListCheckSum	(	IN AML_OBJECT_NODE *	BufferOpNode,
		IN UINT8	CheckSum
	)

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.

Parameters

[in]	BufferOpNode	Node having a list of Resource Data elements.
[in]	CheckSum	CheckSum to store in the EndTag. To ignore/avoid computing the checksum, give 0.

Return values

EFI_SUCCESS	The function completed successfully.
EFI_INVALID_PARAMETER	Invalid parameter.
EFI_NOT_FOUND	No EndTag found.

Definition at line 961 of file AmlUtility.c.

◆ AmlUnwindSpecialInteger()

STATIC EFI_STATUS EFIAPI AmlUnwindSpecialInteger ( IN AML_OBJECT_NODE * Node )

Replace a Zero (AML_ZERO_OP) or One (AML_ONE_OP) object node with a byte integer (AML_BYTE_PREFIX) object node having the same value.

Parameters

[in] Node Pointer to an integer node. Must be an object node having ZeroOp or OneOp.

Return values

EFI_SUCCESS	The function completed successfully.
EFI_INVALID_PARAMETER	Invalid parameter.

Definition at line 288 of file AmlUtility.c.

Functions

Detailed Description

Function Documentation

◆ AcpiPlatformChecksum()

◆ AmlComputeSize()

◆ AmlComputeSizeCallback()

◆ AmlNodeGetIntegerValue()

◆ AmlNodeSetIntegerValue()

◆ AmlNodeUpdateIntegerValue()

◆ AmlPropagateInformation()

◆ AmlPropagateNodeCount()

◆ AmlPropagateSize()

◆ AmlSetRdListCheckSum()

◆ AmlUnwindSpecialInteger()