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