mirror of
https://github.com/acidanthera/audk.git
synced 2025-07-31 01:24:12 +02:00
9c040c003a
Update DynamicPlatRepo to reflect the introduction of the Arch Common namespace. Also, update the TokenFixer map to reflect the current state of the ArmNamespace Objects and add a note in the documentation header for the EARM_OBJECT_ID enum, that the Token fixer map needs updating whenever the ArmObjectId space is updated. Cc: Pierre Gondois <Pierre.Gondois@arm.com> Cc: Yeo Reum Yun <YeoReum.Yun@arm.com> Cc: AbdulLateef Attar <AbdulLateef.Attar@amd.com> Cc: Jeshua Smith <jeshuas@nvidia.com> Cc: Jeff Brasen <jbrasen@nvidia.com> Cc: Girish Mahadevan <gmahadevan@nvidia.com> Cc: Leif Lindholm <quic_llindhol@quicinc.com> Cc: Meenakshi Aggarwal <meenakshi.aggarwal@nxp.com> Signed-off-by: Sami Mujawar <sami.mujawar@arm.com> Signed-off-by: Pierre Gondois <pierre.gondois@arm.com> Reviewed-by: Sunil V L <sunilvl@ventanamicro.com>
88 lines
2.8 KiB
C
88 lines
2.8 KiB
C
/** @file
|
|
Dynamic Platform Info Repository Internal
|
|
|
|
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_INTERNAL_H_
|
|
#define DYNAMIC_PLAT_REPO_INTERNAL_H_
|
|
|
|
#include "TokenMapper.h"
|
|
|
|
#pragma pack(1)
|
|
|
|
/** CmObj node.
|
|
|
|
This is a node wrapper around the CM_OBJ_DESCRIPTOR structure.
|
|
It also allows to bind a token to the CM_OBJ_DESCRIPTOR.
|
|
*/
|
|
typedef struct CmObjectNode {
|
|
/// This must be the first field in this structure.
|
|
LIST_ENTRY Link;
|
|
|
|
/// Token associated with the CmObjDesc.
|
|
CM_OBJECT_TOKEN Token;
|
|
|
|
/// CmObjDesc wrapped.
|
|
/// Note: the CM_OBJ_DESCRIPTOR.Data field is allocated and copied.
|
|
CM_OBJ_DESCRIPTOR CmObjDesc;
|
|
} CM_OBJ_NODE;
|
|
|
|
/** Dynamic repository states.
|
|
|
|
The states must progress as:
|
|
UnInitialised -> Transient -> Finalized
|
|
*/
|
|
typedef enum DynRepoState {
|
|
DynRepoUnInitialised, ///< Un-Initialised state
|
|
DynRepoTransient, ///< Transient state - CmObjects can be added.
|
|
DynRepoFinalized, ///< Repo Locked - No further CmObjects can be added.
|
|
///< Getting objects is now possible.
|
|
DynRepoMax ///< Max value.
|
|
} EDYNAMIC_REPO_STATE;
|
|
|
|
/** A structure describing the platform configuration
|
|
manager repository information
|
|
*/
|
|
typedef struct DynamicPlatformRepositoryInfo {
|
|
/// Repo state machine.
|
|
EDYNAMIC_REPO_STATE RepoState;
|
|
|
|
/// Count of all the objects added to the Dynamic Platform Repo
|
|
/// during the Transient state.
|
|
UINTN ObjectCount;
|
|
|
|
/// Link lists of CmObj from the ArmNameSpace
|
|
/// that are added in the Transient state.
|
|
LIST_ENTRY ArmCmObjList[EArmObjMax];
|
|
|
|
/// Structure Members used in Finalized state.
|
|
/// An array of CmObj Descriptors from the ArmNameSpace
|
|
/// This array is populated when the Repo is finalized.
|
|
CM_OBJ_DESCRIPTOR ArmCmObjArray[EArmObjMax];
|
|
|
|
/// Link lists of CmObj from the ArchCommon Namespace
|
|
/// that are added in the Transient state.
|
|
LIST_ENTRY ArchCommonCmObjList[EArchCommonObjMax];
|
|
|
|
/// Structure Members used in Finalized state.
|
|
/// An array of CmObj Descriptors from the ArchCommon Namespace
|
|
/// This array is populated when the Repo is finalized.
|
|
CM_OBJ_DESCRIPTOR ArchCommonCmObjArray[EArchCommonObjMax];
|
|
|
|
/// A token mapper for the objects in the <Arm|ArchCommon>CmObjArray
|
|
/// The Token mapper is populated when the Repo is finalized in
|
|
/// a call to DynamicPlatRepoFinalise ().
|
|
TOKEN_MAPPER TokenMapper;
|
|
} DYNAMIC_PLATFORM_REPOSITORY_INFO;
|
|
|
|
#pragma pack()
|
|
|
|
#endif // DYNAMIC_PLAT_REPO_INTERNAL_H_
|