Sync up Pcd Library Instances and PCD Driver/PEIM with Pcd spec 0.51 and Mde 0.51

[mirror_edk2.git] / MdePkg / Include / Protocol / Pcd.h

/** @file\r
  Platform Configuration Database (PCD) Protocol\r
\r
  Copyright (c) 2006, Intel Corporation                                                         \r
  All rights reserved. This program and the accompanying materials                          \r
  are licensed and made available under the terms and conditions of the BSD License         \r
  which accompanies this distribution.  The full text of the license may be found at        \r
  http://opensource.org/licenses/bsd-license.php                                            \r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
  Module Name:  Pcd.h\r
\r
**/\r
\r
#ifndef __PCD_H__\r
#define __PCD_H__\r
\r
#include <Common/Pcd.h>\r
\r
extern EFI_GUID gPcdProtocolGuid;\r
\r
#define PCD_PROTOCOL_GUID \\r
  { 0x11b34006, 0xd85b, 0x4d0a, { 0xa2, 0x90, 0xd5, 0xa5, 0x71, 0x31, 0xe, 0xf7 } }\r
\r
typedef \r
VOID\r
(EFIAPI *PCD_PROTOCOL_SET_SKU) (\r
  IN  SKU_ID                  SkuId\r
  );\r
\r
typedef\r
UINT8\r
(EFIAPI *PCD_PROTOCOL_GET8) (\r
  IN PCD_TOKEN_NUMBER  TokenNumber\r
  );\r
\r
typedef\r
UINT16\r
(EFIAPI *PCD_PROTOCOL_GET16) (\r
  IN PCD_TOKEN_NUMBER  TokenNumber\r
  );\r
\r
typedef\r
UINT32\r
(EFIAPI *PCD_PROTOCOL_GET32) (\r
  IN PCD_TOKEN_NUMBER  TokenNumber\r
  );\r
\r
typedef\r
UINT64\r
(EFIAPI *PCD_PROTOCOL_GET64) (\r
  IN PCD_TOKEN_NUMBER  TokenNumber\r
  );\r
\r
typedef\r
VOID *\r
(EFIAPI *PCD_PROTOCOL_GET_POINTER) (\r
  IN PCD_TOKEN_NUMBER  TokenNumber\r
  );\r
\r
typedef\r
BOOLEAN\r
(EFIAPI *PCD_PROTOCOL_GET_BOOLEAN) (\r
  IN PCD_TOKEN_NUMBER  TokenNumber\r
  );\r
\r
typedef\r
UINTN\r
(EFIAPI *PCD_PROTOCOL_GET_SIZE) (\r
  IN PCD_TOKEN_NUMBER  TokenNumber\r
  );\r
\r
typedef\r
UINT8\r
(EFIAPI *PCD_PROTOCOL_GET_EX_8) (\r
  IN CONST EFI_GUID    *Guid,\r
  IN PCD_TOKEN_NUMBER  TokenNumber\r
  );\r
\r
typedef\r
UINT16\r
(EFIAPI *PCD_PROTOCOL_GET_EX_16) (\r
  IN CONST EFI_GUID    *Guid,\r
  IN PCD_TOKEN_NUMBER  TokenNumber\r
  );\r
\r
typedef\r
UINT32\r
(EFIAPI *PCD_PROTOCOL_GET_EX_32) (\r
  IN CONST EFI_GUID    *Guid,\r
  IN PCD_TOKEN_NUMBER  TokenNumber\r
  );\r
\r
typedef\r
UINT64\r
(EFIAPI *PCD_PROTOCOL_GET_EX_64) (\r
  IN CONST EFI_GUID    *Guid,\r
  IN PCD_TOKEN_NUMBER  TokenNumber\r
  );\r
\r
typedef\r
VOID *\r
(EFIAPI *PCD_PROTOCOL_GET_EX_POINTER) (\r
  IN CONST EFI_GUID    *Guid,\r
  IN PCD_TOKEN_NUMBER  TokenNumber\r
  );\r
\r
typedef\r
BOOLEAN\r
(EFIAPI *PCD_PROTOCOL_GET_EX_BOOLEAN) (\r
  IN CONST EFI_GUID    *Guid,\r
  IN PCD_TOKEN_NUMBER  TokenNumber\r
  );\r
