/** @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
/** @file\r
-Private functions used by PCD DXE driver.\r
+ Help 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
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
-Module Name: Service.c\r
-\r
**/\r
\r
#include "Service.h"\r
\r
-\r
PCD_DATABASE * mPcdDatabase;\r
\r
LIST_ENTRY *mCallbackFnTable;\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
- UINTN TokenNumber,\r
- UINTN GetSize\r
+ IN UINTN TokenNumber,\r
+ IN UINTN GetSize\r
)\r
{\r
UINT32 *LocalTokenNumberTable;\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 GUID *Guid, OPTIONAL\r
+ IN CONST EFI_GUID *Guid, OPTIONAL\r
IN PCD_PROTOCOL_CALLBACK CallBackFunction\r
)\r
{\r
return EFI_SUCCESS;\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 GUID *Guid, OPTIONAL\r
+ IN CONST EFI_GUID *Guid, OPTIONAL\r
IN PCD_PROTOCOL_CALLBACK CallBackFunction\r
)\r
{\r
return EFI_INVALID_PARAMETER;\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
+**/\r
EFI_STATUS\r
ExGetNextTokeNumber (\r
IN CONST EFI_GUID *Guid,\r
)\r
{\r
EFI_GUID *MatchGuid;\r
- UINTN Idx;\r
+ UINTN Index;\r
UINTN GuidTableIdx;\r
BOOLEAN Found;\r
\r
+ //\r
+ // Scan token space guid \r
+ // \r
MatchGuid = ScanGuid (GuidTable, SizeOfGuidTable, Guid);\r
if (MatchGuid == NULL) {\r
return EFI_NOT_FOUND;\r
}\r
\r
+ //\r
+ // Find the token space table in dynamicEx mapping table.\r
+ //\r
Found = FALSE;\r
GuidTableIdx = MatchGuid - GuidTable;\r
- for (Idx = 0; Idx < SizeOfExMapTable; Idx++) {\r
- if (ExMapTable[Idx].ExGuidIndex == GuidTableIdx) {\r
+ for (Index = 0; Index < SizeOfExMapTable; Index++) {\r
+ if (ExMapTable[Index].ExGuidIndex == GuidTableIdx) {\r
Found = TRUE;\r
break;\r
}\r
}\r
\r
if (Found) {\r
+ //\r
+ // If given token number is PCD_INVALID_TOKEN_NUMBER, then return the first\r
+ // token number in found token space.\r
+ //\r
if (*TokenNumber == PCD_INVALID_TOKEN_NUMBER) {\r
- *TokenNumber = ExMapTable[Idx].ExTokenNumber;\r
+ *TokenNumber = ExMapTable[Index].ExTokenNumber;\r
return EFI_SUCCESS;\r
}\r
\r
- for ( ; Idx < SizeOfExMapTable; Idx++) {\r
- if (ExMapTable[Idx].ExTokenNumber == *TokenNumber) {\r
- Idx++;\r
- if (Idx == SizeOfExMapTable) {\r
+ for ( ; Index < SizeOfExMapTable; Index++) {\r
+ if (ExMapTable[Index].ExTokenNumber == *TokenNumber) {\r
+ Index ++;\r
+ if (Index == SizeOfExMapTable) {\r
//\r
// Exceed the length of ExMap Table\r
//\r
*TokenNumber = PCD_INVALID_TOKEN_NUMBER;\r
return EFI_SUCCESS;\r
- } else if (ExMapTable[Idx].ExGuidIndex == GuidTableIdx) {\r
+ } else if (ExMapTable[Index].ExGuidIndex == GuidTableIdx) {\r
//\r
// Found the next match\r
//\r
- *TokenNumber = ExMapTable[Idx].ExTokenNumber;\r
+ *TokenNumber = ExMapTable[Index].ExTokenNumber;\r
return EFI_SUCCESS;\r
} else {\r
//\r
\r
return EFI_NOT_FOUND;\r
}\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
PEI_PCD_DATABASE *PeiDatabase;\r
EFI_HOB_GUID_TYPE *GuidHob;\r
- UINTN Idx;\r
+ UINTN Index;\r
\r
mPcdDatabase = AllocateZeroPool (sizeof(PCD_DATABASE));\r
ASSERT (mPcdDatabase != NULL);\r
// EBC compiler is very choosy. It may report warning about comparison\r
// between UINTN and 0 . So we add 1 in each size of the \r
// comparison.\r
- for (Idx = 0; Idx + 1 < PCD_TOTAL_TOKEN_NUMBER + 1; Idx++) {\r
- InitializeListHead (&mCallbackFnTable[Idx]);\r
+ for (Index = 0; Index + 1 < PCD_TOTAL_TOKEN_NUMBER + 1; Index++) {\r
+ InitializeListHead (&mCallbackFnTable[Index]);\r
}\r
- \r
- return;\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
Size = 0;\r
Buffer = NULL;\r
\r
+ //\r
+ // Firstly get the real size of HII variable\r
+ //\r
Status = gRT->GetVariable (\r
(UINT16 *)VariableName,\r
VariableGuid,\r
Buffer\r
);\r
\r
+ //\r
+ // Allocate buffer to hold whole variable data according to variable size.\r
+ //\r
if (Status == EFI_BUFFER_TOO_SMALL) {\r
Buffer = (UINT8 *) AllocatePool (Size);\r
\r
return Status;\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
{\r
SKU_HEAD *SkuHead;\r
SKU_ID *SkuIdTable;\r
- INTN i;\r
+ INTN Index;\r
UINT8 *Value;\r
SKU_ID *PhaseSkuIdTable;\r
UINT8 *PcdDb;\r
\r
SkuIdTable = &PhaseSkuIdTable[SkuHead->SkuIdTableOffset];\r
\r
- for (i = 0; i < SkuIdTable[0]; i++) {\r
- if (mPcdDatabase->PeiDb.Init.SystemSkuId == SkuIdTable[i + 1]) {\r
+ //\r
+ // Find the current system's SKU ID entry in SKU ID table.\r
+ //\r
+ for (Index = 0; Index < SkuIdTable[0]; Index++) {\r
+ if (mPcdDatabase->PeiDb.Init.SystemSkuId == SkuIdTable[Index + 1]) {\r
break;\r
}\r
}\r
- ASSERT (i < SkuIdTable[0]);\r
+ ASSERT (Index < SkuIdTable[0]);\r
\r
switch (LocalTokenNumber & PCD_TYPE_ALL_SET) {\r
case PCD_TYPE_VPD:\r
- Value = (UINT8 *) &(((VPD_HEAD *) Value)[i]);\r
+ Value = (UINT8 *) &(((VPD_HEAD *) Value)[Index]);\r
return (UINT32) ((Value - PcdDb) | PCD_TYPE_VPD);\r
\r
case PCD_TYPE_HII:\r
- Value = (UINT8 *) &(((VARIABLE_HEAD *) Value)[i]);\r
+ Value = (UINT8 *) &(((VARIABLE_HEAD *) Value)[Index]);\r
return (UINT32) ((Value - PcdDb) | PCD_TYPE_HII);\r
\r
case PCD_TYPE_STRING:\r
- Value = (UINT8 *) &(((STRING_HEAD *) Value)[i]);\r
+ Value = (UINT8 *) &(((STRING_HEAD *) Value)[Index]);\r
return (UINT32) ((Value - PcdDb) | PCD_TYPE_STRING);\r
\r
case PCD_TYPE_DATA:\r
- Value += Size * i;\r
+ Value += Size * Index;\r
return (UINT32) (Value - PcdDb);\r
\r
default:\r
\r
}\r
\r
+/**\r
+ Invoke the callback function when dynamic PCD entry was set, if this PCD entry \r
+ has registered callback function.\r
\r
+ @param ExTokenNumber DynamicEx PCD's token number, if this PCD entry is dyanmicEx\r
+ type PCD.\r
+ @param Guid DynamicEx PCD's guid, if this PCD entry is dynamicEx type\r
+ PCD.\r
+ @param TokenNumber PCD token number generated by build tools.\r
+ @param Data Value want to be set for this PCD entry\r
+ @param Size The size of value\r
\r
-\r
-STATIC\r
+**/\r
VOID\r
InvokeCallbackOnSet (\r
UINT32 ExTokenNumber,\r
}\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
}\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_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
\r
TmpTokenNumber = TokenNumber;\r
\r
+ //\r
// EBC compiler is very choosy. It may report warning about comparison\r
// between UINTN and 0 . So we add 1 in each size of the \r
// comparison.\r
-\r
+ //\r
ASSERT (TokenNumber + 1 < PCD_TOTAL_TOKEN_NUMBER + 1);\r
\r
if (!PtrType) {\r
ASSERT (*Size == DxePcdGetSize (TokenNumber + 1));\r
}\r
\r
+ //\r
// EBC compiler is very choosy. It may report warning about comparison\r
// between UINTN and 0 . So we add 1 in each size of the \r
// comparison.\r
+ //\r
IsPeiDb = (BOOLEAN) ((TokenNumber + 1 < PEI_LOCAL_TOKEN_NUMBER + 1) ? TRUE : FALSE);\r
\r
LocalTokenNumberTable = IsPeiDb ? mPcdDatabase->PeiDb.Init.LocalTokenNumberTable : \r
mPcdDatabase->DxeDb.Init.LocalTokenNumberTable;\r
\r
+ //\r
// EBC compiler is very choosy. It may report warning about comparison\r
// between UINTN and 0 . So we add 1 in each size of the \r
// comparison.\r
+ //\r
if ((TokenNumber + 1 < PEI_NEX_TOKEN_NUMBER + 1) ||\r
(TokenNumber + 1 >= PEI_LOCAL_TOKEN_NUMBER + 1 || TokenNumber + 1 < (PEI_LOCAL_TOKEN_NUMBER + DXE_NEX_TOKEN_NUMBER + 1))) {\r
InvokeCallbackOnSet (0, NULL, TokenNumber + 1, Data, *Size);\r
return Status;\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 dyanmic-ex PCD.\r
+ @param GetSize The size of dynamic-ex PCD value.\r
\r
+ @return PCD entry in PCD database.\r
\r
-\r
+**/\r
VOID *\r
ExGetWorker (\r
IN CONST EFI_GUID *Guid,\r
return GetWorker(GetExPcdTokenNumber (Guid, (UINT32) ExTokenNumber), GetSize);\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
return ExSetWorker (ExTokenNumber, Guid, Data, &SetSize, FALSE);\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
\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
return Status;\r
}\r
\r
+/**\r
+ Get local 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 local token number.\r
+ \r
+ @param Guid Token space guid for dynamic-ex PCD entry.\r
+ @param ExTokenNumber EDES_TODO: Add parameter description\r
\r
+ @return local token number for dynamic-ex PCD.\r
\r
-\r
+**/\r
UINTN \r
GetExPcdTokenNumber (\r
IN CONST EFI_GUID *Guid,\r
IN UINT32 ExTokenNumber\r
)\r
{\r
- UINT32 i;\r
+ UINT32 Index;\r
DYNAMICEX_MAPPING *ExMap;\r
EFI_GUID *GuidTable;\r
EFI_GUID *MatchGuid;\r
\r
MatchGuidIdx = MatchGuid - GuidTable;\r
\r
- for (i = 0; i < PEI_EXMAPPING_TABLE_SIZE; i++) {\r
- if ((ExTokenNumber == ExMap[i].ExTokenNumber) &&\r
- (MatchGuidIdx == ExMap[i].ExGuidIndex)) {\r
- return ExMap[i].LocalTokenNumber;\r
+ for (Index = 0; Index < PEI_EXMAPPING_TABLE_SIZE; Index++) {\r
+ if ((ExTokenNumber == ExMap[Index].ExTokenNumber) &&\r
+ (MatchGuidIdx == ExMap[Index].ExGuidIndex)) {\r
+ return ExMap[Index].LocalTokenNumber;\r
\r
}\r
}\r
\r
MatchGuidIdx = MatchGuid - GuidTable;\r
\r
- for (i = 0; i < DXE_EXMAPPING_TABLE_SIZE; i++) {\r
- if ((ExTokenNumber == ExMap[i].ExTokenNumber) &&\r
- (MatchGuidIdx == ExMap[i].ExGuidIndex)) {\r
- return ExMap[i].LocalTokenNumber;\r
+ for (Index = 0; Index < DXE_EXMAPPING_TABLE_SIZE; Index++) {\r
+ if ((ExTokenNumber == ExMap[Index].ExTokenNumber) &&\r
+ (MatchGuidIdx == ExMap[Index].ExGuidIndex)) {\r
+ return ExMap[Index].LocalTokenNumber;\r
}\r
}\r
\r
return 0;\r
}\r
\r
+/**\r
+ Get SKU ID tabble from PCD database.\r
+\r
+ @param LocalTokenNumberTableIdx Index of local token number in token number table.\r
+ @param IsPeiPcd If TRUE, \r
\r
-STATIC\r
+ @return Pointer to SKU ID array table\r
+\r
+**/\r
SKU_ID *\r
GetSkuIdArray (\r
IN UINTN LocalTokenNumberTableIdx,\r
}\r
\r
\r
-STATIC\r
+/**\r
+ Get index of PCD entry in size table.\r
+\r
+ @param LocalTokenNumberTableIdx Index of this PCD in local token number table.\r
+ @param LocalTokenNumberTable Pointer to local token number table in PCD database.\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 index of PCD entry in size table.\r
+\r
+**/\r
UINTN\r
GetSizeTableIndexA (\r
IN UINTN LocalTokenNumberTableIdx,\r
IN BOOLEAN IsPeiDb\r
)\r
{\r
- UINTN i;\r
+ UINTN Index;\r
UINTN SizeTableIdx;\r
UINTN LocalTokenNumber;\r
SKU_ID *SkuIdTable;\r
\r
SizeTableIdx = 0;\r
\r
- for (i=0; i<LocalTokenNumberTableIdx; i++) {\r
- LocalTokenNumber = LocalTokenNumberTable[i];\r
+ for (Index=0; Index<LocalTokenNumberTableIdx; Index++) {\r
+ LocalTokenNumber = LocalTokenNumberTable[Index];\r
\r
if ((LocalTokenNumber & PCD_DATUM_TYPE_ALL_SET) == PCD_DATUM_TYPE_POINTER) {\r
//\r
// SizeTable only contain record for PCD_DATUM_TYPE_POINTER type \r
// PCD entry.\r
//\r
- if (LocalTokenNumber & PCD_TYPE_VPD) {\r
+ if ((LocalTokenNumber & PCD_TYPE_VPD) != 0) {\r
//\r
// We have only one entry for VPD enabled PCD entry:\r
// 1) MAX Size.\r
// 1) MAX SIZE\r
// 2) Current Size for each SKU_ID (It is equal to MaxSku).\r
//\r
- SkuIdTable = GetSkuIdArray (i, IsPeiDb);\r
+ SkuIdTable = GetSkuIdArray (Index, IsPeiDb);\r
SizeTableIdx += (UINTN)*SkuIdTable + 1;\r
}\r
}\r
\r
\r
\r
-STATIC\r
+/**\r
+ Wrapper function of getting index of PCD entry in size table.\r
+ \r
+ @param LocalTokenNumberTableIdx Index of this PCD in local token number table.\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 index of PCD entry in size table.\r
+**/\r
UINTN\r
GetSizeTableIndex (\r
IN UINTN LocalTokenNumberTableIdx,\r
LocalTokenNumberTable = mPcdDatabase->DxeDb.Init.LocalTokenNumberTable;\r
}\r
return GetSizeTableIndexA (LocalTokenNumberTableIdx, \r
- LocalTokenNumberTable,\r
- IsPeiDb);\r
+ LocalTokenNumberTable,\r
+ IsPeiDb);\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 Maxmium 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
UINTN LocalTokenNumber;\r
SKU_ID *SkuIdTable;\r
SIZE_INFO *SizeTable;\r
- UINTN i;\r
+ UINTN Index;\r
BOOLEAN IsPeiDb;\r
UINT32 *LocalTokenNumberTable;\r
\r
// SizeTable only contain record for PCD_DATUM_TYPE_POINTER type \r
// PCD entry.\r
//\r
- if (LocalTokenNumber & PCD_TYPE_VPD) {\r
+ if ((LocalTokenNumber & PCD_TYPE_VPD) != 0) {\r
//\r
// We have only one entry for VPD enabled PCD entry:\r
// 1) MAX Size.\r
// 2) Current Size for each SKU_ID (It is equal to MaxSku).\r
//\r
SkuIdTable = GetSkuIdArray (LocalTokenNumberTableIdx, IsPeiDb);\r
- for (i = 0; i < SkuIdTable[0]; i++) {\r
- if (SkuIdTable[1 + i] == mPcdDatabase->PeiDb.Init.SystemSkuId) {\r
- return SizeTable[SizeTableIdx + 1 + i];\r
+ for (Index = 0; Index < SkuIdTable[0]; Index++) {\r
+ if (SkuIdTable[1 + Index] == mPcdDatabase->PeiDb.Init.SystemSkuId) {\r
+ return SizeTable[SizeTableIdx + 1 + Index];\r
}\r
}\r
return SizeTable[SizeTableIdx + 1];\r
}\r
}\r
\r
+/**\r
+ Set size of POINTER type PCD value. The size should not exceed the maxmium 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
UINTN LocalTokenNumber;\r
SKU_ID *SkuIdTable;\r
SIZE_INFO *SizeTable;\r
- UINTN i;\r
+ UINTN Index;\r
UINTN MaxSize;\r
BOOLEAN IsPeiDb;\r
UINT32 *LocalTokenNumberTable;\r
\r
+ //\r
// EBC compiler is very choosy. It may report warning about comparison\r
// between UINTN and 0 . So we add 1 in each size of the \r
// comparison.\r
+ //\r
IsPeiDb = (BOOLEAN) (LocalTokenNumberTableIdx + 1 < PEI_LOCAL_TOKEN_NUMBER + 1);\r
\r
if (IsPeiDb) {\r
// SizeTable only contain record for PCD_DATUM_TYPE_POINTER type \r
// PCD entry.\r
//\r
- if (LocalTokenNumber & PCD_TYPE_VPD) {\r
+ if ((LocalTokenNumber & PCD_TYPE_VPD) != 0) {\r
//\r
// We shouldn't come here as we don't support SET for VPD\r
//\r
// 2) Current Size for each SKU_ID (It is equal to MaxSku).\r
//\r
SkuIdTable = GetSkuIdArray (LocalTokenNumberTableIdx, IsPeiDb);\r
- for (i = 0; i < SkuIdTable[0]; i++) {\r
- if (SkuIdTable[1 + i] == mPcdDatabase->PeiDb.Init.SystemSkuId) {\r
- SizeTable[SizeTableIdx + 1 + i] = (SIZE_INFO) *CurrentSize;\r
+ for (Index = 0; Index < SkuIdTable[0]; Index++) {\r
+ if (SkuIdTable[1 + Index] == mPcdDatabase->PeiDb.Init.SystemSkuId) {\r
+ SizeTable[SizeTableIdx + 1 + Index] = (SIZE_INFO) *CurrentSize;\r
return TRUE;\r
}\r
}\r
}\r
}\r
}\r
-\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 <Protocol/Pcd.h>\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
+ @retval VOID\r
+\r
+**/\r
VOID\r
EFIAPI\r
DxePcdSetSku (\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
)\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
)\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
)\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
)\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
)\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
)\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] 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
)\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
)\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
)\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
)\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
VOID *\r
EFIAPI\r
DxePcdGetPtrEx (\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
)\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
)\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
)\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
)\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
)\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
;\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
+ 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
;\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
)\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
)\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
)\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
)\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
)\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
)\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
)\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
)\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
)\r
;\r
\r
-\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
\r
-\r
typedef struct {\r
LIST_ENTRY Node;\r
PCD_PROTOCOL_CALLBACK CallbackFn;\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
)\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_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
)\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
)\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
+**/\r
EFI_STATUS\r
ExSetWorker (\r
IN UINTN ExTokenNumber,\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
)\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 dyanmic-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
)\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
)\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
)\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
)\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
+/**\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
+/**\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
+/**\r
+ Get local 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 local token number.\r
+ \r
+ @param Guid Token space guid for dynamic-ex PCD entry.\r
+ @param ExTokenNumber EDES_TODO: Add parameter description\r
+\r
+ @return local token number for dynamic-ex PCD.\r
+\r
+**/\r
UINTN\r
GetExPcdTokenNumber (\r
IN CONST EFI_GUID *Guid,\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
+**/\r
EFI_STATUS\r
ExGetNextTokeNumber (\r
IN CONST EFI_GUID *Guid,\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 Maxmium 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
)\r
;\r
\r
+/**\r
+ Set size of POINTER type PCD value. The size should not exceed the maxmium 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
projects / mirror_edk2.git / commitdiff