/** @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
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 <PiDxe.h>\r
+\r
extern EFI_GUID gPcdProtocolGuid;\r
\r
#define PCD_PROTOCOL_GUID \\r
the system uses the default SKU Id. If the system attempts to use the default SKU Id and no value has been \r
set for that Id, the results are unpredictable.\r
\r
- @param SkuId The SKU value that will be used when the PCD service will retrieve and \r
- set values associated with a PCD token.\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
VOID\r
-(EFIAPI *PCD_PROTOCOL_SET_SKU) (\r
+(EFIAPI *PCD_PROTOCOL_SET_SKU)(\r
IN UINTN SkuId\r
);\r
\r
Retrieves the current byte-sized value for a PCD token number. \r
If the TokenNumber is invalid, the results are unpredictable.\r
\r
- @param TokenNumber The PCD token number. \r
+ @param[in] TokenNumber The PCD token number. \r
\r
@return The UINT8 value.\r
\r
**/\r
typedef\r
UINT8\r
-(EFIAPI *PCD_PROTOCOL_GET8) (\r
+(EFIAPI *PCD_PROTOCOL_GET8)(\r
IN UINTN TokenNumber\r
);\r
\r
Retrieves the current 16-bits value for a PCD token number. \r
If the TokenNumber is invalid, the results are unpredictable.\r
\r
- @param TokenNumber The PCD token number. \r
+ @param[in] TokenNumber The PCD token number. \r
\r
@return The UINT16 value.\r
\r
**/\r
typedef\r
UINT16\r
-(EFIAPI *PCD_PROTOCOL_GET16) (\r
+(EFIAPI *PCD_PROTOCOL_GET16)(\r
IN UINTN TokenNumber\r
);\r
\r
Retrieves the current 32-bits value for a PCD token number. \r
If the TokenNumber is invalid, the results are unpredictable.\r
\r
- @param TokenNumber The PCD token number. \r
+ @param[in] TokenNumber The PCD token number. \r
\r
@return The UINT32 value.\r
\r
**/\r
typedef\r
UINT32\r
-(EFIAPI *PCD_PROTOCOL_GET32) (\r
+(EFIAPI *PCD_PROTOCOL_GET32)(\r
IN UINTN TokenNumber\r
);\r
\r
Retrieves the current 64-bits value for a PCD token number. \r
If the TokenNumber is invalid, the results are unpredictable.\r
\r
- @param TokenNumber The PCD token number. \r
+ @param[in] TokenNumber The PCD token number. \r
\r
@return The UINT64 value.\r
\r
**/\r
typedef\r
UINT64\r
-(EFIAPI *PCD_PROTOCOL_GET64) (\r
+(EFIAPI *PCD_PROTOCOL_GET64)(\r
IN UINTN TokenNumber\r
);\r
\r
is returned by this function call. If the TokenNumber is invalid, \r
the results are unpredictable.\r
\r
- @param TokenNumber The PCD token number. \r
+ @param[in] TokenNumber The PCD token number. \r
\r
@return The pointer to the buffer to be retrived.\r
\r
**/\r
typedef\r
VOID *\r
-(EFIAPI *PCD_PROTOCOL_GET_POINTER) (\r
+(EFIAPI *PCD_PROTOCOL_GET_POINTER)(\r
IN UINTN TokenNumber\r
);\r
\r
is returned by this function call. If the TokenNumber is invalid, \r
the results are unpredictable.\r
\r
- @param TokenNumber The PCD token number. \r
+ @param[in] TokenNumber The PCD token number. \r
\r
@return The Boolean value.\r
\r
**/\r
typedef\r
BOOLEAN\r
-(EFIAPI *PCD_PROTOCOL_GET_BOOLEAN) (\r
+(EFIAPI *PCD_PROTOCOL_GET_BOOLEAN)(\r
IN UINTN TokenNumber\r
);\r
\r
Retrieves the current size of a particular PCD token. \r
If the TokenNumber is invalid, the results are unpredictable.\r
\r
- @param TokenNumber The PCD token number. \r
+ @param[in] TokenNumber The PCD token number. \r
\r
@return The size of the value for the PCD token.\r
\r
**/\r
typedef\r
UINTN\r
-(EFIAPI *PCD_PROTOCOL_GET_SIZE) (\r
+(EFIAPI *PCD_PROTOCOL_GET_SIZE)(\r
IN UINTN TokenNumber\r
);\r
\r
specified by Guid does not exist, the results are \r
unpredictable.\r
\r
- @param Guid The token space for the token number.\r
- @param TokenNumber The PCD 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
\r
**/\r
typedef\r
UINT8\r
-(EFIAPI *PCD_PROTOCOL_GET_EX_8) (\r
+(EFIAPI *PCD_PROTOCOL_GET_EX_8)(\r
IN CONST EFI_GUID *Guid,\r
IN UINTN TokenNumber\r
);\r
specified by Guid does not exist, the results are \r
unpredictable.\r
\r
- @param Guid The token space for the token number.\r
- @param TokenNumber The PCD 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
\r
**/\r
typedef\r
UINT16\r
-(EFIAPI *PCD_PROTOCOL_GET_EX_16) (\r
+(EFIAPI *PCD_PROTOCOL_GET_EX_16)(\r
IN CONST EFI_GUID *Guid,\r
IN UINTN TokenNumber\r
);\r
specified by Guid does not exist, the results are \r
unpredictable.\r
\r
- @param Guid The token space for the token number.\r
- @param TokenNumber The PCD 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
+(EFIAPI *PCD_PROTOCOL_GET_EX_32)(\r
IN CONST EFI_GUID *Guid,\r
IN UINTN TokenNumber\r
);\r
specified by Guid does not exist, the results are \r
unpredictable.\r
\r
- @param Guid The token space for the token number.\r
- @param TokenNumber The PCD 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
\r
**/\r
typedef\r
UINT64\r
-(EFIAPI *PCD_PROTOCOL_GET_EX_64) (\r
+(EFIAPI *PCD_PROTOCOL_GET_EX_64)(\r
IN CONST EFI_GUID *Guid,\r
IN UINTN TokenNumber\r
);\r
is returned by this function call. If the TokenNumber is invalid, \r
the results are unpredictable.\r
\r
- @param Guid The token space for the token number.\r
- @param TokenNumber The PCD 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
\r
**/\r
typedef\r
VOID *\r
-(EFIAPI *PCD_PROTOCOL_GET_EX_POINTER) (\r
+(EFIAPI *PCD_PROTOCOL_GET_EX_POINTER)(\r
IN CONST EFI_GUID *Guid,\r
IN UINTN TokenNumber\r
);\r
specified by Guid does not exist, the results are \r
unpredictable.\r
\r
- @param Guid The token space for the token number.\r
- @param TokenNumber The PCD 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
\r
**/\r
typedef\r
BOOLEAN\r
-(EFIAPI *PCD_PROTOCOL_GET_EX_BOOLEAN) (\r
+(EFIAPI *PCD_PROTOCOL_GET_EX_BOOLEAN)(\r
IN CONST EFI_GUID *Guid,\r
IN UINTN TokenNumber\r
);\r
Retrieves the current size of a particular PCD token. \r
If the TokenNumber is invalid, the results are unpredictable.\r
\r
- @param Guid The token space for the token number.\r
- @param TokenNumber The PCD 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
\r
**/\r
typedef\r
UINTN\r
-(EFIAPI *PCD_PROTOCOL_GET_EX_SIZE) (\r
+(EFIAPI *PCD_PROTOCOL_GET_EX_SIZE)(\r
IN CONST EFI_GUID *Guid,\r
IN UINTN TokenNumber\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 TokenNumber The PCD token number. \r
- @param Value The value to set for the PCD token.\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_INVALID_PARAMETER The PCD service determined that the size of the data \r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *PCD_PROTOCOL_SET8) (\r
+(EFIAPI *PCD_PROTOCOL_SET8)(\r
IN UINTN TokenNumber,\r
IN UINT8 Value\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 TokenNumber The PCD token number. \r
- @param Value The value to set for the PCD token.\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_INVALID_PARAMETER The PCD service determined that the size of the data \r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *PCD_PROTOCOL_SET16) (\r
+(EFIAPI *PCD_PROTOCOL_SET16)(\r
IN UINTN TokenNumber,\r
IN UINT16 Value\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 TokenNumber The PCD token number. \r
- @param Value The value to set for the PCD token.\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_INVALID_PARAMETER The PCD service determined that the size of the data \r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *PCD_PROTOCOL_SET32) (\r
+(EFIAPI *PCD_PROTOCOL_SET32)(\r
IN UINTN TokenNumber,\r
IN UINT32 Value\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 TokenNumber The PCD token number. \r
- @param Value The value to set for the PCD token.\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_INVALID_PARAMETER The PCD service determined that the size of the data \r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *PCD_PROTOCOL_SET64) (\r
+(EFIAPI *PCD_PROTOCOL_SET64)(\r
IN UINTN TokenNumber,\r
IN UINT64 Value\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 TokenNumber The PCD token number. \r
- @param 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 Buffer The buffer to set for the PCD token.\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
\r
@retval EFI_SUCCESS Procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *PCD_PROTOCOL_SET_POINTER) (\r
+(EFIAPI *PCD_PROTOCOL_SET_POINTER)(\r
IN UINTN TokenNumber,\r
IN OUT UINTN *SizeOfBuffer,\r
IN VOID *Buffer\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 TokenNumber The PCD token number. \r
- @param Value The value to set for the PCD token.\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_INVALID_PARAMETER The PCD service determined that the size of the data \r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *PCD_PROTOCOL_SET_BOOLEAN) (\r
+(EFIAPI *PCD_PROTOCOL_SET_BOOLEAN)(\r
IN UINTN TokenNumber,\r
IN BOOLEAN Value\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 Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
- @param TokenNumber The PCD token number. \r
- @param Value The value to set for the PCD token.\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
\r
@retval EFI_SUCCESS Procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *PCD_PROTOCOL_SET_EX_8) (\r
+(EFIAPI *PCD_PROTOCOL_SET_EX_8)(\r
IN CONST EFI_GUID *Guid,\r
IN UINTN TokenNumber,\r
IN UINT8 Value\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 Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
- @param TokenNumber The PCD token number. \r
- @param Value The value to set for the PCD token.\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
\r
@retval EFI_SUCCESS Procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *PCD_PROTOCOL_SET_EX_16) (\r
+(EFIAPI *PCD_PROTOCOL_SET_EX_16)(\r
IN CONST EFI_GUID *Guid,\r
IN UINTN TokenNumber,\r
IN UINT16 Value\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 Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
- @param TokenNumber The PCD token number. \r
- @param Value The value to set for the PCD token.\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
\r
@retval EFI_SUCCESS Procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *PCD_PROTOCOL_SET_EX_32) (\r
+(EFIAPI *PCD_PROTOCOL_SET_EX_32)(\r
IN CONST EFI_GUID *Guid,\r
IN UINTN TokenNumber,\r
IN UINT32 Value\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 Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
- @param TokenNumber The PCD token number. \r
- @param Value The value to set for the PCD token.\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
\r
@retval EFI_SUCCESS Procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *PCD_PROTOCOL_SET_EX_64) (\r
+(EFIAPI *PCD_PROTOCOL_SET_EX_64)(\r
IN CONST EFI_GUID *Guid,\r
IN UINTN TokenNumber,\r
IN UINT64 Value\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 Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
- @param TokenNumber The PCD token number. \r
- @param SizeOfBuffer A pointer to the length of the value being set for the PCD token. \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 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
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *PCD_PROTOCOL_SET_EX_POINTER) (\r
+(EFIAPI *PCD_PROTOCOL_SET_EX_POINTER)(\r
IN CONST EFI_GUID *Guid,\r
IN UINTN TokenNumber,\r
IN OUT UINTN *SizeOfBuffer,\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 Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
- @param TokenNumber The PCD token number. \r
- @param Value The value to set for the PCD token.\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
\r
@retval EFI_SUCCESS Procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *PCD_PROTOCOL_SET_EX_BOOLEAN) (\r
+(EFIAPI *PCD_PROTOCOL_SET_EX_BOOLEAN)(\r
IN CONST EFI_GUID *Guid,\r
IN UINTN TokenNumber,\r
IN BOOLEAN Value\r
/**\r
Callback on SET function prototype definition.\r
\r
- @param CallBackGuid The PCD token GUID being set.\r
- @param CallBackToken The PCD token number being set.\r
- @param TokenData A pointer to the token data being set.\r
- @param TokenDataSize The size, in bytes, of the data being set.\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
+ 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
\r
@retval VOID\r
\r
**/\r
typedef\r
VOID\r
-(EFIAPI *PCD_PROTOCOL_CALLBACK) (\r
+(EFIAPI *PCD_PROTOCOL_CALLBACK)(\r
IN CONST EFI_GUID *CallBackGuid, OPTIONAL\r
IN UINTN CallBackToken,\r
IN OUT VOID *TokenData,\r
/**\r
Specifies a function to be called anytime the value of a designated token is changed.\r
\r
- @param TokenNumber The PCD token number. \r
- @param Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
- @param 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
typedef\r
EFI_STATUS\r
-(EFIAPI *PCD_PROTOCOL_CALLBACK_ONSET) (\r
- IN UINTN TokenNumber,\r
+(EFIAPI *PCD_PROTOCOL_CALLBACK_ONSET)(\r
IN CONST EFI_GUID *Guid, OPTIONAL\r
+ IN UINTN TokenNumber,\r
IN PCD_PROTOCOL_CALLBACK CallBackFunction\r
);\r
\r
/**\r
Cancels a previously set callback function for a particular PCD token number.\r
\r
- @param TokenNumber The PCD token number. \r
- @param Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
- @param 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
typedef\r
EFI_STATUS\r
-(EFIAPI *PCD_PROTOCOL_CANCEL_CALLBACK) (\r
- IN UINTN TokenNumber,\r
+(EFIAPI *PCD_PROTOCOL_CANCEL_CALLBACK)(\r
IN CONST EFI_GUID *Guid, OPTIONAL\r
+ IN UINTN TokenNumber,\r
IN PCD_PROTOCOL_CALLBACK CallBackFunction\r
);\r
\r
/**\r
Retrieves the next valid PCD token for a given namespace.\r
\r
- @param Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
- @param TokenNumber A pointer to the PCD token number to use to find the subsequent token number. \r
- To retrieve the "first" token, have the pointer reference a TokenNumber value of 0.\r
+ @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\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 value requested.\r
- @retval EFI_NOT_FOUND The PCD service could not find data from the requested 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
\r
**/\r
typedef \r
EFI_STATUS\r
-(EFIAPI *PCD_PROTOCOL_GET_NEXT_TOKEN) (\r
+(EFIAPI *PCD_PROTOCOL_GET_NEXT_TOKEN)(\r
IN CONST EFI_GUID *Guid, OPTIONAL\r
IN OUT UINTN *TokenNumber\r
);\r
/**\r
Retrieves the next valid PCD token namespace for a given namespace.\r
\r
- @param Guid An indirect pointer to EFI_GUID. On input it designates a known \r
- token namespace from which the search will start. On output, \r
- it designates the next valid token namespace on the platform. \r
- If *Guid is NULL, then the GUID of the first token space of the current platform is returned.\r
- If this input token namespace is the last tokenspace on the platform,\r
- *Guid will be assigned to NULL and the function return EFI_SUCCESS.\r
- If the search cannot locate the input token namespace, an error is returned and \r
- the value of *Guid is undefined. \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
\r
- @retval EFI_SUCCESS The PCD service retrieved the value requested.\r
- @retval EFI_NOT_FOUND The PCD service could not find the input token namespace.\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 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
**/\r
typedef \r
EFI_STATUS\r
-(EFIAPI *PCD_PROTOCOL_GET_NEXT_TOKENSPACE) (\r
- IN CONST EFI_GUID **Guid\r
+(EFIAPI *PCD_PROTOCOL_GET_NEXT_TOKENSPACE)(\r
+ IN OUT CONST EFI_GUID **Guid\r
);\r
\r
-\r
-\r
//\r
// Interface structure for the PCD Protocol\r
//\r
+/**\r
+ @par Protocol Description:\r
+ This service abstracts the ability to set/get Platform Configuration Database (PCD).\r
+\r
+ @param SetSku\r
+ Sets the SKU value for subsequent calls to set or get PCD token values.\r
+ \r
+ @param Get8\r
+ Retrieves an 8-bit value for a given PCD token.\r
+\r
+ @param Get16\r
+ Retrieves an 16-bit value for a given PCD token.\r
+\r
+ @param Get32\r
+ Retrieves an 32-bit value for a given PCD token.\r
+\r
+ @param Get64\r
+ Retrieves an 64-bit value for a given PCD token.\r
+\r
+ @param GetPtr\r
+ Retrieves a pointer to a value for a given PCD token.\r
+\r
+ @param GetBool\r
+ Retrieves an Boolean value for a given PCD token.\r
+\r
+ @param GetSize\r
+ Retrieves the size of the value for a given PCD token.\r
+\r
+ @param Get8Ex\r
+ Retrieves an 8-bit value for a given PCD token and token space.\r
+\r
+ @param Get16Ex\r
+ Retrieves an 16-bit value for a given PCD token and token space.\r
+\r
+ @param Get32Ex\r
+ Retrieves an 32-bit value for a given PCD token and token space.\r
+\r
+ @param Get64Ex\r
+ Retrieves an 64-bit value for a given PCD token and token space.\r
+\r
+ @param GetPtrEx\r
+ Retrieves a pointer to a value for a given PCD token and token space.\r
+\r
+ @param GetBoolEx\r
+ Retrieves an Boolean value for a given PCD token and token space.\r
+\r
+ @param GetSizeEx\r
+ Retrieves the size of the value for a given PCD token and token space.\r
+\r
+ @param Set8\r
+ Sets an 8-bit value for a given PCD token.\r
+\r
+ @param Set16\r
+ Sets an 16-bit value for a given PCD token.\r
+\r
+ @param Set32\r
+ Sets an 32-bit value for a given PCD token.\r
+\r
+ @param Set64\r
+ Sets an 64-bit value for a given PCD token.\r
+\r
+ @param SetPtr\r
+ Sets the buffer of a specified size for a given PCD token.\r
+\r
+ @param SetBool\r
+ Sets an Boolean value for a given PCD token.\r
+\r
+ @param Set8Ex\r
+ Sets an 8-bit value for a given PCD token and token space.\r
+\r
+ @param Set16Ex\r
+ Sets an 16-bit value for a given PCD token and token space.\r
+\r
+ @param Set32Ex\r
+ Sets an 32-bit value for a given PCD token and token space.\r
+\r
+ @param Set64Ex\r
+ Sets an 64-bit value for a given PCD token and token space.\r
+\r
+ @param SetPtrEx\r
+ Sets the buffer of a specified size for a given PCD token and token space.\r
+\r
+ @param SetBoolEx\r
+ Sets an Boolean value for a given PCD token and token space.\r
+ \r
+ @param CallbackOnSet\r
+ Specifies a function to be called anytime the value of a designated token is changed.\r
+ \r
+ @param CancelCallback\r
+ Cancels a previously set callback function for a particular PCD token number.\r
+ \r
+ @param GetNextToken\r
+ Retrieves the next valid PCD token for a given namespace.\r
+ \r
+ @param GetNextTokenSpace\r
+ Retrieves the next valid PCD token namespace for a given namespace.\r
+ \r
+**/\r
typedef struct {\r
PCD_PROTOCOL_SET_SKU SetSku;\r
\r
projects / mirror_edk2.git / blobdiff