\r
typedef\r
UINTN\r
(EFIAPI *PCD_PROTOCOL_GET_EX_SIZE) (\r
  IN CONST EFI_GUID    *Guid,\r
  IN PCD_TOKEN_NUMBER  TokenNumber\r
  );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *PCD_PROTOCOL_SET8) (\r
  IN PCD_TOKEN_NUMBER  TokenNumber,\r
  IN UINT8             Value\r
  );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *PCD_PROTOCOL_SET16) (\r
  IN PCD_TOKEN_NUMBER   TokenNumber,\r
  IN UINT16             Value\r
  );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *PCD_PROTOCOL_SET32) (\r
  IN PCD_TOKEN_NUMBER   TokenNumber,\r
  IN UINT32             Value\r
  );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *PCD_PROTOCOL_SET64) (\r
  IN PCD_TOKEN_NUMBER  TokenNumber,\r
  IN UINT64            Value\r
  );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *PCD_PROTOCOL_SET_POINTER) (\r
  IN PCD_TOKEN_NUMBER  TokenNumber,\r
  IN UINTN             SizeOfBuffer,\r
  IN VOID              *Buffer\r
  );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *PCD_PROTOCOL_SET_BOOLEAN) (\r
  IN PCD_TOKEN_NUMBER  TokenNumber,\r
  IN BOOLEAN           Value\r
  );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *PCD_PROTOCOL_SET_EX_8) (\r
  IN CONST EFI_GUID    *Guid,\r
  IN PCD_TOKEN_NUMBER  TokenNumber,\r
  IN UINT8             Value\r
  );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *PCD_PROTOCOL_SET_EX_16) (\r
  IN CONST EFI_GUID    *Guid,\r
  IN PCD_TOKEN_NUMBER  TokenNumber,\r
  IN UINT16            Value\r
  );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *PCD_PROTOCOL_SET_EX_32) (\r
  IN CONST EFI_GUID     *Guid,\r
  IN PCD_TOKEN_NUMBER   TokenNumber,\r
  IN UINT32             Value\r
  );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *PCD_PROTOCOL_SET_EX_64) (\r
  IN CONST EFI_GUID    *Guid,\r
  IN PCD_TOKEN_NUMBER  TokenNumber,\r
  IN UINT64            Value\r
  );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *PCD_PROTOCOL_SET_EX_POINTER) (\r
  IN CONST EFI_GUID    *Guid,\r
  IN PCD_TOKEN_NUMBER  TokenNumber,\r
  IN UINTN             SizeOfBuffer,\r
  IN VOID              *Buffer\r
  );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *PCD_PROTOCOL_SET_EX_BOOLEAN) (\r
  IN CONST EFI_GUID    *Guid,\r
  IN PCD_TOKEN_NUMBER  TokenNumber,\r
  IN BOOLEAN           Value\r
  );\r
  \r
/**\r
  Callback on SET function prototype definition.\r
\r
  @param[in]  CallBackGuid The PCD token GUID being set.\r
  @param[in]  CallBackToken The PCD token number being set.\r
  @param[in]  TokenData A pointer to the token data being set.\r
  @param[in]  TokenDataSize The size, in bytes, of the data being set.\r
\r
  @retval VOID\r
\r
--*/\r
typedef\r
VOID\r
(EFIAPI *PCD_PROTOCOL_CALLBACK) (\r
  IN      CONST EFI_GUID   *CallBackGuid, OPTIONAL\r
  IN      PCD_TOKEN_NUMBER            CallBackToken,\r
  IN  OUT VOID             *TokenData,\r
  IN      UINTN            TokenDataSize\r
  );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *PCD_PROTOCOL_CALLBACK_ONSET) (\r
  IN  PCD_TOKEN_NUMBER        TokenNumber,\r
  IN  CONST EFI_GUID          *Guid, OPTIONAL\r
  IN  PCD_PROTOCOL_CALLBACK   CallBackFunction\r
  );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *PCD_PROTOCOL_CANCEL_CALLBACK) (\r
  IN  PCD_TOKEN_NUMBER        TokenNumber,\r
  IN  CONST EFI_GUID          *Guid, OPTIONAL\r
  IN  PCD_PROTOCOL_CALLBACK   CallBackFunction\r
  );\r
\r
typedef \r
EFI_STATUS\r
(EFIAPI *PCD_PROTOCOL_GET_NEXT_TOKEN) (\r
  IN      CONST EFI_GUID      *Guid, OPTIONAL\r
  IN OUT  PCD_TOKEN_NUMBER    *TokenNumber\r
  );\r
\r
typedef struct {\r
  PCD_PROTOCOL_SET_SKU              SetSku;\r
\r
  PCD_PROTOCOL_GET8                 Get8;\r
  PCD_PROTOCOL_GET16                Get16;\r
  PCD_PROTOCOL_GET32                Get32;\r
  PCD_PROTOCOL_GET64                Get64;\r
  PCD_PROTOCOL_GET_POINTER          GetPtr;\r
  PCD_PROTOCOL_GET_BOOLEAN          GetBool;\r
  PCD_PROTOCOL_GET_SIZE             GetSize;\r
\r
  PCD_PROTOCOL_GET_EX_8             Get8Ex;\r
  PCD_PROTOCOL_GET_EX_16            Get16Ex;\r
  PCD_PROTOCOL_GET_EX_32            Get32Ex;\r
  PCD_PROTOCOL_GET_EX_64            Get64Ex;\r
  PCD_PROTOCOL_GET_EX_POINTER       GetPtrEx;\r
  PCD_PROTOCOL_GET_EX_BOOLEAN       GetBoolEx;\r
  PCD_PROTOCOL_GET_EX_SIZE          GetSizeEx;\r
\r
  PCD_PROTOCOL_SET8                 Set8;\r
  PCD_PROTOCOL_SET16                Set16;\r
  PCD_PROTOCOL_SET32                Set32;\r
  PCD_PROTOCOL_SET64                Set64;\r
  PCD_PROTOCOL_SET_POINTER          SetPtr;\r
  PCD_PROTOCOL_SET_BOOLEAN          SetBool;\r
\r
  PCD_PROTOCOL_SET_EX_8             Set8Ex;\r
  PCD_PROTOCOL_SET_EX_16            Set16Ex;\r
  PCD_PROTOCOL_SET_EX_32            Set32Ex;\r
  PCD_PROTOCOL_SET_EX_64            Set64Ex;\r
  PCD_PROTOCOL_SET_EX_POINTER       SetPtrEx;\r
  PCD_PROTOCOL_SET_EX_BOOLEAN       SetBoolEx;\r
\r
  PCD_PROTOCOL_CALLBACK_ONSET       CallbackOnSet;\r
  PCD_PROTOCOL_CANCEL_CALLBACK      CancelCallback;\r
  PCD_PROTOCOL_GET_NEXT_TOKEN       GetNextToken;\r
} PCD_PROTOCOL;\r
\r
#endif\r