--- /dev/null
+/** @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
+\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
+extern EFI_GUID gPcdPpiGuid;\r
+\r
+#define PCD_PPI_GUID \\r
+ { 0x6e81c58, 0x4ad7, 0x44bc, { 0x83, 0x90, 0xf1, 0x2, 0x65, 0xf7, 0x24, 0x80 } }\r
+\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
+ SetSku() sets the SKU Id to be used for subsequent calls to set or get PCD values. \r
+ SetSku() is normally called only once by the system.\r
+\r
+ For each item (token), the database can hold a single value that applies to all SKUs, \r
+ or multiple values, where each value is associated with a specific SKU Id. Items with multiple, \r
+ SKU-specific values are called SKU enabled. \r
+ \r
+ The SKU Id of zero is reserved as a default. The valid SkuId range is 1 to 255. \r
+ For tokens that are not SKU enabled, the system ignores any set SKU Id and works with the \r
+ single value for that token. For SKU-enabled tokens, the system will use the SKU Id set by the \r
+ last call to SetSku(). If no SKU Id is set or the currently set SKU Id isn't valid for the specified token, \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[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_PPI_SET_SKU) (\r
+ IN UINTN SkuId\r
+ );\r
+\r
+\r
+\r
+/**\r
+ Retrieves an 8-bit value for a given PCD token.\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[in] TokenNumber The PCD token number. \r
+\r
+ @return The UINT8 value.\r
+ \r
+**/\r
+typedef\r
+UINT8\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
+\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[in] TokenNumber The PCD token number. \r
+\r
+ @return The UINT16 value.\r
+ \r
+**/\r
+typedef\r
+UINT16\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
+\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[in] TokenNumber The PCD token number. \r
+\r
+ @return The UINT32 value.\r
+ \r
+**/\r
+typedef\r
+UINT32\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
+\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[in] TokenNumber The PCD token number. \r
+\r
+ @return The UINT64 value.\r
+ \r
+**/\r
+typedef\r
+UINT64\r
+(EFIAPI *PCD_PPI_GET64) (\r
+ IN UINTN TokenNumber\r
+ );\r
+\r
+\r
+\r
+/**\r
+ Retrieves a pointer to a value for a given PCD token.\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[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
+ IN UINTN TokenNumber\r
+ );\r
+\r
+\r
+\r
+/**\r
+ Retrieves a Boolean value for a given PCD token.\r
+\r
+ Retrieves the current boolean value 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[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
+ IN UINTN TokenNumber\r
+ );\r
+\r
+\r
+\r
+/**\r
+ Retrieves the size of the value for a given PCD token.\r
+\r
+ Retrieves the current size of a particular PCD token. \r
+ If the TokenNumber is invalid, the results are unpredictable.\r
+\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
+ IN UINTN TokenNumber\r
+ );\r
+\r
+\r
+\r
+/**\r
+ Retrieves an 8-bit value for a given PCD token.\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[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
+ IN CONST EFI_GUID *Guid,\r
+ IN UINTN TokenNumber\r
+ );\r
+\r
+\r
+\r
+/**\r
+ Retrieves an 16-bit value for a given PCD token.\r
+\r
+ Retrieves the 16-bit value of a particular PCD token. \r
+ If the TokenNumber is invalid or the token space\r
+ specified by Guid does not exist, the results are \r
+ unpredictable.\r
+\r
+ @param[in] Guid The token space for the token number.\r
+ @param[in] 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
+ IN CONST EFI_GUID *Guid,\r
+ IN UINTN TokenNumber\r
+ );\r
+\r
+\r
+\r
+/**\r
+ Retrieves an 32-bit value for a given PCD token.\r
+\r
+ Retrieves the 32-bit value of a particular PCD token. \r
+ If the TokenNumber is invalid or the token space\r
+ specified by Guid does not exist, the results are \r
+ unpredictable.\r
+\r
+ @param[in] Guid The token space for the token number.\r
+ @param[in] 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
+ IN CONST EFI_GUID *Guid,\r
+ IN UINTN TokenNumber\r
+ );\r
+\r
+\r
+\r
+/**\r
+ Retrieves an 64-bit value for a given PCD token.\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[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
+ IN CONST EFI_GUID *Guid,\r
+ IN UINTN TokenNumber\r
+ );\r
+\r
+\r
+\r
+/**\r
+ Retrieves a pointer to a value for a given PCD token.\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[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
+ IN CONST EFI_GUID *Guid,\r
+ IN UINTN TokenNumber\r
+ );\r
+\r
+\r
+\r
+/**\r
+ Retrieves an Boolean value for a given PCD token.\r
+\r
+ Retrieves the Boolean value of a particular PCD token. \r
+ If the TokenNumber is invalid or the token space\r
+ specified by Guid does not exist, the results are \r
+ unpredictable.\r
+\r
+ @param[in] Guid The token space for the token number.\r
+ @param[in] 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
+ IN CONST EFI_GUID *Guid,\r
+ IN UINTN TokenNumber\r
+ );\r
+\r
+\r
+\r
+/**\r
+ Retrieves the size of the value for a given PCD token.\r
+\r
+ Retrieves the current size of a particular PCD token. \r
+ If the TokenNumber is invalid, the results are unpredictable.\r
+\r
+ @param[in] Guid The token space for the token number.\r
+ @param[in] 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
+ IN CONST EFI_GUID *Guid,\r
+ IN UINTN TokenNumber\r
+ );\r
+\r
+\r
+\r
+/**\r
+ Sets an 8-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[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
+ 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
+ IN UINTN TokenNumber,\r
+ IN UINT8 Value\r
+ );\r
+\r
+\r
+\r
+/**\r
+ Sets an 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[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
+ 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
+ IN UINTN TokenNumber,\r
+ IN UINT16 Value\r
+ );\r
+\r
+\r
+\r
+/**\r
+ Sets an 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[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
+ 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
+ IN UINTN TokenNumber,\r
+ IN UINT32 Value\r
+ );\r
+\r
+\r
+\r
+/**\r
+ Sets an 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[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
+ 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
+ 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
+ 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[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
+ 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
+ IN UINTN TokenNumber,\r
+ IN OUT UINTN *SizeOfBuffer,\r
+ IN VOID *Buffer\r
+ );\r
+\r
+\r
+\r
+/**\r
+ Sets an Boolean value for a given PCD token.\r
+\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[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
+ 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
+ IN UINTN TokenNumber,\r
+ IN BOOLEAN Value\r
+ );\r
+\r
+\r
+\r
+/**\r
+ Sets an 8-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[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
+ 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
+ IN CONST EFI_GUID *Guid,\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
+\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[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
+ 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
+ IN CONST EFI_GUID *Guid,\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
+\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[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
+ 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
+ IN CONST EFI_GUID *Guid,\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
+\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[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
+ 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
+ );\r
+\r
+\r
+\r
+/**\r
+ Sets a value of a specified size 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[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
+ @param[in] TokenNumber The PCD token number. \r
+ @param[in, out] SizeOfBuffer A pointer to the length of the value being set for the PCD token. \r
+ On input, if the SizeOfValue is greater than the maximum size supported \r
+ for this TokenNumber then the output value of SizeOfValue will reflect \r
+ the maximum size supported for this TokenNumber.\r
+ @param[in] Buffer The buffer to set for the PCD token.\r
+\r
+ @retval EFI_SUCCESS 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
+ \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
+ );\r
+\r
+\r
+\r
+/**\r
+ Sets an Boolean value for a given PCD token.\r
+\r
+ When the PCD service sets a value, it will check to ensure that the \r
+ size of the value being set is compatible with the Token's existing definition. \r
+ If it is not, an error will be returned.\r
+\r
+ @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
+ @param[in] TokenNumber The PCD token number. \r
+ @param[in] 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
+ 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
+ );\r
+\r
+\r
+\r
+/**\r
+ Callback on SET function prototype definition.\r
+\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
+ );\r
+\r
+\r
+\r
+/**\r
+ Specifies a function to be called anytime the value of a designated token is changed.\r
+\r
+ @param[in] TokenNumber The PCD token number. \r
+ @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
+ @param[in] CallBackFunction The function prototype called when the value associated with the CallBackToken is set. \r
+\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_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
+/**\r
+ Cancels a previously set callback function for a particular PCD token number.\r
+\r
+ @param[in] TokenNumber The PCD token number. \r
+ @param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
+ @param[in] 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
+ @retval EFI_NOT_FOUND The PCD service could not find the referenced token number.\r
+\r
+**/\r
+typedef\r
+EFI_STATUS\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[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.\r
+ @param[in, out] TokenNumber A pointer to the PCD token number to use to find the subsequent token number.\r
+ If the input token namespace or token number does not exist on the platform, an error is \r
+ 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 \r
+ and there is no valid token number for this token namespace, *TokenNumber will be \r
+ assigned to 0 and the function return EFI_SUCCESS. If the token number is the last valid \r
+ token number, *TokenNumber will be assigned to 0 and the function return EFI_SUCCESS.\r
+\r
+ @retval EFI_SUCCESS The PCD service has retrieved the next valid token number. \r
+ Or the input token number 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_PPI_GET_NEXT_TOKEN) (\r
+ IN CONST EFI_GUID *Guid, OPTIONAL\r
+ IN OUT UINTN *TokenNumber\r
+ );\r
+\r
+\r
+\r
+/**\r
+ Retrieves the next valid PCD token namespace for a given namespace.\r
+\r
+ @param[in, out] Guid An indirect pointer to EFI_GUID. On input it designates a known \r
+ token namespace from which the search will start. On output, it designates \r
+ the next valid token namespace on the platform. If the input token namespace \r
+ does not exist on the platform, an error is returned and the value of *Guid is \r
+ undefined. If *Guid is NULL, then the GUID of the first token space of the \r
+ current platform is assigned to *Guid the function return EFI_SUCCESS. \r
+ If *Guid is NULL and there is no namespace exist in the platform other than the default \r
+ (NULL) tokennamespace, *Guid is unchanged and the function return EFI_SUCCESS. \r
+ If this input token namespace is the last namespace on the platform, \r
+ *Guid will be assigned to NULL and the function return EFI_SUCCESS.\r
+\r
+ @retval EFI_SUCCESS The PCD service has retrieved the next valid token namespace. \r
+ Or the input token namespace is already the last valid token \r
+ number in the PCD database. In the later case, *Guid is updated \r
+ with the value of NULL. Or the input token name space is NULL and there \r
+ is no valid token namespace other than the default namespace (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_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
+typedef struct {\r
+ PCD_PPI_SET_SKU SetSku;\r
+\r
+ PCD_PPI_GET8 Get8;\r
+ PCD_PPI_GET16 Get16;\r
+ PCD_PPI_GET32 Get32;\r
+ PCD_PPI_GET64 Get64;\r
+ PCD_PPI_GET_POINTER GetPtr;\r
+ PCD_PPI_GET_BOOLEAN GetBool;\r
+ PCD_PPI_GET_SIZE GetSize;\r
+\r
+ PCD_PPI_GET_EX_8 Get8Ex;\r
+ PCD_PPI_GET_EX_16 Get16Ex;\r
+ PCD_PPI_GET_EX_32 Get32Ex;\r
+ PCD_PPI_GET_EX_64 Get64Ex;\r
+ PCD_PPI_GET_EX_POINTER GetPtrEx;\r
+ PCD_PPI_GET_EX_BOOLEAN GetBoolEx;\r
+ PCD_PPI_GET_EX_SIZE GetSizeEx;\r
+\r
+ PCD_PPI_SET8 Set8;\r
+ PCD_PPI_SET16 Set16;\r
+ PCD_PPI_SET32 Set32;\r
+ PCD_PPI_SET64 Set64;\r
+ PCD_PPI_SET_POINTER SetPtr;\r
+ PCD_PPI_SET_BOOLEAN SetBool;\r
+\r
+ PCD_PPI_SET_EX_8 Set8Ex;\r
+ PCD_PPI_SET_EX_16 Set16Ex;\r
+ PCD_PPI_SET_EX_32 Set32Ex;\r
+ PCD_PPI_SET_EX_64 Set64Ex;\r
+ PCD_PPI_SET_EX_POINTER SetPtrEx;\r
+ PCD_PPI_SET_EX_BOOLEAN SetBoolEx;\r
+\r
+ PCD_PPI_CALLBACK_ONSET CallbackOnSet;\r
+ PCD_PPI_CANCEL_CALLBACK CancelCallback;\r
+ PCD_PPI_GET_NEXT_TOKEN GetNextToken;\r
+ PCD_PPI_GET_NEXT_TOKENSPACE GetNextTokenSpace;\r
+} PCD_PPI;\r
+\r
+\r
+#endif\r
projects / mirror_edk2.git / blobdiff