/** @file\r
- Platform Configuration Database (PCD) Protocol defined in PI 1.2 Vol3\r
+ Platform Configuration Database (PCD) PPI defined in PI 1.2 Vol3\r
\r
- A platform database that contains a variety of current platform settings or \r
+ A platform database that contains a variety of current platform settings or\r
directives that can be accessed by a driver or application.\r
- PI PCD protocol only provide the accessing interfaces for Dynamic-Ex type PCD.\r
- \r
- Callers to this protocol must be at a TPL_APPLICATION task priority level.\r
+ PI PCD ppi only provide the accessing interfaces for Dynamic-Ex type PCD.\r
+\r
This is the base PCD service API that provides an abstraction for accessing configuration content in\r
the platform. It a seamless mechanism for extracting information regardless of where the\r
information is stored (such as in Read-only data, or an EFI Variable).\r
This protocol allows access to data through size-granular APIs and provides a mechanism for a\r
firmware component to monitor specific settings and be alerted when a setting is changed.\r
\r
- Copyright (c) 2009, 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
+ Copyright (c) 2009 - 2013, Intel Corporation. All rights reserved.<BR>\r
+ 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
+ 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
- @par Revision Reference: \r
+ @par Revision Reference:\r
PI Version 1.2 Vol 3.\r
**/\r
\r
SKU Id is set or the currently set SKU Id isn't valid for the specified token, the system uses the\r
default SKU Id. If the system attempts to use the default SKU Id and no value has been set for that\r
Id, the results are unpredictable.\r
- \r
+\r
@param[in] SkuId The SKU value to set.\r
**/\r
typedef\r
/**\r
Retrieves the current byte-sized value for a PCD token number. If the TokenNumber is invalid,\r
the results are unpredictable.\r
- \r
+\r
@param[in] Guid The 128-bit unique value that designates which namespace to extract the value from.\r
@param[in] TokenNumber The PCD token number.\r
- \r
+\r
@return 8-bit value for a given PCD token.\r
**/\r
typedef\r
UINT8\r
-(EFIAPI *EFI_PEI_PCD_PPI_GET_EX_8)(\r
+(EFIAPI *EFI_PEI_PCD_PPI_GET_8)(\r
IN CONST EFI_GUID *Guid,\r
IN UINTN TokenNumber\r
);\r
\r
/**\r
- Retrieves the current byte-sized value for a PCD token number. If the TokenNumber is invalid,\r
+ Retrieves the current word-sized value for a PCD token number. If the TokenNumber is invalid,\r
the results are unpredictable.\r
- \r
+\r
@param[in] Guid The 128-bit unique value that designates which namespace to extract the value from.\r
@param[in] TokenNumber The PCD token number.\r
- \r
+\r
@return 16-bit value for a given PCD token.\r
**/\r
typedef\r
UINT16\r
-(EFIAPI *EFI_PEI_PCD_PPI_GET_EX_16)(\r
+(EFIAPI *EFI_PEI_PCD_PPI_GET_16)(\r
IN CONST EFI_GUID *Guid,\r
IN UINTN TokenNumber\r
);\r
/**\r
Retrieves the current 32-bit value for a PCD token number. If the TokenNumber is invalid, the\r
results are unpredictable.\r
- \r
+\r
@param[in] Guid The 128-bit unique value that designates which namespace to extract the value from.\r
@param[in] TokenNumber The PCD token number.\r
- \r
- @return 32-bit value for a given PCD token. \r
+\r
+ @return 32-bit value for a given PCD token.\r
**/\r
typedef\r
UINT32\r
-(EFIAPI *EFI_PEI_PCD_PPI_GET_EX_32)(\r
+(EFIAPI *EFI_PEI_PCD_PPI_GET_32)(\r
IN CONST EFI_GUID *Guid,\r
IN UINTN TokenNumber\r
);\r
/**\r
Retrieves the current 64-bit value for a PCD token number. If the TokenNumber is invalid, the\r
results are unpredictable.\r
- \r
+\r
@param[in] Guid The 128-bit unique value that designates which namespace to extract the value from.\r
@param[in] TokenNumber The PCD token number.\r
- \r
- @return 64-bit value for a given PCD token. \r
+\r
+ @return 64-bit value for a given PCD token.\r
**/\r
typedef\r
-UINT32\r
-(EFIAPI *EFI_PEI_PCD_PPI_GET_EX_64)(\r
+UINT64\r
+(EFIAPI *EFI_PEI_PCD_PPI_GET_64)(\r
IN CONST EFI_GUID *Guid,\r
IN UINTN TokenNumber\r
);\r
Retrieves the current pointer to the value for a PCD token number. There should not be any\r
alignment assumptions about the pointer that is returned by this function call. If the TokenNumber\r
is invalid, the results are unpredictable.\r
- \r
+\r
@param[in] Guid The 128-bit unique value that designates which namespace to extract the value from.\r
@param[in] TokenNumber The PCD token number.\r
**/\r
typedef\r
VOID *\r
-(EFIAPI *EFI_PEI_PCD_PPI_GET_EX_POINTER)(\r
+(EFIAPI *EFI_PEI_PCD_PPI_GET_POINTER)(\r
IN CONST EFI_GUID *Guid,\r
IN UINTN TokenNumber\r
);\r
\r
@param[in] Guid The 128-bit unique value that designates which namespace to extract the value from.\r
@param[in] TokenNumber The PCD token number.\r
- \r
+\r
@return Boolean value for a given PCD token.\r
**/\r
typedef\r
BOOLEAN\r
-(EFIAPI *EFI_PEI_PCD_PPI_GET_EX_BOOLEAN)(\r
+(EFIAPI *EFI_PEI_PCD_PPI_GET_BOOLEAN)(\r
IN CONST EFI_GUID *Guid,\r
IN UINTN TokenNumber\r
);\r
/**\r
Retrieves the current size of a particular PCD token. If the TokenNumber is invalid, the results are\r
unpredictable.\r
- \r
+\r
@param[in] Guid The 128-bit unique value that designates which namespace to extract the value from.\r
- @param[in] TokenNumber The PCD token number. \r
- \r
+ @param[in] TokenNumber The PCD token number.\r
+\r
@return the size of the value for a given PCD token.\r
**/\r
typedef\r
UINTN\r
-(EFIAPI *EFI_PEI_PCD_PPI_GET_EX_SIZE)(\r
+(EFIAPI *EFI_PEI_PCD_PPI_GET_SIZE)(\r
IN CONST EFI_GUID *Guid,\r
IN UINTN TokenNumber\r
);\r
\r
/**\r
Sets an 8-bit value for a given PCD token.\r
- \r
+\r
When the PCD service sets a value, it will check to ensure that the size of the value being set is\r
compatible with the Token's existing definition. If it is not, an error will be returned.\r
- \r
+\r
@param[in] Guid The 128-bit unique value that designates which namespace to extract the value from.\r
- @param[in] TokenNumber The PCD token number. \r
+ @param[in] TokenNumber The PCD token number.\r
@param[in] Value The value to set for the PCD token.\r
- \r
+\r
@retval EFI_SUCCESS The PCD service has set the value requested\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data being set was\r
incompatible with a call to this function. Use GetSizeEx() to\r
retrieve the size of the target data.\r
- @retval EFI_NOT_FOUND The PCD service could not find the requested token number. \r
+ @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_PEI_PCD_PPI_SET_EX_8)(\r
+(EFIAPI *EFI_PEI_PCD_PPI_SET_8)(\r
IN CONST EFI_GUID *Guid,\r
IN UINTN TokenNumber,\r
IN UINT8 Value\r
\r
/**\r
Sets an 16-bit value for a given PCD token.\r
- \r
+\r
When the PCD service sets a value, it will check to ensure that the size of the value being set is\r
compatible with the Token's existing definition. If it is not, an error will be returned.\r
- \r
+\r
@param[in] Guid The 128-bit unique value that designates which namespace to extract the value from.\r
- @param[in] TokenNumber The PCD token number. \r
+ @param[in] TokenNumber The PCD token number.\r
@param[in] Value The value to set for the PCD token.\r
- \r
+\r
@retval EFI_SUCCESS The PCD service has set the value requested\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data being set was\r
incompatible with a call to this function. Use GetSizeEx() to\r
retrieve the size of the target data.\r
- @retval EFI_NOT_FOUND The PCD service could not find the requested token number. \r
+ @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_PEI_PCD_PPI_SET_EX_16)(\r
+(EFIAPI *EFI_PEI_PCD_PPI_SET_16)(\r
IN CONST EFI_GUID *Guid,\r
IN UINTN TokenNumber,\r
IN UINT16 Value\r
\r
/**\r
Sets an 32-bit value for a given PCD token.\r
- \r
+\r
When the PCD service sets a value, it will check to ensure that the size of the value being set is\r
compatible with the Token's existing definition. If it is not, an error will be returned.\r
- \r
+\r
@param[in] Guid The 128-bit unique value that designates which namespace to extract the value from.\r
- @param[in] TokenNumber The PCD token number. \r
+ @param[in] TokenNumber The PCD token number.\r
@param[in] Value The value to set for the PCD token.\r
- \r
+\r
@retval EFI_SUCCESS The PCD service has set the value requested\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data being set was\r
incompatible with a call to this function. Use GetSizeEx() to\r
retrieve the size of the target data.\r
- @retval EFI_NOT_FOUND The PCD service could not find the requested token number. \r
+ @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_PEI_PCD_PPI_SET_EX_32)(\r
+(EFIAPI *EFI_PEI_PCD_PPI_SET_32)(\r
IN CONST EFI_GUID *Guid,\r
IN UINTN TokenNumber,\r
IN UINT32 Value\r
\r
/**\r
Sets an 64-bit value for a given PCD token.\r
- \r
+\r
When the PCD service sets a value, it will check to ensure that the size of the value being set is\r
compatible with the Token's existing definition. If it is not, an error will be returned.\r
- \r
+\r
@param[in] Guid The 128-bit unique value that designates which namespace to extract the value from.\r
- @param[in] TokenNumber The PCD token number. \r
+ @param[in] TokenNumber The PCD token number.\r
@param[in] Value The value to set for the PCD token.\r
- \r
+\r
@retval EFI_SUCCESS The PCD service has set the value requested\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data being set was\r
incompatible with a call to this function. Use GetSizeEx() to\r
retrieve the size of the target data.\r
- @retval EFI_NOT_FOUND The PCD service could not find the requested token number. \r
+ @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_PEI_PCD_PPI_SET_EX_64)(\r
+(EFIAPI *EFI_PEI_PCD_PPI_SET_64)(\r
IN CONST EFI_GUID *Guid,\r
IN UINTN TokenNumber,\r
IN UINT64 Value\r
\r
/**\r
Sets a value of the specified size for a given PCD token.\r
- \r
+\r
When the PCD service sets a value, it will check to ensure that the size of the value being set is\r
compatible with the Token's existing definition. If it is not, an error will be returned.\r
- \r
+\r
@param[in] Guid The 128-bit unique value that designates which namespace to extract the value from.\r
- @param[in] TokenNumber The PCD token number. \r
- @param[in] SizeOfValue The length of the Value being set for the PCD token.\r
+ @param[in] TokenNumber The PCD token number.\r
+ @param[in] SizeOfValue The length of the value being set for the PCD token. If too large of a length is\r
+ specified, upon return from this function the value of SizeOfValue will reflect the\r
+ maximum size for the PCD token.\r
@param[in] Buffer A pointer to the buffer containing the value to set for the PCD token.\r
- \r
+\r
@retval EFI_SUCCESS The PCD service has set the value requested\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data being set was\r
incompatible with a call to this function. Use GetSizeEx() to\r
retrieve the size of the target data.\r
- @retval EFI_NOT_FOUND The PCD service could not find the requested token number. \r
+ @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_PEI_PCD_PPI_SET_EX_POINTER)(\r
+(EFIAPI *EFI_PEI_PCD_PPI_SET_POINTER)(\r
IN CONST EFI_GUID *Guid,\r
IN UINTN TokenNumber,\r
- IN UINTN SizeOfValue,\r
+ IN OUT UINTN *SizeOfValue,\r
IN VOID *Buffer\r
);\r
\r
/**\r
Sets a Boolean value for a given PCD token.\r
- \r
+\r
When the PCD service sets a value, it will check to ensure that the size of the value being set is\r
compatible with the Token's existing definition. If it is not, an error will be returned.\r
- \r
+\r
@param[in] Guid The 128-bit unique value that designates which namespace to extract the value from.\r
- @param[in] TokenNumber The PCD token number. \r
+ @param[in] TokenNumber The PCD token number.\r
@param[in] Value The value to set for the PCD token.\r
- \r
+\r
@retval EFI_SUCCESS The PCD service has set the value requested\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data being set was\r
incompatible with a call to this function. Use GetSizeEx() to\r
retrieve the size of the target data.\r
- @retval EFI_NOT_FOUND The PCD service could not find the requested token number. \r
+ @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_PEI_PCD_PPI_SET_EX_BOOLEAN)(\r
+(EFIAPI *EFI_PEI_PCD_PPI_SET_BOOLEAN)(\r
IN CONST EFI_GUID *Guid,\r
IN UINTN TokenNumber,\r
IN BOOLEAN Value\r
\r
typedef\r
VOID\r
-(EFIAPI *EFI_PCD_PPI_CALLBACK)(\r
- IN EFI_GUID *Guid OPTIONAL,\r
- IN UINTN CallBackToken,\r
- IN VOID *TokenData,\r
- IN UINTN TokenDatSize\r
+(EFIAPI *EFI_PEI_PCD_PPI_CALLBACK)(\r
+ IN EFI_GUID *Guid OPTIONAL,\r
+ IN UINTN CallBackToken,\r
+ IN OUT VOID *TokenData,\r
+ IN UINTN TokenDatSize\r
);\r
\r
/**\r
Specifies a function to be called anytime the value of a designated token is changed.\r
- \r
+\r
@param[in] Guid The 128-bit unique value that designates which namespace to monitor. If NULL, use\r
the standard platform namespace.\r
@param[in] CallBackToken The PCD token number to monitor.\r
\r
@retval EFI_SUCCESS The PCD service has successfully established a call event for the\r
CallBackToken requested.\r
- @retval EFI_NOT_FOUND The PCD service could not find the referenced token number. \r
+ @retval EFI_NOT_FOUND The PCD service could not find the referenced token number.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_PEI_PCD_PPI_CALLBACK_ON_SET)(\r
- IN CONST EFI_GUID *Guid OPTIONAL,\r
- IN UINTN CallBackToken,\r
- IN EFI_PCD_PPI_CALLBACK CallBackFunction\r
+ IN CONST EFI_GUID *Guid OPTIONAL,\r
+ IN UINTN CallBackToken,\r
+ IN EFI_PEI_PCD_PPI_CALLBACK CallBackFunction\r
);\r
\r
/**\r
Cancels a previously set callback function for a particular PCD token number.\r
- \r
+\r
@param[in] Guid The 128-bit unique value that designates which namespace to monitor. If NULL, use\r
the standard platform namespace.\r
@param[in] CallBackToken The PCD token number to cancel monitoring.\r
@param[in] CallBackFunction The function prototype that was originally passed to the CallBackOnSet function.\r
- \r
+\r
@retval EFI_SUCCESS The PCD service has cancelled the call event associated with the\r
CallBackToken.\r
@retval EFI_INVALID_PARAMETER The PCD service did not match the CallBackFunction to one\r
that is currently being monitored.\r
- @retval EFI_NOT_FOUND The PCD service could not find data the requested token number. \r
+ @retval EFI_NOT_FOUND The PCD service could not find data the requested token number.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_PEI_PCD_PPI_CANCEL_CALLBACK)(\r
- IN CONST EFI_GUID *Guid OPTIONAL,\r
- IN UINTN CallBackToken,\r
- IN EFI_PCD_PPI_CALLBACK CallBackFunction\r
+ IN CONST EFI_GUID *Guid OPTIONAL,\r
+ IN UINTN CallBackToken,\r
+ IN EFI_PEI_PCD_PPI_CALLBACK CallBackFunction\r
);\r
\r
/**\r
Retrieves the next valid PCD token for a given namespace.\r
- \r
+\r
This provides a means by which to get the next valid token number in a given namespace. This is\r
useful since the PCD infrastructure has a sparse list of token numbers in it, and one cannot a priori\r
know what token numbers are valid in the database.\r
- \r
+\r
@param[in] Guid The 128-bit unique value that designates which namespace to extract the value from.\r
- @param[in] TokenNumber The PCD token number. \r
- \r
+ @param[in] TokenNumber A pointer to the PCD token number to use to find the subsequent token number. To\r
+ retrieve the "first" token, have the pointer reference a TokenNumber value of 0.\r
+\r
@retval EFI_SUCCESS The PCD service has retrieved the value requested.\r
@retval EFI_NOT_FOUND The PCD service could not find data from the requested token number.\r
**/\r
\r
/**\r
Retrieves the next valid PCD token namespace for a given namespace.\r
- \r
+\r
Gets the next valid token namespace for a given namespace. This is useful to traverse the valid\r
token namespaces on a platform.\r
- \r
+\r
@param[in, out] Guid An indirect pointer to EFI_GUID. On input it designates a known token\r
namespace from which the search will start. On output, it designates the next valid\r
token namespace on the platform. If *Guid is NULL, then the GUID of the first token\r
space of the current platform is returned. If the search cannot locate the next valid\r
token namespace, an error is returned and the value of *Guid is undefined.\r
- \r
+\r
@retval EFI_SUCCESS The PCD service retrieved the value requested.\r
- @retval EFI_NOT_FOUND The PCD service could not find the next valid token namespace. \r
+ @retval EFI_NOT_FOUND The PCD service could not find the next valid token namespace.\r
**/\r
typedef\r
EFI_STATUS\r
\r
typedef struct {\r
EFI_PEI_PCD_PPI_SET_SKU SetSku;\r
- EFI_PEI_PCD_PPI_GET_EX_8 GetEx8;\r
- EFI_PEI_PCD_PPI_GET_EX_16 GetEx16;\r
- EFI_PEI_PCD_PPI_GET_EX_32 GetEx32;\r
- EFI_PEI_PCD_PPI_GET_EX_64 GetEx64;\r
- EFI_PEI_PCD_PPI_GET_EX_POINTER GetExPtr;\r
- EFI_PEI_PCD_PPI_GET_EX_BOOLEAN GetExBool;\r
- EFI_PEI_PCD_PPI_GET_EX_SIZE GetExSize;\r
- EFI_PEI_PCD_PPI_SET_EX_8 SetEx8;\r
- EFI_PEI_PCD_PPI_SET_EX_16 SetEx16;\r
- EFI_PEI_PCD_PPI_SET_EX_32 SetEx32;\r
- EFI_PEI_PCD_PPI_SET_EX_64 SetEx64;\r
- EFI_PEI_PCD_PPI_SET_EX_POINTER SetExPtr;\r
- EFI_PEI_PCD_PPI_SET_EX_BOOLEAN SetExBool;\r
+ EFI_PEI_PCD_PPI_GET_8 Get8;\r
+ EFI_PEI_PCD_PPI_GET_16 Get16;\r
+ EFI_PEI_PCD_PPI_GET_32 Get32;\r
+ EFI_PEI_PCD_PPI_GET_64 Get64;\r
+ EFI_PEI_PCD_PPI_GET_POINTER GetPtr;\r
+ EFI_PEI_PCD_PPI_GET_BOOLEAN GetBool;\r
+ EFI_PEI_PCD_PPI_GET_SIZE GetSize;\r
+ EFI_PEI_PCD_PPI_SET_8 Set8;\r
+ EFI_PEI_PCD_PPI_SET_16 Set16;\r
+ EFI_PEI_PCD_PPI_SET_32 Set32;\r
+ EFI_PEI_PCD_PPI_SET_64 Set64;\r
+ EFI_PEI_PCD_PPI_SET_POINTER SetPtr;\r
+ EFI_PEI_PCD_PPI_SET_BOOLEAN SetBool;\r
EFI_PEI_PCD_PPI_CALLBACK_ON_SET CallbackOnSet;\r
EFI_PEI_PCD_PPI_CANCEL_CALLBACK CancelCallback;\r
EFI_PEI_PCD_PPI_GET_NEXT_TOKEN GetNextToken;\r
projects / mirror_edk2.git / blobdiff