/** @file\r
- Platform Configuration Database (PCD) Protocol\r
+ Native Platform Configuration Database (PCD) Protocol\r
\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
- 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
+ Different with the EFI_PCD_PROTOCOL defined in PI 1.2 specification, the native\r
+ PCD protocol provide interfaces for dynamic and dynamic-ex type PCD. \r
+ The interfaces in dynamic type PCD do not require the token space guid as parameter,\r
+ but interfaces in dynamic-ex type PCD require token space guid as parameter.\r
+ \r
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
**/\r
\r
#define PCD_PROTOCOL_GUID \\r
{ 0x11b34006, 0xd85b, 0x4d0a, { 0xa2, 0x90, 0xd5, 0xa5, 0x71, 0x31, 0xe, 0xf7 } }\r
\r
+#define PCD_INVALID_TOKEN_NUMBER ((UINTN) 0)\r
+\r
+\r
/**\r
Sets the SKU value for subsequent calls to set or get PCD token values.\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
\r
- @retval VOID\r
\r
**/\r
typedef \r
\r
\r
/**\r
- Retrieves an 16-bit value for a given PCD token.\r
+ Retrieves a 16-bit value for a given PCD token.\r
\r
- Retrieves the current 16-bits value for a PCD token number. \r
+ Retrieves the current 16-bit value for a PCD token number. \r
If the TokenNumber is invalid, the results are unpredictable.\r
\r
@param[in] TokenNumber The PCD token number. \r
\r
\r
/**\r
- Retrieves an 32-bit value for a given PCD token.\r
+ Retrieves a 32-bit value for a given PCD token.\r
\r
- Retrieves the current 32-bits value for a PCD token number. \r
+ Retrieves the current 32-bit value for a PCD token number. \r
If the TokenNumber is invalid, the results are unpredictable.\r
\r
@param[in] TokenNumber The PCD token number. \r
\r
\r
/**\r
- Retrieves an 64-bit value for a given PCD token.\r
+ Retrieves a 64-bit value for a given PCD token.\r
\r
- Retrieves the current 64-bits value for a PCD token number. \r
+ Retrieves the current 64-bit value for a PCD token number. \r
If the TokenNumber is invalid, the results are unpredictable.\r
\r
@param[in] TokenNumber The PCD token number. \r
\r
\r
/**\r
- Retrieves an 16-bit value for a given PCD token.\r
+ Retrieves a 16-bit value for a given PCD token.\r
\r
Retrieves the 16-bit value of a particular PCD token. \r
If the TokenNumber is invalid or the token space\r
\r
\r
/**\r
- Retrieves an 32-bit value for a given PCD token.\r
+ Retrieves a 32-bit value for a given PCD token.\r
\r
Retrieves the 32-bit value of a particular PCD token. \r
If the TokenNumber is invalid or the token space\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
+ @return The pointer to the buffer to be retrieved.\r
\r
**/\r
typedef\r
\r
\r
/**\r
- Retrieves an Boolean value for a given PCD token.\r
+ Retrieves a Boolean value for a given PCD token.\r
\r
Retrieves the Boolean value of a particular PCD token. \r
If the TokenNumber is invalid or the token space\r
@param[in] TokenNumber The PCD token number. \r
@param[in] Value The value to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
\r
\r
/**\r
- Sets an 16-bit value for a given PCD token.\r
+ Sets a 16-bit value for a given PCD token.\r
\r
When the PCD service sets a value, it will check to ensure that the \r
size of the value being set is compatible with the Token's existing definition. \r
@param[in] TokenNumber The PCD token number. \r
@param[in] Value The value to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
\r
\r
/**\r
- Sets an 32-bit value for a given PCD token.\r
+ Sets a 32-bit value for a given PCD token.\r
\r
When the PCD service sets a value, it will check to ensure that the \r
size of the value being set is compatible with the Token's existing definition. \r
@param[in] TokenNumber The PCD token number. \r
@param[in] Value The value to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
\r
\r
/**\r
- Sets an 64-bit value for a given PCD token.\r
+ Sets a 64-bit value for a given PCD token.\r
\r
When the PCD service sets a value, it will check to ensure that the \r
size of the value being set is compatible with the Token's existing definition. \r
@param[in] TokenNumber The PCD token number. \r
@param[in] Value The value to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\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_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
\r
\r
/**\r
- Sets an Boolean value for a given PCD token.\r
+ Sets a Boolean value for a given PCD token.\r
\r
When the PCD service sets a value, it will check to ensure that the \r
size of the value being set is compatible with the Token's existing definition. \r
@param[in] TokenNumber The PCD token number. \r
@param[in] Value The value to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
@param[in] TokenNumber The PCD token number. \r
@param[in] Value The value to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
@param[in] TokenNumber The PCD token number. \r
@param[in] Value The value to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
\r
\r
/**\r
- Sets an 32-bit value for a given PCD token.\r
+ Sets a 32-bit value for a given PCD token.\r
\r
When the PCD service sets a value, it will check to ensure that the \r
size of the value being set is compatible with the Token's existing definition. \r
@param[in] TokenNumber The PCD token number. \r
@param[in] Value The value to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
\r
\r
/**\r
- Sets an 64-bit value for a given PCD token.\r
+ Sets a 64-bit value for a given PCD token.\r
\r
When the PCD service sets a value, it will check to ensure that the \r
size of the value being set is compatible with the Token's existing definition. \r
@param[in] TokenNumber The PCD token number. \r
@param[in] Value The value to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\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_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target 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
\r
/**\r
- Sets an Boolean value for a given PCD token.\r
+ Sets a Boolean value for a given PCD token.\r
\r
When the PCD service sets a value, it will check to ensure that the \r
size of the value being set is compatible with the Token's existing definition. \r
@param[in] TokenNumber The PCD token number. \r
@param[in] Value The value to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
This notification function serves two purposes. \r
Firstly, it notifies the module which did the registration that the value \r
of this PCD token has been set. Secondly, it provides a mechanism for the \r
- module which did the registration to intercept the set operation and override \r
- the value been set if necessary. After the invocation of the callback function, \r
+ module that did the registration to intercept the set operation and override \r
+ the value that has been set, if necessary. After the invocation of the callback function, \r
TokenData will be used by PCD service DXE driver to modify the internal data in \r
PCD database.\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
\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 know without examination or by deduction 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] 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
- 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
\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
/**\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
+ @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
+ return EFI_SUCCESS. If *Guid is NULL and there is no namespace exist in \r
+ the platform other than the default (NULL) token namespace, *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
+ Or, the input token space Guid is already the last valid token space Guid \r
in the PCD database. In the later case, *Guid is updated with the value of NULL.\r
@retval EFI_NOT_FOUND If the input token namespace does not exist on the platform.\r
\r
projects / mirror_edk2.git / blobdiff