/** @file\r
Platform Configuration Database (PCD) Protocol\r
\r
- Copyright (c) 2006, Intel Corporation \r
+ Copyright (c) 2006 - 2008, 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
#ifndef __PCD_H__\r
#define __PCD_H__\r
\r
-#include <PiDxe.h>\r
-\r
extern EFI_GUID gPcdProtocolGuid;\r
\r
#define PCD_PROTOCOL_GUID \\r
set for that Id, the results are unpredictable.\r
\r
@param[in] SkuId The SKU value that will be used when the PCD service will retrieve and \r
- set values associated with a PCD token.\r
+ set values associated with a PCD token.\r
\r
@retval VOID\r
\r
specified by Guid does not exist, the results are \r
unpredictable.\r
\r
- @param[in] Guid The token space for the token number.\r
+ @param[in] Guid The token space for the token number.\r
@param[in] TokenNumber The PCD token number. \r
\r
@return The size 8-bit value for the PCD token.\r
specified by Guid does not exist, the results are \r
unpredictable.\r
\r
- @param[in] Guid The token space for the token number.\r
+ @param[in] Guid The token space for the token number.\r
@param[in] TokenNumber The PCD token number. \r
\r
@return The size 16-bit value for the PCD token.\r
specified by Guid does not exist, the results are \r
unpredictable.\r
\r
- @param[in] Guid The token space for the token number.\r
+ @param[in] Guid The token space for the token number.\r
@param[in] TokenNumber The PCD token number. \r
\r
@return The size 32-bit value for the PCD token.\r
\r
-**/typedef\r
+**/\r
+typedef\r
UINT32\r
(EFIAPI *PCD_PROTOCOL_GET_EX_32)(\r
IN CONST EFI_GUID *Guid,\r
specified by Guid does not exist, the results are \r
unpredictable.\r
\r
- @param[in] Guid The token space for the token number.\r
+ @param[in] Guid The token space for the token number.\r
@param[in] TokenNumber The PCD token number. \r
\r
@return The size 64-bit value for the PCD token.\r
is returned by this function call. If the TokenNumber is invalid, \r
the results are unpredictable.\r
\r
- @param[in] Guid The token space for the token number.\r
+ @param[in] Guid The token space for the token number.\r
@param[in] TokenNumber The PCD token number. \r
\r
@return The pointer to the buffer to be retrived.\r
specified by Guid does not exist, the results are \r
unpredictable.\r
\r
- @param[in] Guid The token space for the token number.\r
+ @param[in] Guid The token space for the token number.\r
@param[in] TokenNumber The PCD token number. \r
\r
@return The size Boolean value for the PCD token.\r
Retrieves the current size of a particular PCD token. \r
If the TokenNumber is invalid, the results are unpredictable.\r
\r
- @param[in] Guid The token space for the token number.\r
+ @param[in] Guid The token space for the token number.\r
@param[in] TokenNumber The PCD token number. \r
\r
@return The size of the value for the PCD token.\r
If it is not, an error will be returned.\r
\r
@param[in] TokenNumber The PCD token number. \r
- @param[in] Value The value to set for the PCD token.\r
+ @param[in] Value The value to set for the PCD token.\r
\r
@retval EFI_SUCCESS Procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
If it is not, an error will be returned.\r
\r
@param[in] TokenNumber The PCD token number. \r
- @param[in] Value The value to set for the PCD token.\r
+ @param[in] Value The value to set for the PCD token.\r
\r
@retval EFI_SUCCESS Procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
If it is not, an error will be returned.\r
\r
@param[in] TokenNumber The PCD token number. \r
- @param[in] Value The value to set for the PCD token.\r
+ @param[in] Value The value to set for the PCD token.\r
\r
@retval EFI_SUCCESS Procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
If it is not, an error will be returned.\r
\r
@param[in] TokenNumber The PCD token number. \r
- @param[in] Value The value to set for the PCD token.\r
+ @param[in] Value The value to set for the PCD token.\r
\r
@retval EFI_SUCCESS Procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
size of the value being set is compatible with the Token's existing definition. \r
If it is not, an error will be returned.\r
\r
- @param[in] TokenNumber The PCD token number. \r
+ @param[in] TokenNumber The PCD token number. \r
@param[in, out] SizeOfBuffer A pointer to the length of the value being set for the PCD token. \r
- On input, if the SizeOfValue is greater than the maximum size supported \r
- for this TokenNumber then the output value of SizeOfValue will reflect \r
- the maximum size supported for this TokenNumber.\r
- @param[in] Buffer The buffer to set for the PCD token.\r
+ On input, if the SizeOfValue is greater than the maximum size supported \r
+ for this TokenNumber then the output value of SizeOfValue will reflect \r
+ the maximum size supported for this TokenNumber.\r
+ @param[in] Buffer The buffer to set for the PCD token.\r
\r
@retval EFI_SUCCESS Procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
If it is not, an error will be returned.\r
\r
@param[in] TokenNumber The PCD token number. \r
- @param[in] Value The value to set for the PCD token.\r
+ @param[in] Value The value to set for the PCD token.\r
\r
@retval EFI_SUCCESS Procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
size of the value being set is compatible with the Token's existing definition. \r
If it is not, an error will be returned.\r
\r
- @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
+ @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
@param[in] TokenNumber The PCD token number. \r
- @param[in] Value The value to set for the PCD token.\r
+ @param[in] Value The value to set for the PCD token.\r
\r
@retval EFI_SUCCESS Procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
size of the value being set is compatible with the Token's existing definition. \r
If it is not, an error will be returned.\r
\r
- @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
+ @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
@param[in] TokenNumber The PCD token number. \r
- @param[in] Value The value to set for the PCD token.\r
+ @param[in] Value The value to set for the PCD token.\r
\r
@retval EFI_SUCCESS Procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
size of the value being set is compatible with the Token's existing definition. \r
If it is not, an error will be returned.\r
\r
- @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
+ @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
@param[in] TokenNumber The PCD token number. \r
- @param[in] Value The value to set for the PCD token.\r
+ @param[in] Value The value to set for the PCD token.\r
\r
@retval EFI_SUCCESS Procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
size of the value being set is compatible with the Token's existing definition. \r
If it is not, an error will be returned.\r
\r
- @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
+ @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
@param[in] TokenNumber The PCD token number. \r
- @param[in] Value The value to set for the PCD token.\r
+ @param[in] Value The value to set for the PCD token.\r
\r
@retval EFI_SUCCESS Procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
size of the value being set is compatible with the Token's existing definition. \r
If it is not, an error will be returned.\r
\r
- @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
- @param[in] TokenNumber The PCD token number. \r
+ @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
+ @param[in] TokenNumber The PCD token number. \r
@param[in, out] SizeOfBuffer A pointer to the length of the value being set for the PCD token. \r
On input, if the SizeOfValue is greater than the maximum size supported \r
for this TokenNumber then the output value of SizeOfValue will reflect \r
the maximum size supported for this TokenNumber.\r
- @param[in] Buffer The buffer to set for the PCD token.\r
+ @param[in] Buffer The buffer to set for the PCD token.\r
\r
@retval EFI_SUCCESS Procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
typedef\r
EFI_STATUS\r
(EFIAPI *PCD_PROTOCOL_SET_EX_POINTER)(\r
- IN CONST EFI_GUID *Guid,\r
- IN UINTN TokenNumber,\r
- IN OUT UINTN *SizeOfBuffer,\r
- IN VOID *Buffer\r
+ IN CONST EFI_GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN OUT UINTN *SizeOfBuffer,\r
+ IN VOID *Buffer\r
);\r
\r
\r
size of the value being set is compatible with the Token's existing definition. \r
If it is not, an error will be returned.\r
\r
- @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
+ @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
@param[in] TokenNumber The PCD token number. \r
- @param[in] Value The value to set for the PCD token.\r
+ @param[in] Value The value to set for the PCD token.\r
\r
@retval EFI_SUCCESS Procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
TokenData will be used by PCD service DXE driver to modify the internal data in \r
PCD database.\r
\r
- @param[in] CallBackGuid The PCD token GUID being set.\r
- @param[in] CallBackToken The PCD token number being set.\r
- @param[in, out] TokenData A pointer to the token data being set.\r
- @param[in] TokenDataSize The size, in bytes, of the data being set.\r
+ @param[in] CallBackGuid The PCD token GUID being set.\r
+ @param[in] CallBackToken The PCD token number being set.\r
+ @param[in, out] 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
typedef\r
VOID\r
(EFIAPI *PCD_PROTOCOL_CALLBACK)(\r
- IN CONST EFI_GUID *CallBackGuid, OPTIONAL\r
- IN UINTN CallBackToken,\r
- IN OUT VOID *TokenData,\r
- IN UINTN TokenDataSize\r
+ IN CONST EFI_GUID *CallBackGuid, OPTIONAL\r
+ IN UINTN CallBackToken,\r
+ IN OUT VOID *TokenData,\r
+ IN UINTN TokenDataSize\r
);\r
\r
\r
/**\r
Specifies a function to be called anytime the value of a designated token is changed.\r
\r
- @param[in] TokenNumber The PCD token number. \r
- @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
- @param[in] CallBackFunction The function prototype called when the value associated with the CallBackToken is set. \r
+ @param[in] TokenNumber The PCD token number. \r
+ @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
+ @param[in] CallBackFunction The function prototype called when the value associated with the CallBackToken is set. \r
\r
- @retval EFI_SUCCESS The PCD service has successfully established a call event \r
+ @retval EFI_SUCCESS The PCD service has successfully established a call event \r
for the CallBackToken requested.\r
@retval EFI_NOT_FOUND The PCD service could not find the referenced token number.\r
\r
/**\r
Cancels a previously set callback function for a particular PCD token number.\r
\r
- @param[in] TokenNumber The PCD token number. \r
- @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
+ @param[in] TokenNumber The PCD token number. \r
+ @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
@param[in] CallBackFunction The function prototype called when the value associated with the CallBackToken is set. \r
\r
- @retval EFI_SUCCESS The PCD service has successfully established a call event \r
+ @retval EFI_SUCCESS The PCD service has successfully established a call event \r
for the CallBackToken requested.\r
@retval EFI_NOT_FOUND The PCD service could not find the referenced token number.\r
\r
\r
\r
/**\r
- Retrieves the next valid PCD token for a given namespace.\r
+ Retrieves the next valid token number in a given namespace. \r
+ \r
+ This is useful since the PCD infrastructure contains a sparse list of token numbers, \r
+ and one cannot a priori know what token numbers are valid in the database. \r
+ \r
+ If TokenNumber is 0 and Guid is not NULL, then the first token from the token space specified by Guid is returned. \r
+ If TokenNumber is not 0 and Guid is not NULL, then the next token in the token space specified by Guid is returned. \r
+ If TokenNumber is 0 and Guid is NULL, then the first token in the default token space is returned. \r
+ If TokenNumber is not 0 and Guid is NULL, then the next token in the default token space is returned. \r
+ The token numbers in the default token space may not be related to token numbers in token spaces that are named by Guid. \r
+ If the next token number can be retrieved, then it is returned in TokenNumber, and EFI_SUCCESS is returned. \r
+ If TokenNumber represents the last token number in the token space specified by Guid, then EFI_NOT_FOUND is returned. \r
+ If TokenNumber is not present in the token space specified by Guid, then EFI_NOT_FOUND is returned.\r
+\r
\r
- @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
- @param[in,out] TokenNumber A pointer to the PCD token number to use to find the subsequent token number. \r
- If the input token namespace or token number does not exist on the platform, \r
- an error is returned and the value of *TokenNumber is undefined. To retrieve the "first" token, \r
- have the pointer reference a TokenNumber value of 0. If the input token number is 0 and \r
- there is no valid token number for this token namespace, *TokenNumber will be assigned to \r
- 0 and the function return EFI_SUCCESS. If the token number is the last valid token number, \r
- *TokenNumber will be assigned to 0 and the function return EFI_SUCCESS.\r
+ @param[in] Guid The 128-bit unique value that designates the namespace from which to retrieve the next token. \r
+ This is an optional parameter that may be NULL. If this parameter is NULL, then a request is \r
+ being made to retrieve tokens from the default token space.\r
+ @param[in,out] TokenNumber \r
+ A pointer to the PCD token number to use to find the subsequent token number. \r
\r
- @retval EFI_SUCCESS The PCD service retrieved the next valid token number. Or the input token number \r
+ @retval EFI_SUCCESS The PCD service retrieved the next valid token number. Or the input token number \r
is already the last valid token number in the PCD database. \r
In the later case, *TokenNumber is updated with the value of 0.\r
@retval EFI_NOT_FOUND If this input token number and token namespace does not exist on the platform.\r
Retrieves the next valid PCD token namespace for a given namespace.\r
\r
@param[in, out] Guid An indirect pointer to EFI_GUID. On input it designates \r
- a known token namespace from which the search will start. On output, \r
- it designates the next valid token namespace on the platform. If the input \r
- token namespace does not exist on the platform, an error is returned and \r
- the value of *Guid is undefined. If *Guid is NULL, then the GUID of the \r
- first token space of the current platform is assigned to *Guid the function \r
- return EFI_SUCCESS. If *Guid is NULL and there is no namespace exist in \r
- the platform other than the default (NULL) tokennamespace, *Guid is unchanged \r
- and the function return EFI_SUCCESS. If this input token namespace is the last \r
- namespace on the platform, *Guid will be assigned to NULL and the function return \r
- EFI_SUCCESS. \r
+ a known token namespace from which the search will start. On output, \r
+ it designates the next valid token namespace on the platform. If the input \r
+ token namespace does not exist on the platform, an error is returned and \r
+ the value of *Guid is undefined. If *Guid is NULL, then the GUID of the \r
+ first token space of the current platform is assigned to *Guid the function \r
+ return EFI_SUCCESS. If *Guid is NULL and there is no namespace exist in \r
+ the platform other than the default (NULL) tokennamespace, *Guid is unchanged \r
+ and the function return EFI_SUCCESS. If this input token namespace is the last \r
+ namespace on the platform, *Guid will be assigned to NULL and the function return \r
+ EFI_SUCCESS. \r
\r
@retval EFI_SUCCESS The PCD service retrieved the next valid token space Guid. \r
Or the input token space Guid is already the last valid token space Guid \r
IN OUT CONST EFI_GUID **Guid\r
);\r
\r
-\r
-\r
-//\r
-// Interface structure for the PCD Protocol\r
-//\r
+///\r
+/// This service abstracts the ability to set/get Platform Configuration Database (PCD).\r
+///\r
typedef struct {\r
PCD_PROTOCOL_SET_SKU SetSku;\r
\r
projects / mirror_edk2.git / blobdiff