tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

DynamicTablesPkg: Table Helper Library 

A helper library that implements common functionality
for use by table generators.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Sami Mujawar <sami.mujawar@arm.com>
Reviewed-by: Alexei Fedorov <alexei.fedorov@arm.com>
This commit is contained in:
Sami Mujawar 2018-12-15 12:02:25 +00:00
parent c642023894
commit 7130bceff2
4 changed files with 300 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
DynamicTablesPkg/DynamicTables.dsc.inc Normal file
View File

@ -0,0 +1,20 @@
## @file
# Dsc include file for Dynamic Tables Framework.
#
# Copyright (c) 2017 - 2018, ARM Limited. All rights reserved.<BR>
#
# This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License
# which accompanies this distribution. The full text of the license may be found at
# http://opensource.org/licenses/bsd-license.php
#
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#
##
[Defines]
[LibraryClasses.common]
TableHelperLib|DynamicTablesPkg/Library/Common/TableHelperLib/TableHelperLib.inf

68
DynamicTablesPkg/Include/Library/TableHelperLib.h Normal file
View File

@ -0,0 +1,68 @@
/** @file
Copyright (c) 2017 - 2019, ARM Limited. All rights reserved.
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#ifndef TABLE_HELPER_LIB_H_
#define TABLE_HELPER_LIB_H_
/** The GetCgfMgrInfo function gets the CM_STD_OBJ_CONFIGURATION_MANAGER_INFO
object from the Configuration Manager.
@param [in] CfgMgrProtocol Pointer to the Configuration Manager protocol
interface.
@param [out] CfgMfrInfo Pointer to the Configuration Manager Info
object structure.
@retval EFI_SUCCESS The object is returned.
@retval EFI_INVALID_PARAMETER The Object ID is invalid.
@retval EFI_NOT_FOUND The requested Object is not found.
@retval EFI_BAD_BUFFER_SIZE The size returned by the Configuration
Manager is less than the Object size.
**/
EFI_STATUS
EFIAPI
GetCgfMgrInfo (
IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL * CONST CfgMgrProtocol,
OUT CM_STD_OBJ_CONFIGURATION_MANAGER_INFO ** CfgMfrInfo
);
/** 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.
@param [in] CfgMgrProtocol Pointer to the Configuration Manager
protocol interface.
@param [in] Generator Pointer to the ACPI table Generator.
@param [in,out] AcpiHeader Pointer to the ACPI table header to be
updated.
@param [in] Revision Revision of the ACPI table.
@param [in] Length Length of the ACPI table.
@retval EFI_SUCCESS The ACPI table is updated successfully.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND The required object information is not found.
@retval EFI_BAD_BUFFER_SIZE The size returned by the Configuration
Manager is less than the Object size for the
requested object.
**/
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 UINT32 Revision,
IN CONST UINT32 Length
);
#endif // TABLE_HELPER_LIB_H_

176
DynamicTablesPkg/Library/Common/TableHelperLib/TableHelper.c Normal file
View File

