DynamicTablesPkg: Definition for DynamicPlatRepoLib interface

The DynamicPlatRepoLib library allows to handle dynamically created
CmObj. The dynamic platform repository can be in the following states:
1 - Non-initialised
2 - Transient:
    Possibility to add CmObj to the platform, but not to query them.
3 - Finalised:
    Possibility to query CmObj, but not to add new.

A token is allocated to each CmObj added to the dynamic platform
repository (except for reference tokens CmObj). This allows to
retrieve dynamic CmObjs among all CmObj (static CmObj for instance).

This patch defines the library interface of the DynamicPlatRepo.

Signed-off-by: Pierre Gondois <Pierre.Gondois@arm.com>
Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>
This commit is contained in:
Pierre Gondois 2021-12-09 10:32:47 +01:00 committed by mergify[bot]
parent 9006967c8d
commit b2d0ed20fd
2 changed files with 117 additions and 0 deletions

View File

@ -24,6 +24,9 @@
## @libraryclass Defines a set of APIs for Dynamic AML generation. ## @libraryclass Defines a set of APIs for Dynamic AML generation.
AmlLib|Include/Library/AmlLib/AmlLib.h AmlLib|Include/Library/AmlLib/AmlLib.h
## @libraryclass Defines a set of APIs to handle dynamically created CmObj.
DynamicPlatRepoLib|Include/Library/DynamicPlatRepoLib.h
## @libraryclass Defines a set of APIs to a hardware information parser. ## @libraryclass Defines a set of APIs to a hardware information parser.
HwInfoParserLib|Include/Library/HwInfoParserLib.h HwInfoParserLib|Include/Library/HwInfoParserLib.h

View File

@ -0,0 +1,114 @@
/** @file
Dynamic Platform Info Repository
Copyright (c) 2021, Arm Limited. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
@par Glossary:
- Cm or CM - Configuration Manager
- Obj or OBJ - Object
**/
#ifndef DYNAMIC_PLAT_REPO_H_
#define DYNAMIC_PLAT_REPO_H_
#include <Protocol/ConfigurationManagerProtocol.h>
/** A structure describing the platform configuration
manager repository information
*/
typedef VOID *DYNAMIC_PLATFORM_REPOSITORY_INFO;
/** Add an object to the dynamic platform repository.
@param [in] This This dynamic platform repository.
@param [in] CmObjDesc CmObj to add. The data is copied.
@param [out] Token If not NULL, token allocated to this CmObj.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_OUT_OF_RESOURCES An allocation has failed.
**/
EFI_STATUS
EFIAPI
DynPlatRepoAddObject (
IN DYNAMIC_PLATFORM_REPOSITORY_INFO *This,
IN CONST CM_OBJ_DESCRIPTOR *CmObjDesc,
OUT CM_OBJECT_TOKEN *Token OPTIONAL
);
/** Finalise the dynamic repository.
Finalising means:
- Preventing any further objects from being added.
- Allowing to get objects from the dynamic repository
(not possible before a call to this function).
@param [in] This This dynamic platform repository.
@retval EFI_SUCCESS Success.
@retval EFI_ALREADY_STARTED Instance already initialised.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_BUFFER_TOO_SMALL Buffer too small.
@retval EFI_OUT_OF_RESOURCES An allocation has failed.
**/
EFI_STATUS
EFIAPI
DynamicPlatRepoFinalise (
IN DYNAMIC_PLATFORM_REPOSITORY_INFO *This
);
/** Get a CmObj from the dynamic repository.
@param [in] This Pointer to the Dynamic Platform Repository.
@param [in] CmObjectId The Configuration Manager Object ID.
@param [in] Token An optional token identifying the object. If
unused this must be CM_NULL_TOKEN.
@param [in, out] CmObjDesc Pointer to the Configuration Manager Object
descriptor describing the requested Object.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_FOUND The required object information is not found.
**/
EFI_STATUS
EFIAPI
DynamicPlatRepoGetObject (
IN DYNAMIC_PLATFORM_REPOSITORY_INFO *This,
IN CM_OBJECT_ID CmObjectId,
IN CM_OBJECT_TOKEN Token OPTIONAL,
IN OUT CM_OBJ_DESCRIPTOR *CmObjDesc
);
/** Initialize the dynamic platform repository.
@param [out] DynPlatRepo If success, contains the initialised dynamic
platform repository.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_OUT_OF_RESOURCES An allocation has failed.
**/
EFI_STATUS
EFIAPI
DynamicPlatRepoInit (
OUT DYNAMIC_PLATFORM_REPOSITORY_INFO **DynPlatRepo
);
/** Shutdown the dynamic platform repository.
Free all the memory allocated for the dynamic platform repository.
@param [in] DynPlatRepo The dynamic platform repository.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_SUCCESS Success.
**/
EFI_STATUS
EFIAPI
DynamicPlatRepoShutdown (
IN DYNAMIC_PLATFORM_REPOSITORY_INFO *DynPlatRepo
);
#endif // DYNAMIC_PLAT_REPO_H_