Service.h

Go to the documentation of this file.

 
#ifndef _PEI_PCD_SERVICE_H_
#define _PEI_PCD_SERVICE_H_
 
#include <PiPei.h>
#include <Ppi/ReadOnlyVariable2.h>
#include <Ppi/Pcd.h>
#include <Ppi/PiPcd.h>
#include <Ppi/PcdInfo.h>
#include <Ppi/PiPcdInfo.h>
#include <Guid/PcdDataBaseHobGuid.h>
#include <Guid/PcdDataBaseSignatureGuid.h>
#include <Guid/VariableFormat.h>
#include <Library/DebugLib.h>
#include <Library/PeimEntryPoint.h>
#include <Library/BaseLib.h>
#include <Library/HobLib.h>
#include <Library/PeiServicesLib.h>
#include <Library/PcdLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/MemoryAllocationLib.h>
 
//
// Please make sure the PCD Serivce PEIM Version is consistent with
// the version of the generated PEIM PCD Database by build tool.
//
#define PCD_SERVICE_PEIM_VERSION  7
 
//
// PCD_PEI_SERVICE_DRIVER_VERSION is defined in Autogen.h.
//
#if (PCD_SERVICE_PEIM_VERSION != PCD_PEI_SERVICE_DRIVER_VERSION)
  #error "Please make sure the version of PCD PEIM Service and the generated PCD PEI Database match."
#endif
 
EFI_STATUS
EFIAPI
PeiGetPcdInfoGetInfo (
  IN        UINTN         TokenNumber,
  OUT       EFI_PCD_INFO  *PcdInfo
  );
 
EFI_STATUS
EFIAPI
PeiGetPcdInfoGetInfoEx (
  IN CONST  EFI_GUID      *Guid,
  IN        UINTN         TokenNumber,
  OUT       EFI_PCD_INFO  *PcdInfo
  );
 
UINTN
EFIAPI
PeiGetPcdInfoGetSku (
  VOID
  );
 
//
// PPI Interface Implementation Declaration.
//
 
VOID
EFIAPI
PeiPcdSetSku (
  IN  UINTN  SkuId
  );
 
UINT8
EFIAPI
PeiPcdGet8 (
  IN UINTN  TokenNumber
  );
 
UINT16
EFIAPI
PeiPcdGet16 (
  IN UINTN  TokenNumber
  );
 
UINT32
EFIAPI
PeiPcdGet32 (
  IN UINTN  TokenNumber
  );
 
UINT64
EFIAPI
PeiPcdGet64 (
  IN UINTN  TokenNumber
  );
 
VOID *
EFIAPI
PeiPcdGetPtr (
  IN UINTN  TokenNumber
  );
 
BOOLEAN
EFIAPI
PeiPcdGetBool (
  IN UINTN  TokenNumber
  );
 
UINTN
EFIAPI
PeiPcdGetSize (
  IN UINTN  TokenNumber
  );
 
UINT8
EFIAPI
PeiPcdGet8Ex (
  IN CONST EFI_GUID  *Guid,
  IN UINTN           TokenNumber
  );
 
UINT16
EFIAPI
PeiPcdGet16Ex (
  IN CONST EFI_GUID  *Guid,
  IN UINTN           TokenNumber
  );
 
UINT32
EFIAPI
PeiPcdGet32Ex (
  IN CONST EFI_GUID  *Guid,
  IN UINTN           TokenNumber
  );
 
UINT64
EFIAPI
PeiPcdGet64Ex (
  IN CONST EFI_GUID  *Guid,
  IN UINTN           TokenNumber
  );
 
VOID *
EFIAPI
PeiPcdGetPtrEx (
  IN CONST EFI_GUID  *Guid,
  IN UINTN           TokenNumber
  );
 
BOOLEAN
EFIAPI
PeiPcdGetBoolEx (
  IN CONST EFI_GUID  *Guid,
  IN UINTN           TokenNumber
  );
 
UINTN
EFIAPI
PeiPcdGetSizeEx (
  IN CONST EFI_GUID  *Guid,
  IN UINTN           TokenNumber
  );
 
EFI_STATUS
EFIAPI
PeiPcdSet8 (
  IN UINTN  TokenNumber,
  IN UINT8  Value
  );
 
EFI_STATUS
EFIAPI
PeiPcdSet16 (
  IN UINTN   TokenNumber,
  IN UINT16  Value
  );
 
EFI_STATUS
EFIAPI
PeiPcdSet32 (
  IN UINTN   TokenNumber,
  IN UINT32  Value
  );
 
EFI_STATUS
EFIAPI
PeiPcdSet64 (
  IN UINTN   TokenNumber,
  IN UINT64  Value
  );
 
EFI_STATUS
EFIAPI
PeiPcdSetPtr (
  IN        UINTN  TokenNumber,
  IN OUT    UINTN  *SizeOfBuffer,
  IN        VOID   *Buffer
  );
 
EFI_STATUS
EFIAPI
PeiPcdSetBool (
  IN UINTN    TokenNumber,
  IN BOOLEAN  Value
  );
 
