]> git.proxmox.com Git - mirror_edk2.git/blame - DynamicTablesPkg/Include/Library/TableHelperLib.h
DynamicTablesPkg: Replace BSD License with BSD+Patent License
[mirror_edk2.git] / DynamicTablesPkg / Include / Library / TableHelperLib.h
CommitLineData
7130bcef
SM
1/** @file\r
2\r
3 Copyright (c) 2017 - 2019, ARM Limited. All rights reserved.\r
4\r
9cd9bdc6 5 SPDX-License-Identifier: BSD-2-Clause-Patent\r
7130bcef
SM
6\r
7**/\r
8\r
9#ifndef TABLE_HELPER_LIB_H_\r
10#define TABLE_HELPER_LIB_H_\r
11\r
12/** The GetCgfMgrInfo function gets the CM_STD_OBJ_CONFIGURATION_MANAGER_INFO\r
13 object from the Configuration Manager.\r
14\r
15 @param [in] CfgMgrProtocol Pointer to the Configuration Manager protocol\r
16 interface.\r
17 @param [out] CfgMfrInfo Pointer to the Configuration Manager Info\r
18 object structure.\r
19\r
20 @retval EFI_SUCCESS The object is returned.\r
21 @retval EFI_INVALID_PARAMETER The Object ID is invalid.\r
22 @retval EFI_NOT_FOUND The requested Object is not found.\r
23 @retval EFI_BAD_BUFFER_SIZE The size returned by the Configuration\r
24 Manager is less than the Object size.\r
25**/\r
26EFI_STATUS\r
27EFIAPI\r
28GetCgfMgrInfo (\r
29 IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL * CONST CfgMgrProtocol,\r
30 OUT CM_STD_OBJ_CONFIGURATION_MANAGER_INFO ** CfgMfrInfo\r
31 );\r
32\r
33/** The AddAcpiHeader function updates the ACPI header structure. It uses the\r
34 ACPI table Generator and the Configuration Manager protocol to obtain the\r
35 information required for constructing the header.\r
36\r
37 @param [in] CfgMgrProtocol Pointer to the Configuration Manager\r
38 protocol interface.\r
39 @param [in] Generator Pointer to the ACPI table Generator.\r
40 @param [in,out] AcpiHeader Pointer to the ACPI table header to be\r
41 updated.\r
e12bdeb1 42 @param [in] AcpiTableInfo Pointer to the ACPI table info structure.\r
7130bcef
SM
43 @param [in] Length Length of the ACPI table.\r
44\r
45 @retval EFI_SUCCESS The ACPI table is updated successfully.\r
46 @retval EFI_INVALID_PARAMETER A parameter is invalid.\r
47 @retval EFI_NOT_FOUND The required object information is not found.\r
48 @retval EFI_BAD_BUFFER_SIZE The size returned by the Configuration\r
49 Manager is less than the Object size for the\r
50 requested object.\r
51**/\r
52EFI_STATUS\r
53EFIAPI\r
54AddAcpiHeader (\r
55 IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL * CONST CfgMgrProtocol,\r
56 IN CONST ACPI_TABLE_GENERATOR * CONST Generator,\r
57 IN OUT EFI_ACPI_DESCRIPTION_HEADER * CONST AcpiHeader,\r
e12bdeb1 58 IN CONST CM_STD_OBJ_ACPI_TABLE_INFO * CONST AcpiTableInfo,\r
7130bcef
SM
59 IN CONST UINT32 Length\r
60 );\r
61\r
62#endif // TABLE_HELPER_LIB_H_\r