X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdePkg%2FInclude%2FPpi%2FPcd.h;h=79e9c3e971ce4b2731030c5cd7ae89db8935783b;hb=bca08c489cc458f551ba27c3530353e77c07ba40;hp=38b04bfc98ba487bd71bc66ebdab13541f29ea15;hpb=511710d68f477e0210ae1830769e5d0cde4ea36a;p=mirror_edk2.git diff --git a/MdePkg/Include/Ppi/Pcd.h b/MdePkg/Include/Ppi/Pcd.h index 38b04bfc98..79e9c3e971 100644 --- a/MdePkg/Include/Ppi/Pcd.h +++ b/MdePkg/Include/Ppi/Pcd.h @@ -1,23 +1,24 @@ /** @file - Platform Configuration Database (PCD) Protocol - - Copyright (c) 2006, Intel Corporation - All rights reserved. This program and the accompanying materials - are licensed and made available under the terms and conditions of the BSD License - which accompanies this distribution. The full text of the license may be found at - http://opensource.org/licenses/bsd-license.php + Native Platform Configuration Database (PCD) PPI + + Different with the EFI_PCD_PPI defined in PI 1.2 specification, the native + PCD PPI provide interfaces for dynamic and dynamic-ex type PCD. + The interfaces for dynamic type PCD do not require the token space guid as parameter, + but interfaces for dynamic-ex type PCD require token space guid as parameter. - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.
+This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. +The full text of the license may be found at +http://opensource.org/licenses/bsd-license.php. - Module Name: Pcd.h +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ -#ifndef __PCD_H__ -#define __PCD_H__ - -extern EFI_GUID gPcdPpiGuid; +#ifndef __PCD_PPI_H__ +#define __PCD_PPI_H__ #define PCD_PPI_GUID \ { 0x6e81c58, 0x4ad7, 0x44bc, { 0x83, 0x90, 0xf1, 0x2, 0x65, 0xf7, 0x24, 0x80 } } @@ -25,7 +26,6 @@ extern EFI_GUID gPcdPpiGuid; #define PCD_INVALID_TOKEN_NUMBER ((UINTN) 0) - /** Sets the SKU value for subsequent calls to set or get PCD token values. @@ -51,7 +51,7 @@ extern EFI_GUID gPcdPpiGuid; **/ typedef VOID -(EFIAPI *PCD_PPI_SET_SKU) ( +(EFIAPI *PCD_PPI_SET_SKU)( IN UINTN SkuId ); @@ -70,16 +70,16 @@ VOID **/ typedef UINT8 -(EFIAPI *PCD_PPI_GET8) ( +(EFIAPI *PCD_PPI_GET8)( IN UINTN TokenNumber ); /** - Retrieves an 16-bit value for a given PCD token. + Retrieves a 16-bit value for a given PCD token. - Retrieves the current 16-bits value for a PCD token number. + Retrieves the current 16-bit value for a PCD token number. If the TokenNumber is invalid, the results are unpredictable. @param[in] TokenNumber The PCD token number. @@ -89,16 +89,16 @@ UINT8 **/ typedef UINT16 -(EFIAPI *PCD_PPI_GET16) ( +(EFIAPI *PCD_PPI_GET16)( IN UINTN TokenNumber ); /** - Retrieves an 32-bit value for a given PCD token. + Retrieves a 32-bit value for a given PCD token. - Retrieves the current 32-bits value for a PCD token number. + Retrieves the current 32-bit value for a PCD token number. If the TokenNumber is invalid, the results are unpredictable. @param[in] TokenNumber The PCD token number. @@ -108,16 +108,16 @@ UINT16 **/ typedef UINT32 -(EFIAPI *PCD_PPI_GET32) ( +(EFIAPI *PCD_PPI_GET32)( IN UINTN TokenNumber ); /** - Retrieves an 64-bit value for a given PCD token. + Retrieves a 64-bit value for a given PCD token. - Retrieves the current 64-bits value for a PCD token number. + Retrieves the current 64-bit value for a PCD token number. If the TokenNumber is invalid, the results are unpredictable. @param[in] TokenNumber The PCD token number. @@ -127,7 +127,7 @@ UINT32 **/ typedef UINT64 -(EFIAPI *PCD_PPI_GET64) ( +(EFIAPI *PCD_PPI_GET64)( IN UINTN TokenNumber ); @@ -148,7 +148,7 @@ UINT64 **/ typedef VOID * -(EFIAPI *PCD_PPI_GET_POINTER) ( +(EFIAPI *PCD_PPI_GET_POINTER)( IN UINTN TokenNumber ); @@ -169,7 +169,7 @@ VOID * **/ typedef BOOLEAN -(EFIAPI *PCD_PPI_GET_BOOLEAN) ( +(EFIAPI *PCD_PPI_GET_BOOLEAN)( IN UINTN TokenNumber ); @@ -188,21 +188,21 @@ BOOLEAN **/ typedef UINTN -(EFIAPI *PCD_PPI_GET_SIZE) ( +(EFIAPI *PCD_PPI_GET_SIZE)( IN UINTN TokenNumber ); /** - Retrieves an 8-bit value for a given PCD token. + Retrieves an 8-bit value for a given PCD token and token space. Retrieves the 8-bit value of a particular PCD token. If the TokenNumber is invalid or the token space specified by Guid does not exist, the results are unpredictable. - @param[in] Guid The token space for the token number. + @param[in] Guid The token space for the token number. @param[in] TokenNumber The PCD token number. @return The size 8-bit value for the PCD token. @@ -210,22 +210,22 @@ UINTN **/ typedef UINT8 -(EFIAPI *PCD_PPI_GET_EX_8) ( +(EFIAPI *PCD_PPI_GET_EX_8)( IN CONST EFI_GUID *Guid, - IN UINTN TokenNumber + IN UINTN TokenNumber ); /** - Retrieves an 16-bit value for a given PCD token. + Retrieves a 16-bit value for a given PCD token and token space. Retrieves the 16-bit value of a particular PCD token. If the TokenNumber is invalid or the token space specified by Guid does not exist, the results are unpredictable. - @param[in] Guid The token space for the token number. + @param[in] Guid The token space for the token number. @param[in] TokenNumber The PCD token number. @return The size 16-bit value for the PCD token. @@ -233,22 +233,22 @@ UINT8 **/ typedef UINT16 -(EFIAPI *PCD_PPI_GET_EX_16) ( +(EFIAPI *PCD_PPI_GET_EX_16)( IN CONST EFI_GUID *Guid, - IN UINTN TokenNumber + IN UINTN TokenNumber ); /** - Retrieves an 32-bit value for a given PCD token. + Retrieves a 32-bit value for a given PCD token and token space. Retrieves the 32-bit value of a particular PCD token. If the TokenNumber is invalid or the token space specified by Guid does not exist, the results are unpredictable. - @param[in] Guid The token space for the token number. + @param[in] Guid The token space for the token number. @param[in] TokenNumber The PCD token number. @return The size 32-bit value for the PCD token. @@ -256,22 +256,22 @@ UINT16 **/ typedef UINT32 -(EFIAPI *PCD_PPI_GET_EX_32) ( +(EFIAPI *PCD_PPI_GET_EX_32)( IN CONST EFI_GUID *Guid, - IN UINTN TokenNumber + IN UINTN TokenNumber ); /** - Retrieves an 64-bit value for a given PCD token. + Retrieves a 64-bit value for a given PCD token and token space. Retrieves the 64-bit value of a particular PCD token. If the TokenNumber is invalid or the token space specified by Guid does not exist, the results are unpredictable. - @param[in] Guid The token space for the token number. + @param[in] Guid The token space for the token number. @param[in] TokenNumber The PCD token number. @return The size 64-bit value for the PCD token. @@ -279,22 +279,22 @@ UINT32 **/ typedef UINT64 -(EFIAPI *PCD_PPI_GET_EX_64) ( +(EFIAPI *PCD_PPI_GET_EX_64)( IN CONST EFI_GUID *Guid, - IN UINTN TokenNumber + IN UINTN TokenNumber ); /** - Retrieves a pointer to a value for a given PCD token. + Retrieves a pointer to a value for a given PCD token and token space. Retrieves the current pointer to the buffer for a PCD token number. Do not make any assumptions about the alignment of the pointer that is returned by this function call. If the TokenNumber is invalid, the results are unpredictable. - @param[in] Guid The token space for the token number. + @param[in] Guid The token space for the token number. @param[in] TokenNumber The PCD token number. @return The pointer to the buffer to be retrived. @@ -302,15 +302,15 @@ UINT64 **/ typedef VOID * -(EFIAPI *PCD_PPI_GET_EX_POINTER) ( +(EFIAPI *PCD_PPI_GET_EX_POINTER)( IN CONST EFI_GUID *Guid, - IN UINTN TokenNumber + IN UINTN TokenNumber ); /** - Retrieves an Boolean value for a given PCD token. + Retrieves an Boolean value for a given PCD token and token space. Retrieves the Boolean value of a particular PCD token. If the TokenNumber is invalid or the token space @@ -325,20 +325,20 @@ VOID * **/ typedef BOOLEAN -(EFIAPI *PCD_PPI_GET_EX_BOOLEAN) ( +(EFIAPI *PCD_PPI_GET_EX_BOOLEAN)( IN CONST EFI_GUID *Guid, - IN UINTN TokenNumber + IN UINTN TokenNumber ); /** - Retrieves the size of the value for a given PCD token. + Retrieves the size of the value for a given PCD token and token space. Retrieves the current size of a particular PCD token. If the TokenNumber is invalid, the results are unpredictable. - @param[in] Guid The token space for the token number. + @param[in] Guid The token space for the token number. @param[in] TokenNumber The PCD token number. @return The size of the value for the PCD token. @@ -346,9 +346,9 @@ BOOLEAN **/ typedef UINTN -(EFIAPI *PCD_PPI_GET_EX_SIZE) ( +(EFIAPI *PCD_PPI_GET_EX_SIZE)( IN CONST EFI_GUID *Guid, - IN UINTN TokenNumber + IN UINTN TokenNumber ); @@ -361,18 +361,18 @@ UINTN If it is not, an error will be returned. @param[in] TokenNumber The PCD token number. - @param[in] Value The value to set for the PCD token. + @param[in] Value The value to set for the PCD token. - @retval EFI_SUCCESS Procedure returned successfully. + @retval EFI_SUCCESS The procedure returned successfully. @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. - Use GetSize() to retrieve the size of the target data. - @retval EFI_NOT_FOUND The PCD service could not find the requested token number. + being set was incompatible with a call to this function. + Use GetSize() to retrieve the size of the target data. + @retval EFI_NOT_FOUND The PCD service could not find the requested token number. **/ typedef EFI_STATUS -(EFIAPI *PCD_PPI_SET8) ( +(EFIAPI *PCD_PPI_SET8)( IN UINTN TokenNumber, IN UINT8 Value ); @@ -380,25 +380,25 @@ EFI_STATUS /** - Sets an 16-bit value for a given PCD token. + Sets a 16-bit value for a given PCD token. When the PCD service sets a value, it will check to ensure that the size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. @param[in] TokenNumber The PCD token number. - @param[in] Value The value to set for the PCD token. + @param[in] Value The value to set for the PCD token. - @retval EFI_SUCCESS Procedure returned successfully. + @retval EFI_SUCCESS The procedure returned successfully. @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. - Use GetSize() to retrieve the size of the target data. - @retval EFI_NOT_FOUND The PCD service could not find the requested token number. + being set was incompatible with a call to this function. + Use GetSize() to retrieve the size of the target data. + @retval EFI_NOT_FOUND The PCD service could not find the requested token number. **/ typedef EFI_STATUS -(EFIAPI *PCD_PPI_SET16) ( +(EFIAPI *PCD_PPI_SET16)( IN UINTN TokenNumber, IN UINT16 Value ); @@ -406,25 +406,25 @@ EFI_STATUS /** - Sets an 32-bit value for a given PCD token. + Sets a 32-bit value for a given PCD token. When the PCD service sets a value, it will check to ensure that the size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. @param[in] TokenNumber The PCD token number. - @param[in] Value The value to set for the PCD token. + @param[in] Value The value to set for the PCD token. - @retval EFI_SUCCESS Procedure returned successfully. + @retval EFI_SUCCESS The procedure returned successfully. @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. - Use GetSize() to retrieve the size of the target data. - @retval EFI_NOT_FOUND The PCD service could not find the requested token number. + being set was incompatible with a call to this function. + Use GetSize() to retrieve the size of the target data. + @retval EFI_NOT_FOUND The PCD service could not find the requested token number. **/ typedef EFI_STATUS -(EFIAPI *PCD_PPI_SET32) ( +(EFIAPI *PCD_PPI_SET32)( IN UINTN TokenNumber, IN UINT32 Value ); @@ -432,32 +432,29 @@ EFI_STATUS /** - Sets an 64-bit value for a given PCD token. + Sets a 64-bit value for a given PCD token. When the PCD service sets a value, it will check to ensure that the size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. @param[in] TokenNumber The PCD token number. - @param[in] Value The value to set for the PCD token. + @param[in] Value The value to set for the PCD token. - @retval EFI_SUCCESS Procedure returned successfully. + @retval EFI_SUCCESS The procedure returned successfully. @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. - Use GetSize() to retrieve the size of the target data. - @retval EFI_NOT_FOUND The PCD service could not find the requested token number. + being set was incompatible with a call to this function. + Use GetSize() to retrieve the size of the target data. + @retval EFI_NOT_FOUND The PCD service could not find the requested token number. **/ typedef EFI_STATUS -(EFIAPI *PCD_PPI_SET64) ( +(EFIAPI *PCD_PPI_SET64)( IN UINTN TokenNumber, IN UINT64 Value ); - - - /** Sets a value of a specified size for a given PCD token. @@ -465,30 +462,28 @@ EFI_STATUS size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. - @param[in] TokenNumber The PCD token number. - @param[in, out] SizeOfBuffer A pointer to the length of the value being set for the PCD token. - On input, if the SizeOfValue is greater than the maximum size supported - for this TokenNumber then the output value of SizeOfValue will reflect - the maximum size supported for this TokenNumber. - @param[in] Buffer The buffer to set for the PCD token. + @param[in] TokenNumber The PCD token number. + @param[in, out] SizeOfValue A pointer to the length of the value being set for the PCD token. + On input, if the SizeOfValue is greater than the maximum size supported + for this TokenNumber then the output value of SizeOfValue will reflect + the maximum size supported for this TokenNumber. + @param[in] Buffer The buffer to set for the PCD token. - @retval EFI_SUCCESS Procedure returned successfully. + @retval EFI_SUCCESS The procedure returned successfully. @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. - Use GetSize() to retrieve the size of the target data. - @retval EFI_NOT_FOUND The PCD service could not find the requested token number. + being set was incompatible with a call to this function. + Use GetSize() to retrieve the size of the target data. + @retval EFI_NOT_FOUND The PCD service could not find the requested token number. **/ typedef EFI_STATUS -(EFIAPI *PCD_PPI_SET_POINTER) ( +(EFIAPI *PCD_PPI_SET_POINTER)( IN UINTN TokenNumber, - IN OUT UINTN *SizeOfBuffer, + IN OUT UINTN *SizeOfValue, IN VOID *Buffer ); - - /** Sets an Boolean value for a given PCD token. @@ -497,18 +492,18 @@ EFI_STATUS If it is not, an error will be returned. @param[in] TokenNumber The PCD token number. - @param[in] Value The value to set for the PCD token. + @param[in] Value The value to set for the PCD token. - @retval EFI_SUCCESS Procedure returned successfully. + @retval EFI_SUCCESS The procedure returned successfully. @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. - Use GetSize() to retrieve the size of the target data. - @retval EFI_NOT_FOUND The PCD service could not find the requested token number. + being set was incompatible with a call to this function. + Use GetSize() to retrieve the size of the target data. + @retval EFI_NOT_FOUND The PCD service could not find the requested token number. **/ typedef EFI_STATUS -(EFIAPI *PCD_PPI_SET_BOOLEAN) ( +(EFIAPI *PCD_PPI_SET_BOOLEAN)( IN UINTN TokenNumber, IN BOOLEAN Value ); @@ -522,107 +517,107 @@ EFI_STATUS size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. - @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. + @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. @param[in] TokenNumber The PCD token number. - @param[in] Value The value to set for the PCD token. + @param[in] Value The value to set for the PCD token. - @retval EFI_SUCCESS Procedure returned successfully. + @retval EFI_SUCCESS The procedure returned successfully. @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. - Use GetSize() to retrieve the size of the target data. - @retval EFI_NOT_FOUND The PCD service could not find the requested token number. + being set was incompatible with a call to this function. + Use GetSize() to retrieve the size of the target data. + @retval EFI_NOT_FOUND The PCD service could not find the requested token number. **/ typedef EFI_STATUS -(EFIAPI *PCD_PPI_SET_EX_8) ( +(EFIAPI *PCD_PPI_SET_EX_8)( IN CONST EFI_GUID *Guid, - IN UINTN TokenNumber, - IN UINT8 Value + IN UINTN TokenNumber, + IN UINT8 Value ); /** - Sets an 16-bit value for a given PCD token. + Sets a 16-bit value for a given PCD token. When the PCD service sets a value, it will check to ensure that the size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. - @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. + @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. @param[in] TokenNumber The PCD token number. - @param[in] Value The value to set for the PCD token. + @param[in] Value The value to set for the PCD token. - @retval EFI_SUCCESS Procedure returned successfully. + @retval EFI_SUCCESS The procedure returned successfully. @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. - Use GetSize() to retrieve the size of the target data. - @retval EFI_NOT_FOUND The PCD service could not find the requested token number. + being set was incompatible with a call to this function. + Use GetSize() to retrieve the size of the target data. + @retval EFI_NOT_FOUND The PCD service could not find the requested token number. **/ typedef EFI_STATUS -(EFIAPI *PCD_PPI_SET_EX_16) ( +(EFIAPI *PCD_PPI_SET_EX_16)( IN CONST EFI_GUID *Guid, - IN UINTN TokenNumber, - IN UINT16 Value + IN UINTN TokenNumber, + IN UINT16 Value ); /** - Sets an 32-bit value for a given PCD token. + Sets a 32-bit value for a given PCD token. When the PCD service sets a value, it will check to ensure that the size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. - @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. + @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. @param[in] TokenNumber The PCD token number. - @param[in] Value The value to set for the PCD token. + @param[in] Value The value to set for the PCD token. - @retval EFI_SUCCESS Procedure returned successfully. + @retval EFI_SUCCESS The procedure returned successfully. @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. - Use GetSize() to retrieve the size of the target data. - @retval EFI_NOT_FOUND The PCD service could not find the requested token number. + being set was incompatible with a call to this function. + Use GetSize() to retrieve the size of the target data. + @retval EFI_NOT_FOUND The PCD service could not find the requested token number. **/ typedef EFI_STATUS -(EFIAPI *PCD_PPI_SET_EX_32) ( +(EFIAPI *PCD_PPI_SET_EX_32)( IN CONST EFI_GUID *Guid, - IN UINTN TokenNumber, - IN UINT32 Value + IN UINTN TokenNumber, + IN UINT32 Value ); /** - Sets an 64-bit value for a given PCD token. + Sets a 64-bit value for a given PCD token. When the PCD service sets a value, it will check to ensure that the size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. - @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. + @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. @param[in] TokenNumber The PCD token number. - @param[in] Value The value to set for the PCD token. + @param[in] Value The value to set for the PCD token. - @retval EFI_SUCCESS Procedure returned successfully. + @retval EFI_SUCCESS The procedure returned successfully. @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. - Use GetSize() to retrieve the size of the target data. - @retval EFI_NOT_FOUND The PCD service could not find the requested token number. + being set was incompatible with a call to this function. + Use GetSize() to retrieve the size of the target data. + @retval EFI_NOT_FOUND The PCD service could not find the requested token number. **/ typedef EFI_STATUS -(EFIAPI *PCD_PPI_SET_EX_64) ( - IN CONST EFI_GUID *Guid, - IN UINTN TokenNumber, - IN UINT64 Value +(EFIAPI *PCD_PPI_SET_EX_64)( + IN CONST EFI_GUID *Guid, + IN UINTN TokenNumber, + IN UINT64 Value ); @@ -634,32 +629,30 @@ EFI_STATUS size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. - @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. - @param[in] TokenNumber The PCD token number. - @param[in, out] SizeOfBuffer A pointer to the length of the value being set for the PCD token. - On input, if the SizeOfValue is greater than the maximum size supported - for this TokenNumber then the output value of SizeOfValue will reflect - the maximum size supported for this TokenNumber. - @param[in] Buffer The buffer to set for the PCD token. + @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. + @param[in] TokenNumber The PCD token number. + @param[in, out] SizeOfValue A pointer to the length of the value being set for the PCD token. + On input, if the SizeOfValue is greater than the maximum size supported + for this TokenNumber then the output value of SizeOfValue will reflect + the maximum size supported for this TokenNumber. + @param[in] Buffer The buffer to set for the PCD token. - @retval EFI_SUCCESS Procedure returned successfully. + @retval EFI_SUCCESS The procedure returned successfully. @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. - Use GetSize() to retrieve the size of the target data. - @retval EFI_NOT_FOUND The PCD service could not find the requested token number. + being set was incompatible with a call to this function. + Use GetSize() to retrieve the size of the target data. + @retval EFI_NOT_FOUND The PCD service could not find the requested token number. **/ typedef EFI_STATUS -(EFIAPI *PCD_PPI_SET_EX_POINTER) ( - IN CONST EFI_GUID *Guid, - IN UINTN TokenNumber, - IN OUT UINTN *SizeOfBuffer, - IN VOID *Buffer +(EFIAPI *PCD_PPI_SET_EX_POINTER)( + IN CONST EFI_GUID *Guid, + IN UINTN TokenNumber, + IN OUT UINTN *SizeOfValue, + IN VOID *Buffer ); - - /** Sets an Boolean value for a given PCD token. @@ -667,23 +660,23 @@ EFI_STATUS size of the value being set is compatible with the Token's existing definition. If it is not, an error will be returned. - @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. + @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. @param[in] TokenNumber The PCD token number. - @param[in] Value The value to set for the PCD token. + @param[in] Value The value to set for the PCD token. - @retval EFI_SUCCESS Procedure returned successfully. + @retval EFI_SUCCESS The procedure returned successfully. @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data - being set was incompatible with a call to this function. - Use GetSize() to retrieve the size of the target data. - @retval EFI_NOT_FOUND The PCD service could not find the requested token number. + being set was incompatible with a call to this function. + Use GetSize() to retrieve the size of the target data. + @retval EFI_NOT_FOUND The PCD service could not find the requested token number. **/ typedef EFI_STATUS -(EFIAPI *PCD_PPI_SET_EX_BOOLEAN) ( - IN CONST EFI_GUID *Guid, - IN UINTN TokenNumber, - IN BOOLEAN Value +(EFIAPI *PCD_PPI_SET_EX_BOOLEAN)( + IN CONST EFI_GUID *Guid, + IN UINTN TokenNumber, + IN BOOLEAN Value ); @@ -698,21 +691,21 @@ EFI_STATUS callback function, TokenData will be used by PCD service PEIM to modify the internal data in PCD database. - @param[in] CallBackGuid The PCD token GUID being set. - @param[in] CallBackToken The PCD token number being set. - @param[in, out] TokenData A pointer to the token data being set. - @param[in] TokenDataSize The size, in bytes, of the data being set. + @param[in] CallBackGuid The PCD token GUID being set. + @param[in] CallBackToken The PCD token number being set. + @param[in, out] TokenData A pointer to the token data being set. + @param[in] TokenDataSize The size, in bytes, of the data being set. @retval VOID **/ typedef VOID -(EFIAPI *PCD_PPI_CALLBACK) ( - IN CONST EFI_GUID *CallBackGuid, OPTIONAL - IN UINTN CallBackToken, - IN OUT VOID *TokenData, - IN UINTN TokenDataSize +(EFIAPI *PCD_PPI_CALLBACK)( + IN CONST EFI_GUID *CallBackGuid, OPTIONAL + IN UINTN CallBackToken, + IN OUT VOID *TokenData, + IN UINTN TokenDataSize ); @@ -731,10 +724,10 @@ VOID **/ typedef EFI_STATUS -(EFIAPI *PCD_PPI_CALLBACK_ONSET) ( - IN CONST EFI_GUID *Guid, OPTIONAL - IN UINTN TokenNumber, - IN PCD_PPI_CALLBACK CallBackFunction +(EFIAPI *PCD_PPI_CALLBACK_ONSET)( + IN CONST EFI_GUID *Guid, OPTIONAL + IN UINTN TokenNumber, + IN PCD_PPI_CALLBACK CallBackFunction ); @@ -753,37 +746,44 @@ EFI_STATUS **/ typedef EFI_STATUS -(EFIAPI *PCD_PPI_CANCEL_CALLBACK) ( - IN CONST EFI_GUID *Guid, OPTIONAL - IN UINTN TokenNumber, - IN PCD_PPI_CALLBACK CallBackFunction +(EFIAPI *PCD_PPI_CANCEL_CALLBACK)( + IN CONST EFI_GUID *Guid, OPTIONAL + IN UINTN TokenNumber, + IN PCD_PPI_CALLBACK CallBackFunction ); /** - Retrieves the next valid PCD token for a given namespace. - - @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. + Retrieves the next valid token number in a given namespace. + + This is useful since the PCD infrastructure contains a sparse list of token numbers, + and one cannot a priori know what token numbers are valid in the database. + + If TokenNumber is 0 and Guid is not NULL, then the first token from the token space specified by Guid is returned. + If TokenNumber is not 0 and Guid is not NULL, then the next token in the token space specified by Guid is returned. + If TokenNumber is 0 and Guid is NULL, then the first token in the default token space is returned. + If TokenNumber is not 0 and Guid is NULL, then the next token in the default token space is returned. + The token numbers in the default token space may not be related to token numbers in token spaces that are named by Guid. + If the next token number can be retrieved, then it is returned in TokenNumber, and EFI_SUCCESS is returned. + If TokenNumber represents the last token number in the token space specified by Guid, then EFI_NOT_FOUND is returned. + If TokenNumber is not present in the token space specified by Guid, then EFI_NOT_FOUND is returned. + + + @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value. + This is an optional parameter that may be NULL. If this parameter is NULL, then a request + is being made to retrieve tokens from the default token space. @param[in, out] TokenNumber A pointer to the PCD token number to use to find the subsequent token number. - If the input token namespace or token number does not exist on the platform, an error is - returned and the value of *TokenNumber is undefined. To retrieve the "first" token, - have the pointer reference a TokenNumber value of 0. If the input token number is 0 - and there is no valid token number for this token namespace, *TokenNumber will be - assigned to 0 and the function return EFI_SUCCESS. If the token number is the last valid - token number, *TokenNumber will be assigned to 0 and the function return EFI_SUCCESS. - - @retval EFI_SUCCESS The PCD service has retrieved the next valid token number. - Or the input token number is already the last valid token number in the PCD database. - In the later case, *TokenNumber is updated with the value of 0. - @retval EFI_NOT_FOUND If this input token number and token namespace does not exist on the platform. + + @retval EFI_SUCCESS The PCD service has retrieved the next valid token number. + @retval EFI_NOT_FOUND The PCD service could not find data from the requested token number. **/ typedef EFI_STATUS -(EFIAPI *PCD_PPI_GET_NEXT_TOKEN) ( +(EFIAPI *PCD_PPI_GET_NEXT_TOKEN)( IN CONST EFI_GUID *Guid, OPTIONAL - IN OUT UINTN *TokenNumber + IN OUT UINTN *TokenNumber ); @@ -791,36 +791,30 @@ EFI_STATUS /** Retrieves the next valid PCD token namespace for a given namespace. - @param[in, out] Guid An indirect pointer to EFI_GUID. On input it designates a known - token namespace from which the search will start. On output, it designates - the next valid token namespace on the platform. If the input token namespace - does not exist on the platform, an error is returned and the value of *Guid is - undefined. If *Guid is NULL, then the GUID of the first token space of the - current platform is assigned to *Guid the function return EFI_SUCCESS. - If *Guid is NULL and there is no namespace exist in the platform other than the default - (NULL) tokennamespace, *Guid is unchanged and the function return EFI_SUCCESS. - If this input token namespace is the last namespace on the platform, - *Guid will be assigned to NULL and the function return EFI_SUCCESS. - - @retval EFI_SUCCESS The PCD service has retrieved the next valid token namespace. - Or the input token namespace is already the last valid token - number in the PCD database. In the later case, *Guid is updated - with the value of NULL. Or the input token name space is NULL and there - is no valid token namespace other than the default namespace (NULL). - @retval EFI_NOT_FOUND If the input token namespace does not exist on the platform. + Gets the next valid token namespace for a given namespace. This is useful to traverse the valid + token namespaces on a platform. + + @param[in, out] Guid An indirect pointer to EFI_GUID. On input it designates a known token + namespace from which the search will start. On output, it designates the next valid + token namespace on the platform. If *Guid is NULL, then the GUID of the first token + space of the current platform is returned. If the search cannot locate the next valid + token namespace, an error is returned and the value of *Guid is undefined. + + @retval EFI_SUCCESS The PCD service retrieved the value requested. + @retval EFI_NOT_FOUND The PCD service could not find the next valid token namespace. **/ typedef EFI_STATUS -(EFIAPI *PCD_PPI_GET_NEXT_TOKENSPACE) ( +(EFIAPI *PCD_PPI_GET_NEXT_TOKENSPACE)( IN OUT CONST EFI_GUID **Guid ); -// -// Interface structure for the PCD PPI -// +/// +/// This service abstracts the ability to set/get Platform Configuration Database (PCD). +/// typedef struct { PCD_PPI_SET_SKU SetSku; @@ -861,4 +855,6 @@ typedef struct { } PCD_PPI; +extern EFI_GUID gPcdPpiGuid; + #endif