/** @file\r
A emptry template implementation of PCD Library.\r
\r
- Copyright (c) 2006, Intel Corporation\r
+ Copyright (c) 2006 - 2008, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
- Module Name: PcdLib.c\r
-\r
**/\r
\r
+#include <Base.h>\r
+\r
+#include <Library/DebugLib.h>\r
+#include <Library/PcdLib.h>\r
+#include <Library/BaseMemoryLib.h>\r
\r
\r
/**\r
+ This function provides a means by which SKU support can be established in the PCD infrastructure.\r
+\r
Sets the current SKU in the PCD database to the value specified by SkuId. SkuId is returned.\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
+ set values associated with a PCD token.\r
+ \r
+ If SkuId >= 0x100, then ASSERT(). \r
\r
- @retval SKU_ID Return the SKU ID that just be set.\r
+ @return Return the SKU ID that just be set.\r
\r
**/\r
-UINTN \r
+UINTN\r
EFIAPI\r
LibPcdSetSku (\r
- IN UINTN SkuId\r
+ IN UINTN SkuId\r
)\r
{\r
- ASSERT (SkuId < 0x100);\r
+ ASSERT (FALSE);\r
\r
- return SkuId;\r
+ return 0;\r
}\r
\r
-\r
-\r
/**\r
+ This function provides a means by which to retrieve a value for a given PCD token.\r
+ \r
Returns the 8-bit value for the token specified by TokenNumber. \r
\r
- @param[in] The PCD token number to retrieve a current value for.\r
+ @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval UINT8 Returns the 8-bit value for the token specified by TokenNumber. \r
+ @return Returns the 8-bit value for the token specified by TokenNumber. \r
\r
**/\r
UINT8\r
IN UINTN TokenNumber\r
)\r
{\r
+ ASSERT (FALSE);\r
+\r
return 0;\r
}\r
\r
\r
\r
/**\r
+ This function provides a means by which to retrieve a value for a given PCD token.\r
+ \r
Returns the 16-bit value for the token specified by TokenNumber. \r
\r
- @param[in] The PCD token number to retrieve a current value for.\r
+ @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval UINT16 Returns the 16-bit value for the token specified by TokenNumber. \r
+ @return Returns the 16-bit value for the token specified by TokenNumber. \r
\r
**/\r
UINT16\r
IN UINTN TokenNumber\r
)\r
{\r
+ ASSERT (FALSE);\r
+\r
return 0;\r
}\r
\r
\r
\r
/**\r
+ This function provides a means by which to retrieve a value for a given PCD token.\r
+ \r
Returns the 32-bit value for the token specified by TokenNumber. \r
\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval UINT32 Returns the 32-bit value for the token specified by TokenNumber.\r
+ @return Returns the 32-bit value for the token specified by TokenNumber.\r
\r
**/\r
UINT32\r
IN UINTN TokenNumber\r
)\r
{\r
+ ASSERT (FALSE);\r
+\r
return 0;\r
}\r
\r
\r
\r
/**\r
+ This function provides a means by which to retrieve a value for a given PCD token.\r
+ \r
Returns the 64-bit value for the token specified by TokenNumber.\r
\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval UINT64 Returns the 64-bit value for the token specified by TokenNumber.\r
+ @return Returns the 64-bit value for the token specified by TokenNumber.\r
\r
**/\r
UINT64\r
IN UINTN TokenNumber\r
)\r
{\r
+ ASSERT (FALSE);\r
+\r
return 0;\r
}\r
\r
\r
\r
/**\r
+ This function provides a means by which to retrieve a value for a given PCD token.\r
+ \r
Returns the pointer to the buffer of the token specified by TokenNumber.\r
\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval VOID* Returns the pointer to the token specified by TokenNumber.\r
+ @return Returns the pointer to the token specified by TokenNumber.\r
\r
**/\r
VOID *\r
IN UINTN TokenNumber\r
)\r
{\r
+ ASSERT (FALSE);\r
+\r
return 0;\r
}\r
\r
\r
\r
/**\r
+ This function provides a means by which to retrieve a value for a given PCD token.\r
+ \r
Returns the Boolean value of the token specified by TokenNumber. \r
\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval BOOLEAN Returns the Boolean value of the token specified by TokenNumber. \r
+ @return Returns the Boolean value of the token specified by TokenNumber. \r
\r
**/\r
BOOLEAN \r
IN UINTN TokenNumber\r
)\r
{\r
+ ASSERT (FALSE);\r
+\r
return 0;\r
}\r
\r
\r
\r
/**\r
- Returns the size of the token specified by TokenNumber. \r
+ This function provides a means by which to retrieve the size of a given PCD token.\r
\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval UINTN Returns the size of the token specified by TokenNumber. \r
+ @return Returns the size of the token specified by TokenNumber. \r
\r
**/\r
UINTN\r
IN UINTN TokenNumber\r
)\r
{\r
+ ASSERT (FALSE);\r
+\r
return 0;\r
}\r
\r
\r
\r
/**\r
+ This function provides a means by which to retrieve a value for a given PCD token.\r
+ \r
Returns the 8-bit value for the token specified by TokenNumber and Guid.\r
+ \r
If Guid is NULL, then ASSERT(). \r
\r
@param[in] Guid Pointer to a 128-bit unique value that designates \r
which namespace to retrieve a value from.\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval UINT8 Return the UINT8.\r
+ @return Return the UINT8.\r
\r
**/\r
UINT8\r
IN UINTN TokenNumber\r
)\r
{\r
- ASSERT (Guid != NULL);\r
+ ASSERT (FALSE);\r
\r
return 0;\r
}\r
\r
\r
/**\r
+ This function provides a means by which to retrieve a value for a given PCD token.\r
+\r
Returns the 16-bit value for the token specified by TokenNumber and Guid.\r
+ \r
If Guid is NULL, then ASSERT(). \r
\r
@param[in] Guid Pointer to a 128-bit unique value that designates \r
which namespace to retrieve a value from.\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval UINT16 Return the UINT16.\r
+ @return Return the UINT16.\r
\r
**/\r
UINT16\r
IN UINTN TokenNumber\r
)\r
{\r
- ASSERT (Guid != NULL);\r
+ ASSERT (FALSE);\r
\r
return 0;\r
}\r
which namespace to retrieve a value from.\r
@param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval UINT32 Return the UINT32.\r
+ @return Return the UINT32.\r
\r
**/\r
UINT32\r
IN UINTN TokenNumber\r
)\r
{\r
- ASSERT (Guid != NULL);\r
+ ASSERT (FALSE);\r
\r
return 0;\r
}\r
\r
\r
/**\r
+ This function provides a means by which to retrieve a value for a given PCD token.\r
+ \r
Returns the 64-bit value for the token specified by TokenNumber and Guid.\r
+ \r
If Guid is NULL, then ASSERT(). \r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates \r
- which namespace to retrieve a value from.\r
- @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
+ @param[in] Guid Pointer to a 128-bit unique value that designates \r
+ which namespace to retrieve a value from.\r
+ @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval UINT64 Return the UINT64.\r
+ @return Return the UINT64.\r
\r
**/\r
UINT64\r
IN UINTN TokenNumber\r
)\r
{\r
- ASSERT (Guid != NULL);\r
+ ASSERT (FALSE);\r
\r
return 0;\r
}\r
\r
\r
/**\r
- Returns the pointer to the buffer of the token specified by TokenNumber and Guid.\r
+ This function provides a means by which to retrieve a value for a given PCD token.\r
+ \r
+ Returns the pointer to the buffer of token specified by TokenNumber and Guid.\r
+ \r
If Guid is NULL, then ASSERT(). \r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates \r
- which namespace to retrieve a value from.\r
- @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
+ @param[in] Guid Pointer to a 128-bit unique value that designates \r
+ which namespace to retrieve a value from.\r
+ @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval VOID* Return the VOID* pointer.\r
+ @return Return the VOID* pointer.\r
\r
**/\r
VOID *\r
IN UINTN TokenNumber\r
)\r
{\r
- ASSERT (Guid != NULL);\r
+ ASSERT (FALSE);\r
\r
return 0;\r
}\r
\r
\r
/**\r
+ This function provides a means by which to retrieve a value for a given PCD token.\r
+ \r
Returns the Boolean value of the token specified by TokenNumber and Guid. \r
+ \r
If Guid is NULL, then ASSERT(). \r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates \r
- which namespace to retrieve a value from.\r
- @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
+ @param[in] Guid Pointer to a 128-bit unique value that designates \r
+ which namespace to retrieve a value from.\r
+ @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval BOOLEAN Return the BOOLEAN.\r
+ @return Return the BOOLEAN.\r
\r
**/\r
BOOLEAN\r
IN UINTN TokenNumber\r
)\r
{\r
- ASSERT (Guid != NULL);\r
+ ASSERT (FALSE);\r
\r
return 0;\r
}\r
\r
\r
/**\r
+ This function provides a means by which to retrieve the size of a given PCD token.\r
+ \r
Returns the size of the token specified by TokenNumber and Guid. \r
+ \r
If Guid is NULL, then ASSERT(). \r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates \r
- which namespace to retrieve a value from.\r
- @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
+ @param[in] Guid Pointer to a 128-bit unique value that designates \r
+ which namespace to retrieve a value from.\r
+ @param[in] TokenNumber The PCD token number to retrieve a current value for.\r
\r
- @retval UINTN Return the size.\r
+ @return Return the size.\r
\r
**/\r
UINTN\r
IN UINTN TokenNumber\r
)\r
{\r
- ASSERT (Guid != NULL);\r
+ ASSERT (FALSE);\r
\r
return 0;\r
}\r
\r
\r
/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
+ \r
Sets the 8-bit value for the token specified by TokenNumber \r
to the value specified by Value. Value is returned.\r
\r
- @param[in] TokenNumber The PCD token number to set a current value for.\r
- @param[in] Value The 8-bit value to set.\r
+ @param[in] TokenNumber The PCD token number to set a current value for.\r
+ @param[in] Value The 8-bit value to set.\r
\r
- @retval UINT8 Return the value been set.\r
+ @return Return the value been set.\r
\r
**/\r
UINT8\r
IN UINT8 Value\r
)\r
{\r
- return Value;\r
+ ASSERT (FALSE);\r
+\r
+ return 0;\r
}\r
\r
\r
\r
/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
+ \r
Sets the 16-bit value for the token specified by TokenNumber \r
to the value specified by Value. Value is returned.\r
\r
- @param[in] TokenNumber The PCD token number to set a current value for.\r
- @param[in] Value The 16-bit value to set.\r
+ @param[in] TokenNumber The PCD token number to set a current value for.\r
+ @param[in] Value The 16-bit value to set.\r
\r
- @retval UINT16 Return the value been set.\r
+ @return Return the value been set.\r
\r
**/\r
UINT16\r
IN UINT16 Value\r
)\r
{\r
- return Value;\r
+ ASSERT (FALSE);\r
+\r
+ return 0;\r
}\r
\r
\r
\r
/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
+ \r
Sets the 32-bit value for the token specified by TokenNumber \r
to the value specified by Value. Value is returned.\r
\r
- @param[in] TokenNumber The PCD token number to set a current value for.\r
- @param[in] Value The 32-bit value to set.\r
+ @param[in] TokenNumber The PCD token number to set a current value for.\r
+ @param[in] Value The 32-bit value to set.\r
\r
- @retval UINT32 Return the value been set.\r
+ @return Return the value been set.\r
\r
**/\r
UINT32\r
EFIAPI\r
LibPcdSet32 (\r
- IN UINTN TokenNumber,\r
- IN UINT32 Value\r
+ IN UINTN TokenNumber,\r
+ IN UINT32 Value\r
)\r
{\r
- return Value;\r
+ ASSERT (FALSE);\r
+\r
+ return 0;\r
}\r
\r
\r
\r
/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
+ \r
Sets the 64-bit value for the token specified by TokenNumber \r
to the value specified by Value. Value is returned.\r
\r
- @param[in] TokenNumber The PCD token number to set a current value for.\r
- @param[in] Value The 64-bit value to set.\r
+ @param[in] TokenNumber The PCD token number to set a current value for.\r
+ @param[in] Value The 64-bit value to set.\r
\r
- @retval UINT64 Return the value been set.\r
+ @return Return the value been set.\r
\r
**/\r
UINT64\r
EFIAPI\r
LibPcdSet64 (\r
- IN UINTN TokenNumber,\r
- IN UINT64 Value\r
+ IN UINTN TokenNumber,\r
+ IN UINT64 Value\r
)\r
{\r
- return Value;\r
+ ASSERT (FALSE);\r
+\r
+ return 0;\r
}\r
\r
\r
\r
/**\r
- Sets a buffer for the token specified by TokenNumber to \r
- the value specified by Buffer and SizeOfValue. Buffer to\r
- be set is returned. The content of the buffer could be \r
- overwritten if a Callback on SET is registered with this\r
- TokenNumber.\r
+ This function provides a means by which to set a value for a given PCD token.\r
\r
- If SizeOfValue is greater than the maximum \r
- size support by TokenNumber, then set SizeOfValue to the \r
- maximum size supported by TokenNumber and return NULL to \r
- indicate that the set operation was not actually performed. \r
+ Sets a buffer for the token specified by TokenNumber to the value \r
+ specified by Buffer and SizeOfBuffer. Buffer is returned. \r
+ If SizeOfBuffer is greater than the maximum size support by TokenNumber, \r
+ then set SizeOfBuffer to the maximum size supported by TokenNumber and \r
+ return NULL to indicate that the set operation was not actually performed. \r
+\r
+ If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to the \r
+ maximum size supported by TokenName and NULL must be returned.\r
\r
- If SizeOfValue > 0 and Buffer is NULL, then ASSERT().\r
+ If SizeOfBuffer is NULL, then ASSERT().\r
+ If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
\r
- @param[in] TokenNumber The PCD token number to set a current value for.\r
- @param[in,out] SizeOfBuffer The size, in bytes, of Buffer.\r
- @param[in] Value A pointer to the buffer to set.\r
+ @param[in] TokenNumber The PCD token number to set a current value for.\r
+ @param[in, out] SizeOfBuffer The size, in bytes, of Buffer.\r
+ @param[in] Buffer A pointer to the buffer to set.\r
\r
- @retval VOID* Return the pointer for the buffer been set.\r
+ @return Return the pointer for the buffer been set.\r
\r
**/\r
VOID *\r
EFIAPI\r
LibPcdSetPtr (\r
- IN UINTN TokenNumber,\r
- IN OUT UINTN *SizeOfBuffer,\r
- IN VOID *Buffer\r
+ IN UINTN TokenNumber,\r
+ IN OUT UINTN *SizeOfBuffer,\r
+ IN CONST VOID *Buffer\r
)\r
{\r
- if (*SizeOfBuffer > 0) {\r
- ASSERT (Buffer != NULL);\r
- }\r
+ ASSERT (FALSE);\r
\r
- return Buffer;\r
+ return NULL;\r
}\r
\r
\r
\r
/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
+ \r
Sets the Boolean value for the token specified by TokenNumber \r
to the value specified by Value. Value is returned.\r
\r
- @param[in] TokenNumber The PCD token number to set a current value for.\r
- @param[in] Value The boolean value to set.\r
+ @param[in] TokenNumber The PCD token number to set a current value for.\r
+ @param[in] Value The boolean value to set.\r
\r
- @retval BOOLEAN Return the value been set.\r
+ @return Return the value been set.\r
\r
**/\r
BOOLEAN\r
IN BOOLEAN Value\r
)\r
{\r
- return Value;\r
+ ASSERT (FALSE);\r
+\r
+ return FALSE;\r
}\r
\r
\r
\r
/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
+ \r
Sets the 8-bit value for the token specified by TokenNumber and \r
Guid to the value specified by Value. Value is returned.\r
+ \r
If Guid is NULL, then ASSERT().\r
\r
- @param[in] Guid Pointer to a 128-bit unique value that \r
- designates which namespace to set a value from.\r
- @param[in] TokenNumber The PCD token number to set a current value for.\r
- @param[in] Value The 8-bit value to set.\r
+ @param[in] Guid Pointer to a 128-bit unique value that \r
+ designates which namespace to set a value from.\r
+ @param[in] TokenNumber The PCD token number to set a current value for.\r
+ @param[in] Value The 8-bit value to set.\r
\r
- @retval UINT8 Return the value been set.\r
+ @return Return the value been set.\r
\r
**/\r
UINT8\r
IN UINT8 Value\r
)\r
{\r
- ASSERT (Guid != NULL);\r
+ ASSERT (FALSE);\r
\r
- return Value;\r
+ return 0;\r
}\r
\r
\r
\r
/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
+ \r
Sets the 16-bit value for the token specified by TokenNumber and \r
Guid to the value specified by Value. Value is returned.\r
+ \r
If Guid is NULL, then ASSERT().\r
\r
- @param[in] Guid Pointer to a 128-bit unique value that \r
- designates which namespace to set a value from.\r
- @param[in] TokenNumber The PCD token number to set a current value for.\r
- @param[in] Value The 16-bit value to set.\r
+ @param[in] Guid Pointer to a 128-bit unique value that \r
+ designates which namespace to set a value from.\r
+ @param[in] TokenNumber The PCD token number to set a current value for.\r
+ @param[in] Value The 16-bit value to set.\r
\r
- @retval UINT8 Return the value been set.\r
+ @return Return the value been set.\r
\r
**/\r
UINT16\r
IN UINT16 Value\r
)\r
{\r
- ASSERT (Guid != NULL);\r
+ ASSERT (FALSE);\r
\r
- return Value;\r
+ return 0;\r
}\r
\r
\r
\r
/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
+ \r
Sets the 32-bit value for the token specified by TokenNumber and \r
Guid to the value specified by Value. Value is returned.\r
+ \r
If Guid is NULL, then ASSERT().\r
\r
- @param[in] Guid Pointer to a 128-bit unique value that \r
- designates which namespace to set a value from.\r
- @param[in] TokenNumber The PCD token number to set a current value for.\r
- @param[in] Value The 32-bit value to set.\r
+ @param[in] Guid Pointer to a 128-bit unique value that \r
+ designates which namespace to set a value from.\r
+ @param[in] TokenNumber The PCD token number to set a current value for.\r
+ @param[in] Value The 32-bit value to set.\r
\r
- @retval UINT32 Return the value been set.\r
+ @return Return the value been set.\r
\r
**/\r
UINT32\r
IN UINT32 Value\r
)\r
{\r
- ASSERT (Guid != NULL);\r
+ ASSERT (FALSE);\r
\r
- return Value;\r
+ return 0;\r
}\r
\r
\r
\r
/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
+ \r
Sets the 64-bit value for the token specified by TokenNumber and \r
Guid to the value specified by Value. Value is returned.\r
If Guid is NULL, then ASSERT().\r
\r
- @param[in] Guid Pointer to a 128-bit unique value that \r
- designates which namespace to set a value from.\r
- @param[in] TokenNumber The PCD token number to set a current value for.\r
- @param[in] Value The 64-bit value to set.\r
+ @param[in] Guid Pointer to a 128-bit unique value that \r
+ designates which namespace to set a value from.\r
+ @param[in] TokenNumber The PCD token number to set a current value for.\r
+ @param[in] Value The 64-bit value to set.\r
\r
- @retval UINT64 Return the value been set.\r
+ @return Return the value been set.\r
\r
**/\r
UINT64\r
IN UINT64 Value\r
)\r
{\r
- ASSERT (Guid != NULL);\r
+ ASSERT (FALSE);\r
\r
- return Value;\r
+ return 0;\r
}\r
\r
\r
\r
/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
+ \r
Sets a buffer for the token specified by TokenNumber to the value specified by \r
- Buffer and SizeOfValue. Buffer is returned. If SizeOfValue is greater than \r
- the maximum size support by TokenNumber, then set SizeOfValue to the maximum size \r
+ Buffer and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than \r
+ the maximum size support by TokenNumber, then set SizeOfBuffer to the maximum size \r
supported by TokenNumber and return NULL to indicate that the set operation \r
was not actually performed. \r
\r
- If SizeOfValue > 0 and Buffer is NULL, then ASSERT().\r
+ If Guid is NULL, then ASSERT().\r
+ If SizeOfBuffer is NULL, then ASSERT().\r
+ If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
\r
- @param[in] Guid Pointer to a 128-bit unique value that \r
- designates which namespace to set a value from.\r
- @param[in] TokenNumber The PCD token number to set a current value for.\r
- @param[in, out] SizeOfBuffer The size, in bytes, of Buffer.\r
- @param[in] Buffer A pointer to the buffer to set.\r
+ @param[in] Guid Pointer to a 128-bit unique value that \r
+ designates which namespace to set a value from.\r
+ @param[in] TokenNumber The PCD token number to set a current value for.\r
+ @param[in, out] SizeOfBuffer The size, in bytes, of Buffer.\r
+ @param[in] Buffer A pointer to the buffer to set.\r
\r
- @retval VOID * Return the pinter to the buffer been set.\r
+ @return Return the pinter to the buffer been set.\r
\r
**/\r
VOID *\r
IN VOID *Buffer\r
)\r
{\r
- ASSERT (Guid != NULL);\r
-\r
- ASSERT (SizeOfBuffer != NULL);\r
- \r
- if (*SizeOfBuffer > 0) {\r
- ASSERT (Buffer != NULL);\r
- }\r
+ ASSERT (FALSE);\r
\r
- return Buffer;\r
+ return NULL;\r
}\r
\r
\r
\r
/**\r
+ This function provides a means by which to set a value for a given PCD token.\r
+ \r
Sets the Boolean value for the token specified by TokenNumber and \r
Guid to the value specified by Value. Value is returned.\r
+ \r
If Guid is NULL, then ASSERT().\r
\r
- @param[in] Guid Pointer to a 128-bit unique value that \r
- designates which namespace to set a value from.\r
- @param[in] TokenNumber The PCD token number to set a current value for.\r
- @param[in] Value The Boolean value to set.\r
+ @param[in] Guid Pointer to a 128-bit unique value that \r
+ designates which namespace to set a value from.\r
+ @param[in] TokenNumber The PCD token number to set a current value for.\r
+ @param[in] Value The Boolean value to set.\r
\r
- @retval Boolean Return the value been set.\r
+ @return Return the value been set.\r
\r
**/\r
BOOLEAN\r
IN BOOLEAN Value\r
)\r
{\r
- ASSERT (Guid != NULL);\r
+ ASSERT (FALSE);\r
\r
- return Value;\r
+ return FALSE;\r
}\r
\r
\r
\r
/**\r
+ Set up a notification function that is called when a specified token is set.\r
+ \r
When the token specified by TokenNumber and Guid is set, \r
then notification function specified by NotificationFunction is called. \r
If Guid is NULL, then the default token space is used. \r
+ \r
If NotificationFunction is NULL, then ASSERT().\r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates which \r
- namespace to set a value from. If NULL, then the default \r
- token space is used.\r
- @param[in] TokenNumber The PCD token number to monitor.\r
- @param[in] NotificationFunction The function to call when the token \r
- specified by Guid and TokenNumber is set.\r
-\r
- @retval VOID\r
+ @param[in] Guid Pointer to a 128-bit unique value that designates which \r
+ namespace to set a value from. If NULL, then the default \r
+ token space is used.\r
+ @param[in] TokenNumber The PCD token number to monitor.\r
+ @param[in] NotificationFunction The function to call when the token \r
+ specified by Guid and TokenNumber is set.\r
\r
**/\r
VOID\r
IN PCD_CALLBACK NotificationFunction\r
)\r
{\r
- ASSERT (NotificationFunction != NULL);\r
+ ASSERT (FALSE);\r
}\r
\r
\r
\r
/**\r
Disable a notification function that was established with LibPcdCallbackonSet().\r
+ \r
+ Disable a notification function that was previously established with LibPcdCallbackOnSet(). \r
+ \r
If NotificationFunction is NULL, then ASSERT().\r
-\r
- @param[in] Guid Specify the GUID token space.\r
- @param[in] TokenNumber Specify the token number.\r
+ If LibPcdCallbackOnSet() was not previously called with Guid, TokenNumber, \r
+ and NotificationFunction, then ASSERT().\r
+ \r
+ @param[in] Guid Specify the GUID token space.\r
+ @param[in] TokenNumber Specify the token number.\r
@param[in] NotificationFunction The callback function to be unregistered.\r
\r
- @retval VOID\r
-\r
**/\r
VOID\r
EFIAPI\r
IN PCD_CALLBACK NotificationFunction\r
)\r
{\r
- ASSERT (NotificationFunction != NULL);\r
+ ASSERT (FALSE);\r
}\r
\r
\r
\r
/**\r
+ Retrieves the next token in a token space.\r
+ \r
Retrieves the next PCD token number from the token space specified by Guid. \r
If Guid is NULL, then the default token space is used. If TokenNumber is 0, \r
then the first token number is returned. Otherwise, the token number that \r
follows TokenNumber in the token space is returned. If TokenNumber is the last \r
- token number in the token space, then 0 is returned. If TokenNumber is not 0 and \r
- is not in the token space specified by Guid, then ASSERT().\r
+ token number in the token space, then 0 is returned. \r
+ \r
+ If TokenNumber is not 0 and is not in the token space specified by Guid, then ASSERT().\r
\r
- @param[in] Pointer to a 128-bit unique value that designates which namespace \r
- to set a value from. If NULL, then the default token space is used.\r
- @param[in] The previous PCD token number. If 0, then retrieves the first PCD \r
- token number.\r
+ @param[in] Guid Pointer to a 128-bit unique value that designates which namespace \r
+ to set a value from. If NULL, then the default token space is used.\r
+ @param[in] TokenNumber The previous PCD token number. If 0, then retrieves the first PCD \r
+ token number.\r
\r
- @retval UINTN The next valid token number.\r
+ @return The next valid token number.\r
\r
**/\r
UINTN \r
EFIAPI\r
LibPcdGetNextToken (\r
- IN CONST GUID *Guid, OPTIONAL\r
- IN UINTN TokenNumber\r
+ IN CONST GUID *Guid, OPTIONAL\r
+ IN UINTN TokenNumber\r
)\r
{\r
+ ASSERT (FALSE);\r
+\r
return 0;\r
}\r
\r
\r
\r
/**\r
- Retrieves the next PCD token space from a token space specified by Guid.\r
- Guid of NULL is reserved to mark the default local token namespace on the current\r
- platform. If Guid is NULL, then the GUID of the first non-local token space of the \r
- current platform is returned. If Guid is the last non-local token space, \r
- then NULL is returned. \r
-\r
- If Guid is not NULL and is not a valid token space in the current platform, then ASSERT().\r
-\r
-\r
+ Used to retrieve the list of available PCD token space GUIDs.\r
+ \r
+ Returns the PCD token space GUID that follows TokenSpaceGuid in the list of token spaces\r
+ in the platform.\r
+ If TokenSpaceGuid is NULL, then a pointer to the first PCD token spaces returned.\r
+ If TokenSpaceGuid is the last PCD token space GUID in the list, then NULL is returned.\r
\r
- @param[in] Pointer to a 128-bit unique value that designates from which namespace \r
- to start the search.\r
+ @param TokenSpaceGuid Pointer to the a PCD token space GUID\r
\r
- @retval CONST GUID * The next valid token namespace.\r
+ @return The next valid token namespace.\r
\r
**/\r
GUID * \r
EFIAPI\r
LibPcdGetNextTokenSpace (\r
- IN CONST GUID *Guid\r
+ IN CONST GUID *TokenSpaceGuid\r
)\r
{\r
+ ASSERT (FALSE);\r
+\r
return NULL;\r
}\r
+\r
+\r
+/**\r
+ Sets a value of a patchable PCD entry that is type pointer.\r
+ \r
+ Sets the PCD entry specified by PatchVariable to the value specified by Buffer \r
+ and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than \r
+ MaximumDatumSize, then set SizeOfBuffer to MaximumDatumSize and return \r
+ NULL to indicate that the set operation was not actually performed. \r
+ If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to \r
+ MaximumDatumSize and NULL must be returned.\r
+ \r
+ If PatchVariable is NULL, then ASSERT().\r
+ If SizeOfBuffer is NULL, then ASSERT().\r
+ If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
+\r
+ @param[in] PatchVariable A pointer to the global variable in a module that is \r
+ the target of the set operation.\r
+ @param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable.\r
+ @param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer.\r
+ @param[in] Buffer A pointer to the buffer to used to set the target variable.\r
+ \r
+ @return Return the pointer to the buffer been set.\r
+\r
+**/\r
+VOID *\r
+EFIAPI\r
+LibPatchPcdSetPtr (\r
+ IN VOID *PatchVariable,\r
+ IN UINTN MaximumDatumSize,\r
+ IN OUT UINTN *SizeOfBuffer,\r
+ IN CONST VOID *Buffer\r
+ )\r
+{\r
+ ASSERT (PatchVariable != NULL);\r
+ ASSERT (SizeOfBuffer != NULL);\r
+ \r
+ if (*SizeOfBuffer > 0) {\r
+ ASSERT (Buffer != NULL);\r
+ }\r
+\r
+ if ((*SizeOfBuffer > MaximumDatumSize) ||\r
+ (*SizeOfBuffer == MAX_ADDRESS)) {\r
+ *SizeOfBuffer = MaximumDatumSize;\r
+ return NULL;\r
+ }\r
+ \r
+ CopyMem (PatchVariable, Buffer, *SizeOfBuffer);\r
+ \r
+ return (VOID *) Buffer;\r
+}\r
+\r
projects / mirror_edk2.git / blobdiff