/** @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
+ Native Platform Configuration Database (PCD) PPI\r
+ \r
+ Different with the EFI_PCD_PPI defined in PI 1.2 specification, the native\r
+ PCD PPI provide interfaces for dynamic and dynamic-ex type PCD. \r
+ The interfaces for dynamic type PCD do not require the token space guid as parameter,\r
+ but interfaces for dynamic-ex type PCD require token space guid as parameter.\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
+Copyright (c) 2006 - 2013, 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
- Module Name: Pcd.h\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
-#ifndef __PCD_H__\r
-#define __PCD_H__\r
-\r
-extern EFI_GUID gPcdPpiGuid;\r
+#ifndef __PCD_PPI_H__\r
+#define __PCD_PPI_H__\r
\r
#define PCD_PPI_GUID \\r
{ 0x6e81c58, 0x4ad7, 0x44bc, { 0x83, 0x90, 0xf1, 0x2, 0x65, 0xf7, 0x24, 0x80 } }\r
#define PCD_INVALID_TOKEN_NUMBER ((UINTN) 0)\r
\r
\r
-\r
/**\r
Sets the SKU value for subsequent calls to set or get PCD token values.\r
\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
+ @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
typedef \r
VOID\r
-(EFIAPI *PCD_PPI_SET_SKU) (\r
+(EFIAPI *PCD_PPI_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_PPI_GET8) (\r
+(EFIAPI *PCD_PPI_GET8)(\r
IN UINTN TokenNumber\r
);\r
\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 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_PPI_GET16) (\r
+(EFIAPI *PCD_PPI_GET16)(\r
IN UINTN TokenNumber\r
);\r
\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 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_PPI_GET32) (\r
+(EFIAPI *PCD_PPI_GET32)(\r
IN UINTN TokenNumber\r
);\r
\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 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_PPI_GET64) (\r
+(EFIAPI *PCD_PPI_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_PPI_GET_POINTER) (\r
+(EFIAPI *PCD_PPI_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_PPI_GET_BOOLEAN) (\r
+(EFIAPI *PCD_PPI_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_PPI_GET_SIZE) (\r
+(EFIAPI *PCD_PPI_GET_SIZE)(\r
IN UINTN TokenNumber\r
);\r
\r
\r
\r
/**\r
- Retrieves an 8-bit value for a given PCD token.\r
+ Retrieves an 8-bit value for a given PCD token and token space.\r
\r
Retrieves the 8-bit value of a particular PCD token. \r
If the TokenNumber is invalid or the token space\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_PPI_GET_EX_8) (\r
+(EFIAPI *PCD_PPI_GET_EX_8)(\r
IN CONST EFI_GUID *Guid,\r
- IN UINTN TokenNumber\r
+ IN UINTN TokenNumber\r
);\r
\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 and token space.\r
\r
Retrieves the 16-bit value of a particular PCD token. \r
If the TokenNumber is invalid or the token space\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_PPI_GET_EX_16) (\r
+(EFIAPI *PCD_PPI_GET_EX_16)(\r
IN CONST EFI_GUID *Guid,\r
- IN UINTN TokenNumber\r
+ IN UINTN TokenNumber\r
);\r
\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 and token space.\r
\r
Retrieves the 32-bit value of a particular PCD token. \r
If the TokenNumber is invalid or the token space\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
**/\r
typedef\r
UINT32\r
-(EFIAPI *PCD_PPI_GET_EX_32) (\r
+(EFIAPI *PCD_PPI_GET_EX_32)(\r
IN CONST EFI_GUID *Guid,\r
- IN UINTN TokenNumber\r
+ IN UINTN TokenNumber\r
);\r
\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 and token space.\r
\r
Retrieves the 64-bit value of a particular PCD token. \r
If the TokenNumber is invalid or the token space\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_PPI_GET_EX_64) (\r
+(EFIAPI *PCD_PPI_GET_EX_64)(\r
IN CONST EFI_GUID *Guid,\r
- IN UINTN TokenNumber\r
+ IN UINTN TokenNumber\r
);\r
\r
\r
\r
/**\r
- Retrieves a pointer to a value for a given PCD token.\r
+ Retrieves a pointer to a value for a given PCD token and token space.\r
\r
Retrieves the current pointer to the buffer for a PCD token number. \r
Do not make any assumptions about the alignment of the pointer that \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_PPI_GET_EX_POINTER) (\r
+(EFIAPI *PCD_PPI_GET_EX_POINTER)(\r
IN CONST EFI_GUID *Guid,\r
- IN UINTN TokenNumber\r
+ IN UINTN TokenNumber\r
);\r
\r
\r
\r
/**\r
- Retrieves an Boolean value for a given PCD token.\r
+ Retrieves an Boolean value for a given PCD token and token space.\r
\r
Retrieves the Boolean value of a particular PCD token. \r
If the TokenNumber is invalid or the token space\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_PPI_GET_EX_BOOLEAN) (\r
+(EFIAPI *PCD_PPI_GET_EX_BOOLEAN)(\r
IN CONST EFI_GUID *Guid,\r
- IN UINTN TokenNumber\r
+ IN UINTN TokenNumber\r
);\r
\r
\r
\r
/**\r
- Retrieves the size of the value for a given PCD token.\r
+ Retrieves the size of the value for a given PCD token and token space.\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_PPI_GET_EX_SIZE) (\r
+(EFIAPI *PCD_PPI_GET_EX_SIZE)(\r
IN CONST EFI_GUID *Guid,\r
- IN UINTN TokenNumber\r
+ IN UINTN TokenNumber\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 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_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
- @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+ being set was incompatible with a call to this function. \r
+ Use GetSize() to retrieve the size of the target data.\r
+ @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *PCD_PPI_SET8) (\r
+(EFIAPI *PCD_PPI_SET8)(\r
IN UINTN TokenNumber,\r
IN UINT8 Value\r
);\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
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_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
- @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+ being set was incompatible with a call to this function. \r
+ Use GetSize() to retrieve the size of the target data.\r
+ @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *PCD_PPI_SET16) (\r
+(EFIAPI *PCD_PPI_SET16)(\r
IN UINTN TokenNumber,\r
IN UINT16 Value\r
);\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
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_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
- @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+ being set was incompatible with a call to this function. \r
+ Use GetSize() to retrieve the size of the target data.\r
+ @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *PCD_PPI_SET32) (\r
+(EFIAPI *PCD_PPI_SET32)(\r
IN UINTN TokenNumber,\r
IN UINT32 Value\r
);\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
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_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
- @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+ being set was incompatible with a call to this function. \r
+ Use GetSize() to retrieve the size of the target data.\r
+ @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *PCD_PPI_SET64) (\r
+(EFIAPI *PCD_PPI_SET64)(\r
IN UINTN TokenNumber,\r
IN UINT64 Value\r
);\r
\r
-\r
-\r
-\r
/**\r
Sets a value of a specified size for a given PCD token.\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] SizeOfValue 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_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
- @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+ being set was incompatible with a call to this function. \r
+ Use GetSize() to retrieve the size of the target data.\r
+ @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *PCD_PPI_SET_POINTER) (\r
+(EFIAPI *PCD_PPI_SET_POINTER)(\r
IN UINTN TokenNumber,\r
- IN OUT UINTN *SizeOfBuffer,\r
+ IN OUT UINTN *SizeOfValue,\r
IN VOID *Buffer\r
);\r
\r
-\r
-\r
/**\r
Sets an Boolean value for a given PCD token.\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_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
- @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+ being set was incompatible with a call to this function. \r
+ Use GetSize() to retrieve the size of the target data.\r
+ @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *PCD_PPI_SET_BOOLEAN) (\r
+(EFIAPI *PCD_PPI_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_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
- @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+ being set was incompatible with a call to this function. \r
+ Use GetSize() to retrieve the size of the target data.\r
+ @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *PCD_PPI_SET_EX_8) (\r
+(EFIAPI *PCD_PPI_SET_EX_8)(\r
IN CONST EFI_GUID *Guid,\r
- IN UINTN TokenNumber,\r
- IN UINT8 Value\r
+ IN UINTN TokenNumber,\r
+ IN UINT8 Value\r
);\r
\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
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_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
- @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+ being set was incompatible with a call to this function. \r
+ Use GetSize() to retrieve the size of the target data.\r
+ @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *PCD_PPI_SET_EX_16) (\r
+(EFIAPI *PCD_PPI_SET_EX_16)(\r
IN CONST EFI_GUID *Guid,\r
- IN UINTN TokenNumber,\r
- IN UINT16 Value\r
+ IN UINTN TokenNumber,\r
+ IN UINT16 Value\r
);\r
\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
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_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
- @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+ being set was incompatible with a call to this function. \r
+ Use GetSize() to retrieve the size of the target data.\r
+ @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *PCD_PPI_SET_EX_32) (\r
+(EFIAPI *PCD_PPI_SET_EX_32)(\r
IN CONST EFI_GUID *Guid,\r
- IN UINTN TokenNumber,\r
- IN UINT32 Value\r
+ IN UINTN TokenNumber,\r
+ IN UINT32 Value\r
);\r
\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
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_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
- @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+ being set was incompatible with a call to this function. \r
+ Use GetSize() to retrieve the size of the target data.\r
+ @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\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
+(EFIAPI *PCD_PPI_SET_EX_64)(\r
+ IN CONST EFI_GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN UINT64 Value\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 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
- 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] 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] SizeOfValue 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_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
- @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+ being set was incompatible with a call to this function. \r
+ Use GetSize() to retrieve the size of the target data.\r
+ @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\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 OUT UINTN *SizeOfBuffer,\r
- IN VOID *Buffer\r
+(EFIAPI *PCD_PPI_SET_EX_POINTER)(\r
+ IN CONST EFI_GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN OUT UINTN *SizeOfValue,\r
+ IN VOID *Buffer\r
);\r
\r
-\r
-\r
/**\r
Sets an Boolean value for a given PCD token.\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_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
- @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\r
+ being set was incompatible with a call to this function. \r
+ Use GetSize() to retrieve the size of the target data.\r
+ @retval EFI_NOT_FOUND The PCD service could not find the requested token number.\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
+(EFIAPI *PCD_PPI_SET_EX_BOOLEAN)(\r
+ IN CONST EFI_GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN BOOLEAN Value\r
);\r
\r
\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. Firstly, it notifies the module \r
+ which did the registration that the value of this PCD token has been set. Secondly, \r
+ it provides a mechanism for the module which did the registration to intercept the set \r
+ operation and override the value been set if necessary. After the invocation of the \r
+ callback function, TokenData will be used by PCD service PEIM to modify the internal data \r
+ in 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_PPI_CALLBACK) (\r
- IN CONST EFI_GUID *CallBackGuid, OPTIONAL\r
- IN UINTN CallBackToken,\r
- IN OUT VOID *TokenData,\r
- IN UINTN TokenDataSize\r
+(EFIAPI *PCD_PPI_CALLBACK)(\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 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
for the CallBackToken requested.\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
+(EFIAPI *PCD_PPI_CALLBACK_ONSET)(\r
+ IN CONST EFI_GUID *Guid, OPTIONAL\r
+ IN UINTN TokenNumber,\r
+ IN PCD_PPI_CALLBACK CallBackFunction\r
);\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
for the CallBackToken requested.\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
+(EFIAPI *PCD_PPI_CANCEL_CALLBACK)(\r
+ IN CONST EFI_GUID *Guid, OPTIONAL\r
+ IN UINTN TokenNumber,\r
+ IN PCD_PPI_CALLBACK CallBackFunction\r
);\r
\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
-\r
- @retval EFI_SUCCESS The PCD service retrieved the value requested.\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
+ This is an optional parameter that may be NULL. If this parameter is NULL, then a request \r
+ is being made to retrieve tokens from the default token space.\r
+ @param[in, out] TokenNumber A pointer to the PCD token number to use to find the subsequent token number.\r
+ \r
+ @retval EFI_SUCCESS The PCD service has retrieved the next valid token number.\r
@retval EFI_NOT_FOUND The PCD service could not find data from the requested token number.\r
\r
**/\r
typedef \r
EFI_STATUS\r
-(EFIAPI *PCD_PPI_GET_NEXT_TOKEN) (\r
+(EFIAPI *PCD_PPI_GET_NEXT_TOKEN)(\r
IN CONST EFI_GUID *Guid, OPTIONAL\r
- IN OUT UINTN *TokenNumber\r
+ IN OUT UINTN *TokenNumber\r
);\r
\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
+ 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
- @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
+ @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
+ @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
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *PCD_PPI_GET_NEXT_TOKENSPACE) (\r
+(EFIAPI *PCD_PPI_GET_NEXT_TOKENSPACE)(\r
IN OUT CONST EFI_GUID **Guid\r
);\r
\r
\r
\r
-//\r
-// Interface structure for the PCD PPI\r
-//\r
+///\r
+/// This service abstracts the ability to set/get Platform Configuration Database (PCD).\r
+///\r
typedef struct {\r
PCD_PPI_SET_SKU SetSku;\r
\r
} PCD_PPI;\r
\r
\r
+extern EFI_GUID gPcdPpiGuid;\r
+\r
#endif\r
projects / mirror_edk2.git / blobdiff