/** @file\r
-PCD DXE driver\r
+ PCD DXE driver manage all PCD entry initialized in PEI phase and DXE phase, and\r
+ produce the implementation of PCD protocol.\r
\r
Copyright (c) 2006 - 2007, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
\r
#include "Service.h"\r
\r
+//\r
+// Just pre-allocate a memory buffer that is big enough to\r
+// host all distinct TokenSpace guid in both\r
+// PEI ExMap and DXE ExMap.\r
+//\r
+STATIC EFI_GUID *TmpTokenSpaceBuffer[PEI_EXMAPPING_TABLE_SIZE + DXE_EXMAPPING_TABLE_SIZE] = { 0 };\r
+\r
+///\r
+/// PCD database lock.\r
+///\r
EFI_LOCK mPcdDatabaseLock = EFI_INITIALIZE_LOCK_VARIABLE(TPL_CALLBACK);\r
\r
PCD_PROTOCOL mPcdInstance = {\r
//\r
// Static global to reduce the code size\r
//\r
-static EFI_HANDLE mNewHandle = NULL;\r
+STATIC EFI_HANDLE mNewHandle = NULL;\r
\r
+/**\r
+ Main entry for PCD DXE driver.\r
+ \r
+ This routine initialize the PCD database and install PCD_PROTOCOL.\r
+ \r
+ @param ImageHandle Image handle for PCD DXE driver.\r
+ @param SystemTable Pointer to SystemTable.\r
+\r
+ @return Status of gBS->InstallProtocolInterface()\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PcdDxeInit (\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
VOID\r
EFIAPI\r
DxePcdSetSku (\r
return;\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
return *((UINT8 *) GetWorker (TokenNumber, sizeof (UINT8)));\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
return ReadUnaligned16 (GetWorker (TokenNumber, sizeof (UINT16)));\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
return ReadUnaligned32 (GetWorker (TokenNumber, sizeof (UINT32)));\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
return ReadUnaligned64(GetWorker (TokenNumber, sizeof (UINT64)));\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
VOID *\r
EFIAPI\r
DxePcdGetPtr (\r
return GetWorker (TokenNumber, 0);\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
return *((BOOLEAN *) GetWorker (TokenNumber, sizeof (BOOLEAN)));\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
\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] ExTokenNumber 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 ExTokenNumber\r
+ IN UINTN ExTokenNumber\r
)\r
{\r
return *((UINT8 *) ExGetWorker (Guid, ExTokenNumber, sizeof(UINT8)));\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] ExTokenNumber 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
return ReadUnaligned16 (ExGetWorker (Guid, ExTokenNumber, sizeof(UINT16)));\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] ExTokenNumber 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
return ReadUnaligned32 (ExGetWorker (Guid, ExTokenNumber, sizeof(UINT32)));\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] ExTokenNumber 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
return ReadUnaligned64 (ExGetWorker (Guid, ExTokenNumber, sizeof(UINT64)));\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] ExTokenNumber The PCD token number. \r
\r
+ @return The pointer to the buffer to be retrived.\r
+ \r
+**/\r
VOID *\r
EFIAPI\r
DxePcdGetPtrEx (\r
return ExGetWorker (Guid, ExTokenNumber, 0);\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] ExTokenNumber The PCD token number. \r
+\r
+ @return The size Boolean value for the PCD token.\r
+ \r
+**/\r
BOOLEAN\r
EFIAPI\r
DxePcdGetBoolEx (\r
return *((BOOLEAN *) ExGetWorker (Guid, ExTokenNumber, sizeof(BOOLEAN)));\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] ExTokenNumber 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
return DxePcdGetSize(GetExPcdTokenNumber (Guid, (UINT32) ExTokenNumber));\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
return SetValueWorker (TokenNumber, &Value, sizeof (Value));\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
return SetValueWorker (TokenNumber, &Value, sizeof (Value));\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
return SetValueWorker (TokenNumber, &Value, sizeof (Value));\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
return SetValueWorker (TokenNumber, &Value, sizeof (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] 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
return SetWorker (TokenNumber, Buffer, SizeOfBuffer, TRUE);\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
return SetValueWorker (TokenNumber, &Value, sizeof (Value));\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] ExTokenNumber 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
return ExSetValueWorker (ExTokenNumber, Guid, &Value, sizeof (Value));\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] ExTokenNumber 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
return ExSetValueWorker (ExTokenNumber, Guid, &Value, sizeof (Value));\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] ExTokenNumber 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
return ExSetValueWorker (ExTokenNumber, Guid, &Value, sizeof (Value));\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] ExTokenNumber 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
return ExSetValueWorker (ExTokenNumber, Guid, &Value, sizeof (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] ExTokenNumber 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
return ExSetWorker(ExTokenNumber, Guid, Buffer, SizeOfBuffer, TRUE);\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] ExTokenNumber 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
return ExSetValueWorker (ExTokenNumber, Guid, &Value, sizeof (Value));\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
return Status;\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
return Status;\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, \r
+ an error is returned and the value of *TokenNumber is undefined. To retrieve the "first" token, \r
+ have the pointer reference a TokenNumber value of 0. If the input token number is 0 and \r
+ there is no valid token number for this token namespace, *TokenNumber will be assigned to \r
+ 0 and the function return EFI_SUCCESS. If the token number is the last valid token number, \r
+ *TokenNumber will be assigned to 0 and the function return EFI_SUCCESS.\r
\r
+ @retval EFI_SUCCESS The PCD service retrieved the 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
return Status;\r
}\r
\r
-STATIC\r
+/**\r
+ Get all token space guid table which is different with given token space guid.\r
+\r
+ @param ExMapTableSize The size of guid table\r
+ @param ExMapTable Token space guid table that want to be scaned.\r
+ @param GuidTable Guid table\r
+\r
+ @return all token space guid table which is different with given token space guid.\r
+\r
+**/\r
EFI_GUID **\r
GetDistinctTokenSpace (\r
IN OUT UINTN *ExMapTableSize,\r
\r
}\r
\r
-//\r
-// Just pre-allocate a memory buffer that is big enough to\r
-// host all distinct TokenSpace guid in both\r
-// PEI ExMap and DXE ExMap.\r
-//\r
-STATIC EFI_GUID *TmpTokenSpaceBuffer[PEI_EXMAPPING_TABLE_SIZE + DXE_EXMAPPING_TABLE_SIZE] = { 0 };\r
-\r
+/**\r
+ Get next token space in PCD database according to given token space guid.\r
+ \r
+ This routine is enable only when feature flag PCD PcdDxePcdDatabaseTraverseEnabled \r
+ is TRUE.\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_UNSUPPORTED If feature flag PCD PcdDxePcdDatabaseTraverseEnabled is FALSE.\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
}\r
\r
return EFI_NOT_FOUND;\r
-\r
}\r
\r
\r