Initial import.

[mirror_edk2.git] / MdePkg / Include / Ppi / 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
extern EFI_GUID gPcdPpiGuid;\r
\r
#define PCD_PPI_GUID \\r
  { 0x632df884, 0x8023, 0x4872, { 0xb6, 0x70, 0xb7, 0x4a, 0x30, 0x19, 0x16, 0xe9 } }\r
\r
typedef \r
EFI_STATUS\r
(EFIAPI *PCD_PPI_SET_SKU) (\r
  IN  UINTN          SkuId\r
  );\r
\r
typedef\r
UINT8\r
(EFIAPI *PCD_PPI_GET8) (\r
  IN UINTN  TokenNumber\r
  );\r
\r
typedef\r
UINT16\r
(EFIAPI *PCD_PPI_GET16) (\r
  IN UINTN  TokenNumber\r
  );\r
\r
typedef\r
UINT32\r
(EFIAPI *PCD_PPI_GET32) (\r
  IN UINTN  TokenNumber\r
  );\r
\r
typedef\r
UINT64\r
(EFIAPI *PCD_PPI_GET64) (\r
  IN UINTN  TokenNumber\r
  );\r
\r
typedef\r
VOID *\r
(EFIAPI *PCD_PPI_GET_POINTER) (\r
  IN UINTN  TokenNumber\r
  );\r
\r
typedef\r
BOOLEAN\r
(EFIAPI *PCD_PPI_GET_BOOLEAN) (\r
  IN UINTN  TokenNumber\r
  );\r
\r
typedef\r
UINTN\r
(EFIAPI *PCD_PPI_GET_SIZE) (\r
  IN UINTN  TokenNumber\r
  );\r
\r
typedef\r
UINT8\r
(EFIAPI *PCD_PPI_GET_EX_8) (\r
  IN CONST EFI_GUID    *Guid,\r
  IN UINTN             TokenNumber\r
  );\r
\r
typedef\r
UINT16\r
(EFIAPI *PCD_PPI_GET_EX_16) (\r
  IN CONST EFI_GUID    *Guid,\r
  IN UINTN              TokenNumber\r
  );\r
\r
typedef\r
UINT32\r
(EFIAPI *PCD_PPI_GET_EX_32) (\r
  IN CONST EFI_GUID    *Guid,\r
  IN UINTN             TokenNumber\r
  );\r
\r
typedef\r
UINT64\r
(EFIAPI *PCD_PPI_GET_EX_64) (\r
  IN CONST EFI_GUID    *Guid,\r
  IN UINTN             TokenNumber\r
  );\r
\r
typedef\r
VOID *\r
(EFIAPI *PCD_PPI_GET_EX_POINTER) (\r
  IN CONST EFI_GUID    *Guid,\r
  IN UINTN             TokenNumber\r
  );\r
\r
typedef\r
BOOLEAN\r
(EFIAPI *PCD_PPI_GET_EX_BOOLEAN) (\r
  IN CONST EFI_GUID    *Guid,\r
  IN UINTN             TokenNumber\r
  );\r
