TianoCore EDK2 master
Loading...
Searching...
No Matches
CmObjectTokenFixer.h File Reference

Go to the source code of this file.

Typedefs

typedef EFI_STATUS(EFIAPI * CM_OBJECT_TOKEN_FIXER) (IN CM_OBJ_DESCRIPTOR *CmObject, IN CM_OBJECT_TOKEN Token)
 

Functions

EFI_STATUS EFIAPI FixupCmObjectSelfToken (IN CM_OBJ_DESCRIPTOR *CmObjDesc, IN CM_OBJECT_TOKEN Token)
 

Detailed Description

Configuration Manager object token fixer

Copyright (c) 2021, Arm Limited. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Glossary:
  • Cm or CM - Configuration Manager
  • Obj or OBJ - Object

Definition in file CmObjectTokenFixer.h.

Typedef Documentation

◆ CM_OBJECT_TOKEN_FIXER

typedef EFI_STATUS(EFIAPI * CM_OBJECT_TOKEN_FIXER) (IN CM_OBJ_DESCRIPTOR *CmObject, IN CM_OBJECT_TOKEN Token)

CmObjectToken fixer function that updates the Tokens in the CmObjects.

Parameters
[in]CmObjectPointer to the Configuration Manager Object.
[in]TokenToken to be updated in the CmObject.
Return values
EFI_SUCCESSSuccess.
EFI_INVALID_PARAMETERA parameter is invalid.
EFI_UNSUPPORTEDNot supported.

Definition at line 26 of file CmObjectTokenFixer.h.

Function Documentation

◆ FixupCmObjectSelfToken()

EFI_STATUS EFIAPI FixupCmObjectSelfToken ( IN CM_OBJ_DESCRIPTOR CmObjDesc,
IN CM_OBJECT_TOKEN  Token 
)

CmObj token fixer.

Some CmObj structures have a self-token, i.e. they are storing their own token value in the CmObj. Dynamically created CmObj need to have their self-token assigned at some point.

Parameters
[in]CmObjDescPointer to the Configuration Manager Object.
[in]TokenToken to update the CmObjDesc with.
Return values
EFI_SUCCESSSuccess.
EFI_INVALID_PARAMETERA parameter is invalid.
EFI_UNSUPPORTEDNot supported.

Definition at line 187 of file CmObjectTokenFixer.c.