AmlApiHelper.h File Reference

#include <AmlNodeDefines.h>
#include <ResourceData/AmlResourceData.h>

Go to the source code of this file.

Functions
BOOLEAN EFIAPI	AmlNameOpCompareName (IN AML_OBJECT_NODE_HANDLE NameOpNode, IN CHAR8 *AslName)
BOOLEAN EFIAPI	AmlNodeHasOpCode (IN AML_OBJECT_NODE_HANDLE ObjectNode, IN UINT8 OpCode, IN UINT8 SubOpCode)
BOOLEAN EFIAPI	AmlNodeHasDataType (IN AML_DATA_NODE_HANDLE DataNode, IN EAML_NODE_DATA_TYPE DataType)
BOOLEAN EFIAPI	AmlNodeHasRdDataType (IN AML_DATA_NODE_HANDLE RdNode, IN AML_RD_HEADER RdDataType)

Detailed Description

AML Helper.

Copyright (c) 2020, Arm Limited. All rights reserved.

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

Definition in file AmlApiHelper.h.

Function Documentation

AmlNameOpCompareName()

BOOLEAN EFIAPI AmlNameOpCompareName	(	IN AML_OBJECT_NODE_HANDLE	NameOpNode,
		IN CHAR8 *	AslName
	)

Compare the NameString defined by the "Name ()" ASL function, and stored in the NameOpNode, with the input NameString.

An ASL NameString is expected to be NULL terminated, and can be composed of NameSegs that have less that 4 chars, like "DEV". "DEV" will be expanded as "DEV_".

An AML NameString is not NULL terminated and is only composed of 4 chars long NameSegs.

Parameters

[in]	NameOpNode	NameOp object node defining a variable. Must have an AML_NAME_OP/0 OpCode/SubOpCode. NameOp object nodes are defined in ASL using the "Name ()" function.
[in]	AslName	ASL NameString to compare the NameOp's name with. Must be NULL terminated.

Return values

TRUE	If the AslName and the AmlName defined by the NameOp node are similar.
FALSE	Otherwise.

Definition at line 46 of file AmlApiHelper.c.

AmlNodeHasDataType()

BOOLEAN EFIAPI AmlNodeHasDataType	(	IN AML_DATA_NODE_HANDLE	DataNode,
		IN EAML_NODE_DATA_TYPE	DataType
	)

Check whether DataNode has the input DataType.

Parameters

[in]	DataNode	Pointer to a data node.
[in]	DataType	DataType to check.

Return values

TRUE	The node is a data node and the DataType match.
FALSE	Otherwise.

Definition at line 168 of file AmlApiHelper.c.

AmlNodeHasOpCode()

BOOLEAN EFIAPI AmlNodeHasOpCode	(	IN AML_OBJECT_NODE_HANDLE	ObjectNode,
		IN UINT8	OpCode,
		IN UINT8	SubOpCode
	)

Check whether ObjectNode has the input OpCode/SubOpcode couple.

Parameters

[in]	ObjectNode	Pointer to an object node.
[in]	OpCode	OpCode to check
[in]	SubOpCode	SubOpCode to check

Return values

TRUE	The node is an object node and the Opcode and SubOpCode match.
FALSE	Otherwise.

Definition at line 124 of file AmlApiHelper.c.

AmlNodeHasRdDataType()

BOOLEAN EFIAPI AmlNodeHasRdDataType	(	IN AML_DATA_NODE_HANDLE	RdNode,
		IN AML_RD_HEADER	RdDataType
	)

Check whether RdNode has the input RdDataType.

Parameters

[in]	RdNode	Pointer to a data node.
[in]	RdDataType	DataType to check.

Return values

TRUE	The node is a Resource Data node and the RdDataType match.
FALSE	Otherwise.

Definition at line 202 of file AmlApiHelper.c.