\r
typedef\r
UINTN\r
(EFIAPI *PCD_PPI_GET_EX_SIZE) (\r
  IN CONST EFI_GUID    *Guid,\r
  IN UINTN             TokenNumber\r
  );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *PCD_PPI_SET8) (\r
  IN UINTN             TokenNumber,\r
  IN UINT8             Value\r
  );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *PCD_PPI_SET16) (\r
  IN UINTN              TokenNumber,\r
  IN UINT16             Value\r
  );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *PCD_PPI_SET32) (\r
  IN UINTN             TokenNumber,\r
  IN UINT32            Value\r
  );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *PCD_PPI_SET64) (\r
  IN UINTN             TokenNumber,\r
  IN UINT64            Value\r
  );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *PCD_PPI_SET_POINTER) (\r
  IN UINTN             TokenNumber,\r
  IN CONST VOID        *Value\r
  );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *PCD_PPI_SET_BOOLEAN) (\r
  IN UINTN             TokenNumber,\r
  IN BOOLEAN           Value\r
  );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *PCD_PPI_SET_EX_8) (\r
  IN CONST EFI_GUID    *Guid,\r
  IN UINTN             TokenNumber,\r
  IN UINT8             Value\r
  );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *PCD_PPI_SET_EX_16) (\r
  IN CONST EFI_GUID    *Guid,\r
  IN UINTN             TokenNumber,\r
  IN UINT16            Value\r
  );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *PCD_PPI_SET_EX_32) (\r
  IN CONST EFI_GUID    *Guid,\r
  IN UINTN             TokenNumber,\r
  IN UINT32            Value\r
  );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *PCD_PPI_SET_EX_64) (\r
  IN CONST EFI_GUID    *Guid,\r
  IN UINTN             TokenNumber,\r
  IN UINT64            Value\r
  );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *PCD_PPI_SET_EX_POINTER) (\r
  IN CONST EFI_GUID    *Guid,\r
  IN UINTN             TokenNumber,\r
  IN CONST VOID        *Value\r
  );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *PCD_PPI_SET_EX_BOOLEAN) (\r
  IN CONST EFI_GUID    *Guid,\r
  IN UINTN             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_PPI_CALLBACK) (\r
  IN  CONST EFI_GUID   *CallBackGuid, OPTIONAL\r
  IN  UINTN            CallBackToken,\r
  IN  VOID             *TokenData,\r
  IN  UINTN            TokenDataSize\r
  );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *PCD_PPI_CALLBACK_ONSET) (\r
  IN  UINTN                  TokenNumber,\r
  IN  CONST EFI_GUID         *Guid, OPTIONAL\r
  IN  PCD_PPI_CALLBACK       CallBackFunction\r
  );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *PCD_PPI_CANCEL_CALLBACK) (\r
  IN  UINTN                   TokenNumber,\r
  IN  CONST EFI_GUID          *Guid, OPTIONAL\r
  IN  PCD_PPI_CALLBACK        CallBackFunction\r
  );\r
\r
typedef \r
EFI_STATUS\r
(EFIAPI *PCD_PPI_GET_NEXT_TOKEN) (\r
  IN CONST EFI_GUID           *Guid, OPTIONAL\r
  IN OUT  UINTN               *TokenNumber\r
  );\r
\r
typedef struct {\r
  PCD_PPI_SET_SKU              SetSku;\r
\r
  PCD_PPI_GET8                 Get8;\r
  PCD_PPI_GET16                Get16;\r
  PCD_PPI_GET32                Get32;\r
  PCD_PPI_GET64                Get64;\r
  PCD_PPI_GET_POINTER          GetPtr;\r
  PCD_PPI_GET_BOOLEAN          GetBool;\r
  PCD_PPI_GET_SIZE             GetSize;\r
\r
  PCD_PPI_GET_EX_8             Get8Ex;\r
  PCD_PPI_GET_EX_16            Get16Ex;\r
  PCD_PPI_GET_EX_32            Get32Ex;\r
  PCD_PPI_GET_EX_64            Get64Ex;\r
  PCD_PPI_GET_EX_POINTER       GetPtrEx;\r
  PCD_PPI_GET_EX_BOOLEAN       GetBoolEx;\r
  PCD_PPI_GET_EX_SIZE          GetSizeEx;\r
\r
  PCD_PPI_SET8                 Set8;\r
  PCD_PPI_SET16                Set16;\r
  PCD_PPI_SET32                Set32;\r
  PCD_PPI_SET64                Set64;\r
  PCD_PPI_SET_POINTER          SetPtr;\r
  PCD_PPI_SET_BOOLEAN          SetBool;\r
\r
  PCD_PPI_SET_EX_8             Set8Ex;\r
  PCD_PPI_SET_EX_16            Set16Ex;\r
  PCD_PPI_SET_EX_32            Set32Ex;\r
  PCD_PPI_SET_EX_64            Set64Ex;\r
  PCD_PPI_SET_EX_POINTER       SetPtrEx;\r
  PCD_PPI_SET_EX_BOOLEAN       SetBoolEx;\r
\r
  PCD_PPI_CALLBACK_ONSET       CallbackOnSet;\r
  PCD_PPI_CANCEL_CALLBACK      CancelCallback;\r
  PCD_PPI_GET_NEXT_TOKEN       GetNextToken;\r
} PCD_PPI;\r
\r
\r
#endif\r