AmlTreeEnumerator.c File Reference

#include <AmlNodeDefines.h>
#include <AmlCoreInterface.h>
#include <Tree/AmlTree.h>

Go to the source code of this file.

Functions
BOOLEAN EFIAPI	AmlEnumTree (IN AML_NODE_HEADER *Node, IN EDKII_AML_TREE_ENUM_CALLBACK CallBack, IN OUT VOID *Context OPTIONAL, OUT EFI_STATUS *Status OPTIONAL)

Detailed Description

AML Tree Enumerator.

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

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

Definition in file AmlTreeEnumerator.c.

Function Documentation

AmlEnumTree()

BOOLEAN EFIAPI AmlEnumTree	(	IN AML_NODE_HEADER *	Node,
		IN EDKII_AML_TREE_ENUM_CALLBACK	CallBack,
		IN OUT VOID *Context	OPTIONAL,
		OUT EFI_STATUS *Status	OPTIONAL
	)

Enumerate all nodes of the subtree under the input Node in the AML bytestream order (i.e. in a depth first order), and call the CallBack function with the input Context. The prototype of the Callback function is EDKII_AML_TREE_ENUM_CALLBACK.

Parameters

[in]	Node	Enumerate nodes of the subtree under this Node. Must be a valid node.
[in]	CallBack	Callback function to call on each node.
[in,out]	Context	Void pointer used to pass some information to the Callback function. Optional, can be NULL.
[out]	Status	Optional parameter that can be used to get the status of the Callback function. If used, need to be init to EFI_SUCCESS.

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 35 of file AmlTreeEnumerator.c.