/** @file\r
Private functions used by PCD DXE driver.\r
\r
-Copyright (c) 2006 - 2007, 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
+Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>\r
+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
-\r
-Module Name: Service.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 _SERVICE_H\r
-#define _SERVICE_H\r
+#ifndef _PCD_DXE_SERVICE_H_\r
+#define _PCD_DXE_SERVICE_H_\r
+\r
+#include <PiDxe.h>\r
+#include <Guid/PcdDataBaseHobGuid.h>\r
+#include <Guid/PcdDataBaseSignatureGuid.h>\r
+#include <Protocol/Pcd.h>\r
+#include <Protocol/PiPcd.h>\r
+#include <Library/BaseLib.h>\r
+#include <Library/DebugLib.h>\r
+#include <Library/UefiLib.h>\r
+#include <Library/UefiDriverEntryPoint.h>\r
+#include <Library/PcdLib.h>\r
+#include <Library/HobLib.h>\r
+#include <Library/MemoryAllocationLib.h>\r
+#include <Library/UefiBootServicesTableLib.h>\r
+#include <Library/BaseMemoryLib.h>\r
+#include <Library/UefiRuntimeServicesTableLib.h>\r
\r
//\r
-// Include common header file for this module.\r
+// Please make sure the PCD Serivce DXE Version is consistent with\r
+// the version of the generated DXE PCD Database by build tool.\r
//\r
-#include "CommonHeader.h"\r
+#define PCD_SERVICE_DXE_VERSION 4\r
\r
//\r
-// Please make sure the PCD Serivce PEIM Version is consistent with\r
-// the version of PCD Database generation tool\r
-//\r
-#define PCD_SERVICE_DXE_DRIVER_VERSION 2\r
-\r
+// PCD_DXE_SERVICE_DRIVER_VERSION is defined in Autogen.h.\r
//\r
-// PCD_DXE_DATABASE_GENTOOL_VERSION is defined in Autogen.h\r
-// and generated by PCD Database generation tool.\r
-//\r
-#if (PCD_SERVICE_DXE_DRIVER_VERSION != PCD_DXE_SERVICE_DRIVER_AUTOGEN_VERSION)\r
-// #error "Please make sure the version of PCD Service DXE Driver and PCD DXE Database Generation Tool matches"\r
+#if (PCD_SERVICE_DXE_VERSION != PCD_DXE_SERVICE_DRIVER_VERSION)\r
+ #error "Please make sure the version of PCD DXE Service and the generated PCD DXE Database match."\r
#endif\r
\r
//\r
// Protocol Interface function declaration.\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
+**/\r
VOID\r
EFIAPI\r
DxePcdSetSku (\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
UINT8\r
EFIAPI\r
DxePcdGet8 (\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
UINT16\r
EFIAPI\r
DxePcdGet16 (\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
UINT32\r
EFIAPI\r
DxePcdGet32 (\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
UINT64\r
EFIAPI\r
DxePcdGet64 (\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 retrieved.\r
+ \r
+**/\r
VOID *\r
EFIAPI\r
DxePcdGetPtr (\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
BOOLEAN\r
EFIAPI\r
DxePcdGetBool (\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
UINTN\r
EFIAPI\r
DxePcdGetSize (\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
UINT8\r
EFIAPI\r
DxePcdGet8Ex (\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
UINT16\r
EFIAPI\r
DxePcdGet16Ex (\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
UINT32\r
EFIAPI\r
DxePcdGet32Ex (\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
UINT64\r
EFIAPI\r
DxePcdGet64Ex (\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 retrieved.\r
+ \r
+**/\r
VOID *\r
EFIAPI\r
DxePcdGetPtrEx (\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
BOOLEAN\r
EFIAPI\r
DxePcdGetBoolEx (\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
UINTN\r
EFIAPI\r
DxePcdGetSizeEx (\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
EFI_STATUS\r
EFIAPI\r
DxePcdSet8 (\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
EFI_STATUS\r
EFIAPI\r
DxePcdSet16 (\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
EFI_STATUS\r
EFIAPI\r
DxePcdSet32 (\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
EFI_STATUS\r
EFIAPI\r
DxePcdSet64 (\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
EFI_STATUS\r
EFIAPI\r
DxePcdSetPtr (\r
IN UINTN TokenNumber,\r
- IN UINTN *SizeOfBuffer,\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
EFI_STATUS\r
EFIAPI\r
DxePcdSetBool (\r
IN UINTN TokenNumber,\r
IN BOOLEAN Value\r
- )\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
EFI_STATUS\r
EFIAPI\r
DxePcdSet8Ex (\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
EFI_STATUS\r
EFIAPI\r
DxePcdSet16Ex (\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
EFI_STATUS\r
EFIAPI\r
DxePcdSet32Ex (\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
EFI_STATUS\r
EFIAPI\r
DxePcdSet64Ex (\r
IN CONST EFI_GUID *Guid,\r
IN UINTN TokenNumber,\r
IN UINT64 Value\r
- )\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] 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
EFI_STATUS\r
EFIAPI\r
DxePcdSetPtrEx (\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
EFI_STATUS\r
EFIAPI\r
DxePcdSetBoolEx (\r
IN CONST EFI_GUID *Guid,\r
IN UINTN TokenNumber,\r
IN BOOLEAN Value\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] 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] 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
EFI_STATUS\r
EFIAPI\r
DxeRegisterCallBackOnSet (\r
IN CONST EFI_GUID *Guid, OPTIONAL\r
IN UINTN TokenNumber,\r
IN PCD_PROTOCOL_CALLBACK CallBackFunction\r
- )\r
-;\r
+ );\r
+\r
+/**\r
+ Cancels a previously set callback function for a particular PCD token number.\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] 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
EFI_STATUS\r
EFIAPI\r
DxeUnRegisterCallBackOnSet (\r
IN CONST EFI_GUID *Guid, OPTIONAL\r
IN UINTN TokenNumber,\r
IN PCD_PROTOCOL_CALLBACK CallBackFunction\r
- )\r
-;\r
-\r
+ );\r
+\r
+/**\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 retrieve the next token. \r
+ This is an optional parameter that may be NULL. If this parameter is NULL, then a request is \r
+ being made to retrieve tokens from the default token space.\r
+ @param[in, out] TokenNumber \r
+ A pointer to the PCD token number to use to find the subsequent token number. \r
+\r
+ @retval EFI_SUCCESS The PCD service retrieved the next valid token number. Or the input token number \r
+ is already the last valid token number in the PCD database. \r
+ In the later case, *TokenNumber is updated with the value of 0.\r
+ @retval EFI_NOT_FOUND If this input token number and token namespace does not exist on the platform.\r
\r
+**/\r
EFI_STATUS\r
EFIAPI\r
DxePcdGetNextToken (\r
IN CONST EFI_GUID *Guid, OPTIONAL\r
IN OUT UINTN *TokenNumber\r
- )\r
-;\r
-\r
-\r
-\r
+ );\r
+\r
+/**\r
+ Get next token space in PCD database according to given token space guid.\r
+ \r
+ @param Guid Given token space guid. If NULL, then Guid will be set to \r
+ the first PCD token space in PCD database, If not NULL, then\r
+ Guid will be set to next PCD token space.\r
+\r
+ @retval EFI_NOT_FOUND If PCD database has no token space table or can not find given\r
+ token space in PCD database.\r
+ @retval EFI_SUCCESS Success to get next token space guid.\r
+**/\r
EFI_STATUS\r
EFIAPI\r
DxePcdGetNextTokenSpace (\r
IN OUT CONST EFI_GUID **Guid\r
- )\r
-;\r
-\r
+ );\r
\r
typedef struct {\r
LIST_ENTRY Node;\r
PCD_PROTOCOL_CALLBACK CallbackFn;\r
} CALLBACK_FN_ENTRY;\r
\r
-#define CR_FNENTRY_FROM_LISTNODE(Record, Type, Field) _CR(Record, Type, Field)\r
+#define CR_FNENTRY_FROM_LISTNODE(Record, Type, Field) BASE_CR(Record, Type, Field)\r
\r
//\r
// Internal Functions\r
//\r
\r
+/**\r
+ Wrapper function for setting non-pointer type value for a PCD entry.\r
+\r
+ @param TokenNumber Pcd token number autogenerated by build tools.\r
+ @param Data Value want to be set for PCD entry\r
+ @param Size Size of value.\r
+\r
+ @return status of SetWorker.\r
+\r
+**/\r
EFI_STATUS\r
SetValueWorker (\r
IN UINTN TokenNumber,\r
IN VOID *Data,\r
IN UINTN Size\r
- )\r
-;\r
-\r
+ );\r
+\r
+/**\r
+ Set value for an PCD entry\r
+\r
+ @param TokenNumber Pcd token number autogenerated by build tools.\r
+ @param Data Value want to be set for PCD entry\r
+ @param Size Size of value.\r
+ @param PtrType If TRUE, the type of PCD entry's value is Pointer.\r
+ If False, the type of PCD entry's value is not Pointer.\r
+\r
+ @retval EFI_INVALID_PARAMETER If this PCD type is VPD, VPD PCD can not be set.\r
+ @retval EFI_INVALID_PARAMETER If Size can not be set to size table.\r
+ @retval EFI_INVALID_PARAMETER If Size of non-Ptr type PCD does not match the size information in PCD database. \r
+ @retval EFI_NOT_FOUND If value type of PCD entry is intergrate, but not in\r
+ range of UINT8, UINT16, UINT32, UINT64\r
+ @retval EFI_NOT_FOUND Can not find the PCD type according to token number. \r
+**/\r
EFI_STATUS\r
SetWorker (\r
IN UINTN TokenNumber,\r
IN VOID *Data,\r
IN OUT UINTN *Size,\r
IN BOOLEAN PtrType\r
- )\r
-;\r
+ );\r
+\r
+/**\r
+ Wrapper function for set PCD value for non-Pointer type dynamic-ex PCD.\r
\r
+ @param ExTokenNumber Token number for dynamic-ex PCD.\r
+ @param Guid Token space guid for dynamic-ex PCD.\r
+ @param Data Value want to be set.\r
+ @param SetSize The size of value.\r
\r
+ @return status of ExSetWorker().\r
+\r
+**/\r
EFI_STATUS\r
ExSetValueWorker (\r
IN UINTN ExTokenNumber,\r
IN CONST EFI_GUID *Guid,\r
IN VOID *Data,\r
IN UINTN SetSize\r
- )\r
-;\r
-\r
-\r
+ );\r
+\r
+/**\r
+ Set value for a dynamic PCD entry.\r
+ \r
+ This routine find the local token number according to dynamic-ex PCD's token \r
+ space guid and token number firstly, and invoke callback function if this PCD\r
+ entry registered callback function. Finally, invoken general SetWorker to set\r
+ PCD value.\r
+ \r
+ @param ExTokenNumber Dynamic-ex PCD token number.\r
+ @param Guid Token space guid for dynamic-ex PCD.\r
+ @param Data PCD value want to be set\r
+ @param SetSize Size of value.\r
+ @param PtrType If TRUE, this PCD entry is pointer type.\r
+ If FALSE, this PCD entry is not pointer type.\r
+\r
+ @return status of SetWorker().\r
\r
+**/\r
EFI_STATUS\r
ExSetWorker (\r
IN UINTN ExTokenNumber,\r
IN VOID *Data,\r
IN OUT UINTN *Size,\r
IN BOOLEAN PtrType\r
- )\r
-;\r
+ );\r
+\r
+/**\r
+ Get the PCD entry pointer in PCD database.\r
+ \r
+ This routine will visit PCD database to find the PCD entry according to given\r
+ token number. The given token number is autogened by build tools and it will be \r
+ translated to local token number. Local token number contains PCD's type and \r
+ offset of PCD entry in PCD database.\r
+\r
+ @param TokenNumber Token's number, it is autogened by build tools\r
+ @param GetSize The size of token's value\r
\r
+ @return PCD entry pointer in PCD database\r
\r
+**/\r
VOID *\r
GetWorker (\r
IN UINTN TokenNumber,\r
IN UINTN GetSize\r
- )\r
-;\r
+ );\r
+\r
+/**\r
+ Wrapper function for get PCD value for dynamic-ex PCD.\r
+\r
+ @param Guid Token space guid for dynamic-ex PCD.\r
+ @param ExTokenNumber Token number for dynamic-ex PCD.\r
+ @param GetSize The size of dynamic-ex PCD value.\r
+\r
+ @return PCD entry in PCD database.\r
\r
+**/\r
VOID *\r
ExGetWorker (\r
IN CONST EFI_GUID *Guid,\r
IN UINTN ExTokenNumber,\r
IN UINTN GetSize\r
- ) \r
-;\r
+ );\r
+\r
+/**\r
+ Find the local token number according to system SKU ID.\r
+\r
+ @param LocalTokenNumber PCD token number\r
+ @param Size The size of PCD entry.\r
+ @param IsPeiDb If TRUE, the PCD entry is initialized in PEI phase.\r
+ If False, the PCD entry is initialized in DXE phase.\r
\r
+ @return Token number according to system SKU ID.\r
+\r
+**/\r
UINT32\r
GetSkuEnabledTokenNumber (\r
UINT32 LocalTokenNumber,\r
UINTN Size,\r
BOOLEAN IsPeiDb\r
- ) \r
-;\r
+ );\r
\r
+/**\r
+ Get Variable which contains HII type PCD entry.\r
+\r
+ @param VariableGuid Variable's guid\r
+ @param VariableName Variable's unicode name string\r
+ @param VariableData Variable's data pointer, \r
+ @param VariableSize Variable's size.\r
+\r
+ @return the status of gRT->GetVariable\r
+**/\r
EFI_STATUS\r
GetHiiVariable (\r
IN EFI_GUID *VariableGuid,\r
IN UINT16 *VariableName,\r
OUT UINT8 **VariableData,\r
OUT UINTN *VariableSize\r
- )\r
-;\r
+ );\r
+\r
+/**\r
+ Set value for HII-type PCD.\r
\r
+ A HII-type PCD's value is stored in a variable. Setting/Getting the value of \r
+ HII-type PCD is to visit this variable.\r
+ \r
+ @param VariableGuid Guid of variable which stored value of a HII-type PCD.\r
+ @param VariableName Unicode name of variable which stored value of a HII-type PCD.\r
+ @param Data Value want to be set.\r
+ @param DataSize Size of value\r
+ @param Offset Value offset of HII-type PCD in variable.\r
+\r
+ @return status of GetVariable()/SetVariable().\r
+\r
+**/\r
EFI_STATUS\r
SetHiiVariable (\r
IN EFI_GUID *VariableGuid,\r
IN CONST VOID *Data,\r
IN UINTN DataSize,\r
IN UINTN Offset\r
- )\r
-;\r
+ );\r
+\r
+/**\r
+ Register the callback function for a PCD entry.\r
+\r
+ This routine will register a callback function to a PCD entry by given token number\r
+ and token space guid.\r
+ \r
+ @param TokenNumber PCD token's number, it is autogened by build tools.\r
+ @param Guid PCD token space's guid, \r
+ if not NULL, this PCD is dynamicEx type PCD.\r
+ @param CallBackFunction Callback function pointer\r
\r
+ @return EFI_SUCCESS Always success for registering callback function.\r
+\r
+**/\r
EFI_STATUS\r
DxeRegisterCallBackWorker (\r
IN UINTN TokenNumber,\r
IN CONST EFI_GUID *Guid, OPTIONAL\r
IN PCD_PROTOCOL_CALLBACK CallBackFunction\r
-);\r
+ );\r
+\r
+/**\r
+ UnRegister the callback function for a PCD entry.\r
+\r
+ This routine will unregister a callback function to a PCD entry by given token number\r
+ and token space guid.\r
\r
+ @param TokenNumber PCD token's number, it is autogened by build tools.\r
+ @param Guid PCD token space's guid.\r
+ if not NULL, this PCD is dynamicEx type PCD.\r
+ @param CallBackFunction Callback function pointer\r
+\r
+ @retval EFI_SUCCESS Callback function is success to be unregister.\r
+ @retval EFI_INVALID_PARAMETER Can not find the PCD entry by given token number.\r
+**/\r
EFI_STATUS\r
DxeUnRegisterCallBackWorker (\r
IN UINTN TokenNumber,\r
IN CONST EFI_GUID *Guid, OPTIONAL\r
IN PCD_PROTOCOL_CALLBACK CallBackFunction\r
-);\r
+ );\r
+\r
+/**\r
+ Initialize the PCD database in DXE phase.\r
+ \r
+ PCD database in DXE phase also contains PCD database in PEI phase which is copied\r
+ from GUID Hob.\r
\r
+**/\r
VOID\r
BuildPcdDxeDataBase (\r
VOID\r
-);\r
+ );\r
+\r
+/**\r
+ Get Token Number according to dynamic-ex PCD's {token space guid:token number}\r
\r
+ A dynamic-ex type PCD, developer must provide pair of token space guid: token number\r
+ in DEC file. PCD database maintain a mapping table that translate pair of {token\r
+ space guid: token number} to Token Number.\r
+ \r
+ @param Guid Token space guid for dynamic-ex PCD entry.\r
+ @param ExTokenNumber Dynamic-ex PCD token number.\r
\r
-UINTN \r
+ @return Token Number for dynamic-ex PCD.\r
+\r
+**/\r
+UINTN\r
GetExPcdTokenNumber (\r
IN CONST EFI_GUID *Guid,\r
IN UINT32 ExTokenNumber\r
- )\r
-;\r
-\r
+ );\r
+\r
+/**\r
+ Get next token number in given token space.\r
+ \r
+ This routine is used for dynamicEx type PCD. It will firstly scan token space\r
+ table to get token space according to given token space guid. Then scan given \r
+ token number in found token space, if found, then return next token number in \r
+ this token space.\r
+\r
+ @param Guid Token space guid. Next token number will be scaned in \r
+ this token space.\r
+ @param TokenNumber Token number. \r
+ If PCD_INVALID_TOKEN_NUMBER, return first token number in \r
+ token space table.\r
+ If not PCD_INVALID_TOKEN_NUMBER, return next token number\r
+ in token space table.\r
+ @param GuidTable Token space guid table. It will be used for scan token space\r
+ by given token space guid.\r
+ @param SizeOfGuidTable The size of guid table.\r
+ @param ExMapTable DynamicEx token number mapping table.\r
+ @param SizeOfExMapTable The size of dynamicEx token number mapping table.\r
+\r
+ @retval EFI_NOT_FOUND Can not given token space or token number.\r
+ @retval EFI_SUCCESS Success to get next token number.\r
\r
-\r
-EFI_STATUS \r
+**/\r
+EFI_STATUS\r
ExGetNextTokeNumber (\r
IN CONST EFI_GUID *Guid,\r
IN OUT UINTN *TokenNumber,\r
IN UINTN SizeOfGuidTable,\r
IN DYNAMICEX_MAPPING *ExMapTable,\r
IN UINTN SizeOfExMapTable\r
- )\r
-;\r
+ );\r
+\r
+/**\r
+ Get size of POINTER type PCD value.\r
+\r
+ @param LocalTokenNumberTableIdx Index of local token number in local token number table.\r
+ @param MaxSize Maximum size of POINTER type PCD value.\r
\r
+ @return size of POINTER type PCD value.\r
\r
+**/\r
UINTN\r
GetPtrTypeSize (\r
IN UINTN LocalTokenNumberTableIdx,\r
OUT UINTN *MaxSize\r
- )\r
-;\r
+ );\r
\r
+/**\r
+ Set size of POINTER type PCD value. The size should not exceed the maximum size\r
+ of this PCD value.\r
\r
+ @param LocalTokenNumberTableIdx Index of local token number in local token number table.\r
+ @param CurrentSize Size of POINTER type PCD value.\r
\r
+ @retval TRUE Success to set size of PCD value.\r
+ @retval FALSE Fail to set size of PCD value.\r
+**/\r
BOOLEAN\r
SetPtrTypeSize (\r
IN UINTN LocalTokenNumberTableIdx,\r
IN OUT UINTN *CurrentSize\r
- )\r
-;\r
+ );\r
\r
-extern EFI_GUID gPcdDataBaseHobGuid;\r
+extern PCD_DATABASE mPcdDatabase;\r
\r
-extern PCD_DATABASE * mPcdDatabase;\r
+extern UINT32 mPcdTotalTokenCount; \r
+extern UINT32 mPeiLocalTokenCount; \r
+extern UINT32 mDxeLocalTokenCount; \r
+extern UINT32 mPeiNexTokenCount; \r
+extern UINT32 mDxeNexTokenCount; \r
+extern UINT32 mPeiExMapppingTableSize;\r
+extern UINT32 mDxeExMapppingTableSize;\r
+extern UINT32 mPeiGuidTableSize;\r
+extern UINT32 mDxeGuidTableSize;\r
\r
-extern DXE_PCD_DATABASE_INIT gDXEPcdDbInit;\r
+extern BOOLEAN mPeiExMapTableEmpty; \r
+extern BOOLEAN mDxeExMapTableEmpty; \r
+extern BOOLEAN mPeiDatabaseEmpty;\r
+\r
+extern EFI_GUID **TmpTokenSpaceBuffer;\r
+extern UINTN TmpTokenSpaceBufferCount;\r
\r
extern EFI_LOCK mPcdDatabaseLock;\r
\r
#endif\r
+\r
projects / mirror_edk2.git / blobdiff