UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm

[mirror_edk2.git] / DynamicTablesPkg / Include / Library / TableHelperLib.h

/** @file\r
\r
  Copyright (c) 2017 - 2021, Arm Limited. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
  @par Glossary:\r
    - PFN   - Pointer to a Function\r
\r
**/\r
\r
#ifndef TABLE_HELPER_LIB_H_\r
#define TABLE_HELPER_LIB_H_\r
\r
#include <Library/AmlLib/AmlLib.h>\r
\r
/** The GetCgfMgrInfo function gets the CM_STD_OBJ_CONFIGURATION_MANAGER_INFO\r
    object from the Configuration Manager.\r
\r
  @param [in]  CfgMgrProtocol Pointer to the Configuration Manager protocol\r
                              interface.\r
  @param [out] CfgMfrInfo     Pointer to the Configuration Manager Info\r
                              object structure.\r
\r
  @retval EFI_SUCCESS           The object is returned.\r
  @retval EFI_INVALID_PARAMETER The Object ID is invalid.\r
  @retval EFI_NOT_FOUND         The requested Object is not found.\r
  @retval EFI_BAD_BUFFER_SIZE   The size returned by the Configuration\r
                                Manager is less than the Object size.\r
**/\r
EFI_STATUS\r
EFIAPI\r
GetCgfMgrInfo (\r
  IN  CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL      *CONST  CfgMgrProtocol,\r
  OUT       CM_STD_OBJ_CONFIGURATION_MANAGER_INFO             **CfgMfrInfo\r
  );\r
\r
/** The AddAcpiHeader function updates the ACPI header structure. It uses the\r
    ACPI table Generator and the Configuration Manager protocol to obtain the\r
    information required for constructing the header.\r
\r
  @param [in]     CfgMgrProtocol Pointer to the Configuration Manager\r
                                 protocol interface.\r
  @param [in]     Generator      Pointer to the ACPI table Generator.\r
  @param [in,out] AcpiHeader     Pointer to the ACPI table header to be\r
                                 updated.\r
  @param [in]     AcpiTableInfo  Pointer to the ACPI table info structure.\r
  @param [in]     Length         Length of the ACPI table.\r
\r
  @retval EFI_SUCCESS           The ACPI table is updated successfully.\r
  @retval EFI_INVALID_PARAMETER A parameter is invalid.\r
  @retval EFI_NOT_FOUND         The required object information is not found.\r
  @retval EFI_BAD_BUFFER_SIZE   The size returned by the Configuration\r
                                Manager is less than the Object size for the\r
                                requested object.\r
**/\r
EFI_STATUS\r
EFIAPI\r
AddAcpiHeader (\r
  IN      CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL  *CONST  CfgMgrProtocol,\r
  IN      CONST ACPI_TABLE_GENERATOR                  *CONST  Generator,\r
  IN OUT  EFI_ACPI_DESCRIPTION_HEADER                 *CONST  AcpiHeader,\r
  IN      CONST CM_STD_OBJ_ACPI_TABLE_INFO            *CONST  AcpiTableInfo,\r
  IN      CONST UINT32                                        Length\r
  );\r
\r
/** Build a RootNode containing SSDT ACPI header information using the AmlLib.\r
\r
  The function utilizes the ACPI table Generator and the Configuration\r
  Manager protocol to obtain any information required for constructing the\r
  header. It then creates a RootNode. The SSDT ACPI header is part of the\r
  RootNode.\r
\r
  This is essentially a wrapper around AmlCodeGenDefinitionBlock ()\r
  from the AmlLib.\r
\r
  @param [in]   CfgMgrProtocol Pointer to the Configuration Manager\r
                               protocol interface.\r
  @param [in]   Generator      Pointer to the ACPI table Generator.\r
  @param [in]   AcpiTableInfo  Pointer to the ACPI table info structure.\r
  @param [out]  RootNode       If success, contains the created RootNode.\r
                               The SSDT ACPI header is part of the RootNode.\r
\r
  @retval EFI_SUCCESS           Success.\r
  @retval EFI_INVALID_PARAMETER A parameter is invalid.\r
  @retval EFI_NOT_FOUND         The required object information is not found.\r
  @retval EFI_BAD_BUFFER_SIZE   The size returned by the Configuration\r
                                Manager is less than the Object size for the\r
                                requested object.\r
**/\r
EFI_STATUS\r
EFIAPI\r
AddSsdtAcpiHeader (\r
  IN      CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL  *CONST  CfgMgrProtocol,\r
  IN      CONST ACPI_TABLE_GENERATOR                  *CONST  Generator,\r
  IN      CONST CM_STD_OBJ_ACPI_TABLE_INFO            *CONST  AcpiTableInfo,\r
  OUT       AML_ROOT_NODE_HANDLE                              *RootNode\r
  );\r
\r
/**\r
  Function prototype for testing if two arbitrary objects are equal.\r
\r
  @param [in] Object1           Pointer to the first object to compare.\r
  @param [in] Object2           Pointer to the second object to compare.\r
  @param [in] Index1            Index of Object1. This value is optional and\r
                                can be ignored by the specified implementation.\r
  @param [in] Index2            Index of Object2. This value is optional and\r
                                can be ignored by the specified implementation.\r
\r
  @retval TRUE                  Object1 and Object2 are equal.\r
  @retval FALSE                 Object1 and Object2 are NOT equal.\r
**/\r
typedef\r
BOOLEAN\r
(EFIAPI *PFN_IS_EQUAL)(\r
  IN CONST  VOID            *Object1,\r
  IN CONST  VOID            *Object2,\r
  IN        UINTN             Index1 OPTIONAL,\r
  IN        UINTN             Index2 OPTIONAL\r
  );\r
\r
/**\r
  Test and report if a duplicate entry exists in the given array of comparable\r
  elements.\r
\r
  @param [in] Array                 Array of elements to test for duplicates.\r
  @param [in] Count                 Number of elements in Array.\r
  @param [in] ElementSize           Size of an element in bytes\r
  @param [in] EqualTestFunction     The function to call to check if any two\r
                                    elements are equal.\r
\r
  @retval TRUE                      A duplicate element was found or one of\r
                                    the input arguments is invalid.\r
  @retval FALSE                     Every element in Array is unique.\r
**/\r
BOOLEAN\r
EFIAPI\r
FindDuplicateValue (\r
  IN  CONST VOID          *Array,\r
  IN  CONST UINTN         Count,\r
  IN  CONST UINTN         ElementSize,\r
  IN        PFN_IS_EQUAL  EqualTestFunction\r
  );\r
\r
/** Parse and print a CmObjDesc.\r
\r
  @param [in]  CmObjDesc  The CmObjDesc to parse and print.\r
**/\r
VOID\r
EFIAPI\r
ParseCmObjDesc (\r
  IN  CONST CM_OBJ_DESCRIPTOR  *CmObjDesc\r
  );\r
\r
#endif // TABLE_HELPER_LIB_H_\r