DynamicTablesPkg/Include/Library/TableHelperLib.h

   1 /** @file
   2
   3   Copyright (c) 2017 - 2019, ARM Limited. All rights reserved.
   4
   5   This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef TABLE_HELPER_LIB_H_
  16 #define TABLE_HELPER_LIB_H_
  17
  18 /** The GetCgfMgrInfo function gets the CM_STD_OBJ_CONFIGURATION_MANAGER_INFO
  19     object from the Configuration Manager.
  20
  21   @param [in]  CfgMgrProtocol Pointer to the Configuration Manager protocol
  22                               interface.
  23   @param [out] CfgMfrInfo     Pointer to the Configuration Manager Info
  24                               object structure.
  25
  26   @retval EFI_SUCCESS           The object is returned.
  27   @retval EFI_INVALID_PARAMETER The Object ID is invalid.
  28   @retval EFI_NOT_FOUND         The requested Object is not found.
  29   @retval EFI_BAD_BUFFER_SIZE   The size returned by the Configuration
  30                                 Manager is less than the Object size.
  31 **/
  32 EFI_STATUS
  33 EFIAPI
  34 GetCgfMgrInfo (
  35   IN  CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL      * CONST  CfgMgrProtocol,
  36   OUT       CM_STD_OBJ_CONFIGURATION_MANAGER_INFO    **        CfgMfrInfo
  37   );
  38
  39 /** The AddAcpiHeader function updates the ACPI header structure. It uses the
  40     ACPI table Generator and the Configuration Manager protocol to obtain the
  41     information required for constructing the header.
  42
  43   @param [in]     CfgMgrProtocol Pointer to the Configuration Manager
  44                                  protocol interface.
  45   @param [in]     Generator      Pointer to the ACPI table Generator.
  46   @param [in,out] AcpiHeader     Pointer to the ACPI table header to be
  47                                  updated.
  48   @param [in]     Revision       Revision of the ACPI table.
  49   @param [in]     Length         Length of the ACPI table.
  50
  51   @retval EFI_SUCCESS           The ACPI table is updated successfully.
  52   @retval EFI_INVALID_PARAMETER A parameter is invalid.
  53   @retval EFI_NOT_FOUND         The required object information is not found.
  54   @retval EFI_BAD_BUFFER_SIZE   The size returned by the Configuration
  55                                 Manager is less than the Object size for the
  56                                 requested object.
  57 **/
  58 EFI_STATUS
  59 EFIAPI
  60 AddAcpiHeader (
  61   IN      CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL  * CONST CfgMgrProtocol,
  62   IN      CONST ACPI_TABLE_GENERATOR                  * CONST Generator,
  63   IN OUT  EFI_ACPI_DESCRIPTION_HEADER                 * CONST AcpiHeader,
  64   IN      CONST UINT32                                        Revision,
  65   IN      CONST UINT32                                        Length
  66   );
  67
  68 #endif // TABLE_HELPER_LIB_H_