TableHelperLib.h File Reference

Typedefs
typedef BOOLEAN(EFIAPI *	PFN_IS_EQUAL )(IN CONST VOID *Object1, IN CONST VOID *Object2, IN UINTN Index1, IN UINTN Index2)

Functions
EFI_STATUS EFIAPI	GetCgfMgrInfo (IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL *CONST CfgMgrProtocol, OUT CM_STD_OBJ_CONFIGURATION_MANAGER_INFO **CfgMfrInfo)
EFI_STATUS EFIAPI	AddAcpiHeader (IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL *CONST CfgMgrProtocol, IN CONST ACPI_TABLE_GENERATOR *CONST Generator, IN OUT EFI_ACPI_DESCRIPTION_HEADER *CONST AcpiHeader, IN CONST CM_STD_OBJ_ACPI_TABLE_INFO *CONST AcpiTableInfo, IN CONST UINT32 Length)
EFI_STATUS EFIAPI	AddSsdtAcpiHeader (IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL *CONST CfgMgrProtocol, IN CONST ACPI_TABLE_GENERATOR *CONST Generator, IN CONST CM_STD_OBJ_ACPI_TABLE_INFO *CONST AcpiTableInfo, OUT AML_ROOT_NODE_HANDLE *RootNode)
BOOLEAN EFIAPI	FindDuplicateValue (IN CONST VOID *Array, IN CONST UINTN Count, IN CONST UINTN ElementSize, IN PFN_IS_EQUAL EqualTestFunction)
VOID EFIAPI	ParseCmObjDesc (IN CONST CM_OBJ_DESCRIPTOR *CmObjDesc)

Detailed Description

Copyright (c) 2017 - 2021, Arm Limited. All rights reserved.

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

Glossary:

• PFN - Pointer to a Function

Typedef Documentation

typedef BOOLEAN(EFIAPI * PFN_IS_EQUAL)(IN CONST VOID *Object1, IN CONST VOID *Object2, IN UINTN Index1, IN UINTN Index2)

Function prototype for testing if two arbitrary objects are equal.

Parameters

[in]	Object1	Pointer to the first object to compare.
[in]	Object2	Pointer to the second object to compare.
[in]	Index1	Index of Object1. This value is optional and can be ignored by the specified implementation.
[in]	Index2	Index of Object2. This value is optional and can be ignored by the specified implementation.

Return values

TRUE	Object1 and Object2 are equal.
FALSE	Object1 and Object2 are NOT equal.

Function Documentation

EFI_STATUS EFIAPI AddAcpiHeader	(	IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL *CONST	CfgMgrProtocol,
		IN CONST ACPI_TABLE_GENERATOR *CONST	Generator,
		IN OUT EFI_ACPI_DESCRIPTION_HEADER *CONST	AcpiHeader,
		IN CONST CM_STD_OBJ_ACPI_TABLE_INFO *CONST	AcpiTableInfo,
		IN CONST UINT32	Length
	)

The AddAcpiHeader function updates the ACPI header structure. It uses the ACPI table Generator and the Configuration Manager protocol to obtain the information required for constructing the header.

Parameters

[in]	CfgMgrProtocol	Pointer to the Configuration Manager protocol interface.
[in]	Generator	Pointer to the ACPI table Generator.
[in,out]	AcpiHeader	Pointer to the ACPI table header to be updated.
[in]	AcpiTableInfo	Pointer to the ACPI table info structure.
[in]	Length	Length of the ACPI table.

Return values

EFI_SUCCESS	The ACPI table is updated successfully.
EFI_INVALID_PARAMETER	A parameter is invalid.
EFI_NOT_FOUND	The required object information is not found.
EFI_BAD_BUFFER_SIZE	The size returned by the Configuration Manager is less than the Object size for the requested object.

EFI_STATUS EFIAPI AddSsdtAcpiHeader	(	IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL *CONST	CfgMgrProtocol,
		IN CONST ACPI_TABLE_GENERATOR *CONST	Generator,
		IN CONST CM_STD_OBJ_ACPI_TABLE_INFO *CONST	AcpiTableInfo,
		OUT AML_ROOT_NODE_HANDLE *	RootNode
	)

Build a RootNode containing SSDT ACPI header information using the AmlLib.

The function utilizes the ACPI table Generator and the Configuration Manager protocol to obtain any information required for constructing the header. It then creates a RootNode. The SSDT ACPI header is part of the RootNode.

This is essentially a wrapper around AmlCodeGenDefinitionBlock () from the AmlLib.

Parameters

[in]	CfgMgrProtocol	Pointer to the Configuration Manager protocol interface.
[in]	Generator	Pointer to the ACPI table Generator.
[in]	AcpiTableInfo	Pointer to the ACPI table info structure.
[out]	RootNode	If success, contains the created RootNode. The SSDT ACPI header is part of the RootNode.

Return values

EFI_SUCCESS	Success.
EFI_INVALID_PARAMETER	A parameter is invalid.
EFI_NOT_FOUND	The required object information is not found.
EFI_BAD_BUFFER_SIZE	The size returned by the Configuration Manager is less than the Object size for the requested object.

BOOLEAN EFIAPI FindDuplicateValue	(	IN CONST VOID *	Array,
		IN CONST UINTN	Count,
		IN CONST UINTN	ElementSize,
		IN PFN_IS_EQUAL	EqualTestFunction
	)

Test and report if a duplicate entry exists in the given array of comparable elements.

Parameters

[in]	Array	Array of elements to test for duplicates.
[in]	Count	Number of elements in Array.
[in]	ElementSize	Size of an element in bytes
[in]	EqualTestFunction	The function to call to check if any two elements are equal.

Return values

TRUE	A duplicate element was found or one of the input arguments is invalid.
FALSE	Every element in Array is unique.

EFI_STATUS EFIAPI GetCgfMgrInfo	(	IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL *CONST	CfgMgrProtocol,
		OUT CM_STD_OBJ_CONFIGURATION_MANAGER_INFO **	CfgMfrInfo
	)

The GetCgfMgrInfo function gets the CM_STD_OBJ_CONFIGURATION_MANAGER_INFO object from the Configuration Manager.

Parameters

[in]	CfgMgrProtocol	Pointer to the Configuration Manager protocol interface.
[out]	CfgMfrInfo	Pointer to the Configuration Manager Info object structure.

Return values

EFI_SUCCESS	The object is returned.
EFI_INVALID_PARAMETER	The Object ID is invalid.
EFI_NOT_FOUND	The requested Object is not found.
EFI_BAD_BUFFER_SIZE	The size returned by the Configuration Manager is less than the Object size.

VOID EFIAPI ParseCmObjDesc

(

IN CONST CM_OBJ_DESCRIPTOR *

CmObjDesc

)

Parse and print a CmObjDesc.

Parameters

[in]

CmObjDesc

The CmObjDesc to parse and print.