EFI_STATUS
EFIAPI
PeiPcdSet8Ex (
  IN CONST EFI_GUID  *Guid,
  IN UINTN           TokenNumber,
  IN UINT8           Value
  );
 
EFI_STATUS
EFIAPI
PeiPcdSet16Ex (
  IN CONST EFI_GUID  *Guid,
  IN UINTN           TokenNumber,
  IN UINT16          Value
  );
 
EFI_STATUS
EFIAPI
PeiPcdSet32Ex (
  IN CONST EFI_GUID  *Guid,
  IN UINTN           TokenNumber,
  IN UINT32          Value
  );
 
EFI_STATUS
EFIAPI
PeiPcdSet64Ex (
  IN CONST EFI_GUID  *Guid,
  IN UINTN           TokenNumber,
  IN UINT64          Value
  );
 
EFI_STATUS
EFIAPI
PeiPcdSetPtrEx (
  IN        CONST EFI_GUID  *Guid,
  IN        UINTN           TokenNumber,
  IN OUT    UINTN           *SizeOfBuffer,
  IN        VOID            *Buffer
  );
 
EFI_STATUS
EFIAPI
PeiPcdSetBoolEx (
  IN CONST EFI_GUID  *Guid,
  IN UINTN           TokenNumber,
  IN BOOLEAN         Value
  );
 
EFI_STATUS
EFIAPI
PeiRegisterCallBackOnSet (
  IN  CONST EFI_GUID    *Guid  OPTIONAL,
  IN  UINTN             TokenNumber,
  IN  PCD_PPI_CALLBACK  CallBackFunction
  );
 
EFI_STATUS
EFIAPI
PcdUnRegisterCallBackOnSet (
  IN  CONST EFI_GUID    *Guid  OPTIONAL,
  IN  UINTN             TokenNumber,
  IN  PCD_PPI_CALLBACK  CallBackFunction
  );
 
EFI_STATUS
EFIAPI
PeiPcdGetNextToken (
  IN CONST EFI_GUID  *Guid  OPTIONAL,
  IN OUT  UINTN      *TokenNumber
  );
 
EFI_STATUS
EFIAPI
PeiPcdGetNextTokenSpace (
  IN OUT CONST EFI_GUID  **Guid
  );
 
EFI_STATUS
PeiGetPcdInfo (
  IN CONST  EFI_GUID      *Guid,
  IN        UINTN         TokenNumber,
  OUT       EFI_PCD_INFO  *PcdInfo
  );
 
/* Internal Function definitions */
 
PEI_PCD_DATABASE *
GetPcdDatabase (
  VOID
  );
 
EFI_STATUS
SetValueWorker (
  IN          UINTN  TokenNumber,
  IN          VOID   *Data,
  IN          UINTN  Size
  );
 
EFI_STATUS
SetWorker (
  IN          UINTN    TokenNumber,
  IN          VOID     *Data,
  IN OUT      UINTN    *Size,
  IN          BOOLEAN  PtrType
  );
 
EFI_STATUS
ExSetValueWorker (
  IN          UINTN           ExTokenNumber,
  IN          CONST EFI_GUID  *Guid,
  IN          VOID            *Data,
  IN          UINTN           Size
  );
 
EFI_STATUS
ExSetWorker (
  IN      UINTN           ExTokenNumber,
  IN      CONST EFI_GUID  *Guid,
  IN      VOID            *Data,
  IN OUT  UINTN           *Size,
  IN      BOOLEAN         PtrType
  );
 
VOID *
GetWorker (
  IN UINTN  TokenNumber,
  IN UINTN  GetSize
  );
 
VOID *
ExGetWorker (
  IN CONST EFI_GUID  *Guid,
  IN UINTN           ExTokenNumber,
  IN UINTN           GetSize
  );
 
typedef struct {
  UINTN     TokenNumber;
  UINTN     Size;
  UINT32    LocalTokenNumberAlias;
} EX_PCD_ENTRY_ATTRIBUTE;
 
UINTN
GetExPcdTokenNumber (
  IN CONST EFI_GUID  *Guid,
  IN UINTN           ExTokenNumber
  );
 
EFI_STATUS
PeiRegisterCallBackWorker (
  IN  UINTN             TokenNumber,
  IN  CONST EFI_GUID    *Guid  OPTIONAL,
  IN  PCD_PPI_CALLBACK  CallBackFunction,
  IN  BOOLEAN           Register
  );
 
PEI_PCD_DATABASE *
BuildPcdDatabase (
  IN EFI_PEI_FILE_HANDLE  FileHandle
  );
 
UINTN
GetSizeTableIndex (
  IN    UINTN             LocalTokenNumberTableIdx,
  IN    PEI_PCD_DATABASE  *Database
  );
 
UINTN
GetPtrTypeSize (
  IN    UINTN             LocalTokenNumberTableIdx,
  OUT   UINTN             *MaxSize,
  IN    PEI_PCD_DATABASE  *Database
  );
 
BOOLEAN
SetPtrTypeSize (
  IN          UINTN             LocalTokenNumberTableIdx,
  IN    OUT   UINTN             *CurrentSize,
  IN          PEI_PCD_DATABASE  *Database
  );
 
#endif