@ -0,0 +1,176 @@
/** @file
Table Helper
Copyright (c) 2017 - 2019, ARM Limited. All rights reserved.
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include <Protocol/AcpiTable.h>
#include <Library/BaseLib.h>
#include <Library/DebugLib.h>
#include <Library/BaseMemoryLib.h>
// Module specific include files.
#include <AcpiTableGenerator.h>
#include <ConfigurationManagerObject.h>
#include <Protocol/ConfigurationManagerProtocol.h>
/** The GetCgfMgrInfo function gets the CM_STD_OBJ_CONFIGURATION_MANAGER_INFO
object from the Configuration Manager.
@param [in] CfgMgrProtocol Pointer to the Configuration Manager protocol
interface.
@param [out] CfgMfrInfo Pointer to the Configuration Manager Info
object structure.
@retval EFI_SUCCESS The object is returned.
@retval EFI_INVALID_PARAMETER The Object ID is invalid.
@retval EFI_NOT_FOUND The requested Object is not found.
@retval EFI_BAD_BUFFER_SIZE The size returned by the Configuration
Manager is less than the Object size.
**/
EFI_STATUS
EFIAPI
GetCgfMgrInfo (
IN CONST EDKII_CONFIGURATION_MANAGER_PROTOCOL * CONST CfgMgrProtocol,
OUT CM_STD_OBJ_CONFIGURATION_MANAGER_INFO ** CfgMfrInfo
)
{
EFI_STATUS Status;
CM_OBJ_DESCRIPTOR CmObjectDesc;
ASSERT (CfgMgrProtocol != NULL);
ASSERT (CfgMfrInfo != NULL);
*CfgMfrInfo = NULL;
Status = CfgMgrProtocol->GetObject (
CfgMgrProtocol,
CREATE_CM_STD_OBJECT_ID (EStdObjCfgMgrInfo),
CM_NULL_TOKEN,
&CmObjectDesc
);
if (EFI_ERROR (Status)) {
DEBUG ((
DEBUG_ERROR,
"ERROR: Failed to Get Configuration Manager Info. Status = %r\n",
Status
));
return Status;
}
if (CmObjectDesc.ObjectId != CREATE_CM_STD_OBJECT_ID (EStdObjCfgMgrInfo)) {
DEBUG ((
DEBUG_ERROR,
"ERROR: EStdObjCfgMgrInfo: Invalid ObjectId = 0x%x, expected Id = 0x%x\n",
CmObjectDesc.ObjectId,
CREATE_CM_STD_OBJECT_ID (EStdObjCfgMgrInfo)
));
ASSERT (FALSE);
return EFI_INVALID_PARAMETER;
}
if (CmObjectDesc.Size <
(sizeof (CM_STD_OBJ_CONFIGURATION_MANAGER_INFO) * CmObjectDesc.Count)) {
DEBUG ((
DEBUG_ERROR,
"ERROR: EStdObjCfgMgrInfo: Buffer too small, size = 0x%x\n",
CmObjectDesc.Size
));
ASSERT (FALSE);
return EFI_BAD_BUFFER_SIZE;
}
*CfgMfrInfo = (CM_STD_OBJ_CONFIGURATION_MANAGER_INFO*)CmObjectDesc.Data;
return Status;
}
/** The AddAcpiHeader function updates the ACPI header structure pointed by
the AcpiHeader. It utilizes the ACPI table Generator and the Configuration
Manager protocol to obtain any information required for constructing the
header.
@param [in] CfgMgrProtocol Pointer to the Configuration Manager
protocol interface.
@param [in] Generator Pointer to the ACPI table Generator.
@param [in,out] AcpiHeader Pointer to the ACPI table header to be
updated.
@param [in] Revision Revision of the ACPI table.
@param [in] Length Length of the ACPI table.
@retval EFI_SUCCESS The ACPI table is updated successfully.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND The required object information is not found.
@retval EFI_BAD_BUFFER_SIZE The size returned by the Configuration
Manager is less than the Object size for the
requested object.
**/
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 UINT32 Revision,
IN CONST UINT32 Length
)
{
EFI_STATUS Status;
CM_STD_OBJ_CONFIGURATION_MANAGER_INFO * CfgMfrInfo;
ASSERT (CfgMgrProtocol != NULL);
ASSERT (Generator != NULL);
ASSERT (AcpiHeader != NULL);
ASSERT (Length >= sizeof (EFI_ACPI_DESCRIPTION_HEADER));
if ((CfgMgrProtocol == NULL) ||
(Generator == NULL) ||
(AcpiHeader == NULL) ||
(Length < sizeof (EFI_ACPI_DESCRIPTION_HEADER))
) {
return EFI_INVALID_PARAMETER;
}
Status = GetCgfMgrInfo (CfgMgrProtocol, &CfgMfrInfo);
if (EFI_ERROR (Status)) {
DEBUG ((
DEBUG_ERROR,
"ERROR: Failed to get Configuration Manager info. Status = %r\n",
Status
));
goto error_handler;
}
// UINT32 Signature
AcpiHeader->Signature = Generator->AcpiTableSignature;
// UINT32 Length
AcpiHeader->Length = Length;
// UINT8 Revision
AcpiHeader->Revision = Revision;
// UINT8 Checksum
AcpiHeader->Checksum = 0;
// UINT8 OemId[6]
CopyMem (AcpiHeader->OemId, CfgMfrInfo->OemId, sizeof (AcpiHeader->OemId));
// UINT64 OemTableId
AcpiHeader->OemTableId = Generator->CreatorId;
AcpiHeader->OemTableId <<= 32;
AcpiHeader->OemTableId |= Generator->AcpiTableSignature;
// UINT32 OemRevision
AcpiHeader->OemRevision = CfgMfrInfo->Revision;
// UINT32 CreatorId
AcpiHeader->CreatorId = Generator->CreatorId;
// UINT32 CreatorRevision
AcpiHeader->CreatorRevision = Generator->CreatorRevision;
error_handler:
return Status;
}

36
DynamicTablesPkg/Library/Common/TableHelperLib/TableHelperLib.inf Normal file
View File

@ -0,0 +1,36 @@
## @file
# Table Helper
#
# Copyright (c) 2017 - 2018, ARM Limited. All rights reserved.
#
# This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License
# which accompanies this distribution. The full text of the license may be found at
# http://opensource.org/licenses/bsd-license.php
#
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
##
[Defines]
INF_VERSION = 0x00010019
BASE_NAME = DynamicTableHelperLib
FILE_GUID = E315C738-3A39-4D0D-A0AF-8EDFA770AB39
VERSION_STRING = 1.0
MODULE_TYPE = DXE_DRIVER
LIBRARY_CLASS = TableHelperLib
[Sources]
TableHelper.c
[Packages]
MdePkg/MdePkg.dec
DynamicTablesPkg/DynamicTablesPkg.dec
[LibraryClasses]
BaseLib
[Protocols]
[Guids]