There are no restrictions on the use of FeaturePcd(), FixedPcdGetXX(),\r
PatchPcdGetXX(), and PatchPcdSetXX().\r
\r
-Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
\r
**/\r
#define PatchPcdSetPtr(TokenName, Size, Buffer) \\r
- LibPatchPcdSetPtr ( \\r
- _gPcd_BinaryPatch_##TokenName, \\r
+ LibPatchPcdSetPtrAndSize ( \\r
+ (VOID *)_gPcd_BinaryPatch_##TokenName, \\r
+ &_gPcd_BinaryPatch_Size_##TokenName, \\r
(UINTN)_PCD_PATCHABLE_##TokenName##_SIZE, \\r
(Size), \\r
(Buffer) \\r
)\r
-\r
/**\r
Retrieves an 8-bit PCD token value based on a token name.\r
\r
#define PcdGetBool(TokenName) _PCD_GET_MODE_BOOL_##TokenName\r
\r
\r
+/**\r
+ Retrieves the size of a fixed PCD token based on a token name.\r
+\r
+ Returns the size of the token specified by TokenName.\r
+ If TokenName is not a valid token in the token space, then the module will not build.\r
+\r
+ @param[in] TokenName The name of the PCD token to retrieve a current value size for.\r
+\r
+ @return Return the size\r
+\r
+**/\r
+#define FixedPcdGetSize(TokenName) _PCD_SIZE_##TokenName\r
+\r
+\r
+/**\r
+ Retrieves the size of a binary patchable PCD token based on a token name.\r
+\r
+ Returns the size of the token specified by TokenName.\r
+ If TokenName is not a valid token in the token space, then the module will not build.\r
+\r
+ @param[in] TokenName The name of the PCD token to retrieve a current value size for.\r
+\r
+ @return Return the size\r
+\r
+**/\r
+#define PatchPcdGetSize(TokenName) _gPcd_BinaryPatch_Size_##TokenName\r
+\r
+\r
+/**\r
+ Retrieves the size of the PCD token based on a token name.\r
+ \r
+ Returns the size of the token specified by TokenName.\r
+ If TokenName is not a valid token in the token space, then the module will not build.\r
+ \r
+ @param[in] TokenName The name of the PCD token to retrieve a current value size for.\r
+\r
+ @return Return the size\r
+\r
+**/\r
+#define PcdGetSize(TokenName) _PCD_GET_MODE_SIZE_##TokenName\r
+\r
+\r
+/**\r
+ Retrieve the size of a given PCD token.\r
+ \r
+ Returns the size of the token specified by TokenNumber and Guid. \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 size for.\r
+\r
+ @return Return the size.\r
+\r
+**/\r
+#define PcdGetExSize(Guid, TokenName) LibPcdGetExSize ((Guid), PcdTokenEx(Guid,TokenName))\r
+\r
+#ifndef DISABLE_NEW_DEPRECATED_INTERFACES\r
/**\r
Sets an 8-bit PCD token value based on a token name.\r
\r
Sets the 8-bit value for the token specified by TokenName. Value is returned.\r
If TokenName is not a valid token in the token space, then the module will not build.\r
\r
- If the set operation was not correctly performed, then ASSERT().\r
-\r
@param TokenName The name of the PCD token to retrieve a current value for.\r
@param Value The 8-bit value to set.\r
\r
Sets the 16-bit value for the token specified by TokenName. Value is returned.\r
If TokenName is not a valid token in the token space, then the module will not build.\r
\r
- If the set operation was not correctly performed, then ASSERT().\r
-\r
@param TokenName The name of the PCD token to retrieve a current value for.\r
@param Value The 16-bit value to set.\r
\r
Sets the 32-bit value for the token specified by TokenName. Value is returned.\r
If TokenName is not a valid token in the token space, then the module will not build.\r
\r
- If the set operation was not correctly performed, then ASSERT().\r
-\r
@param TokenName The name of the PCD token to retrieve a current value for.\r
@param Value The 32-bit value to set.\r
\r
then set SizeOfBuffer to the maximum size supported by TokenName and return NULL \r
to indicate that the set operation was not actually performed. If SizeOfBuffer \r
is set to MAX_ADDRESS, then SizeOfBuffer must be set to the maximum size supported \r
- by TokenName and NULL must be returned, or ASSERT() if the set operation was not corretly performed.\r
+ by TokenName and NULL must be returned.\r
If TokenName is not a valid token in the token space, then the module will not build.\r
\r
If SizeOfBuffer is NULL, then ASSERT().\r
Sets the Boolean value for the token specified by TokenName. Value is returned. \r
If TokenName is not a valid token in the token space, then the module will not build.\r
\r
- If the set operation was not correctly performed, then ASSERT().\r
-\r
@param TokenName The name of the PCD token to set the current value for.\r
@param Buffer The Boolean value to set.\r
\r
\r
**/\r
#define PcdSetBool(TokenName, Value) _PCD_SET_MODE_BOOL_##TokenName ((Value))\r
+#endif\r
+\r
+/**\r
+ Sets a 8-bit PCD token value based on a token name.\r
+\r
+ Sets the 8-bit value for the token specified by TokenName.\r
+ If TokenName is not a valid token in the token space, then the module will not build.\r
+\r
+ @param TokenName The name of the PCD token to retrieve a current value for.\r
+ @param Value The 8-bit value to set.\r
+\r
+ @return The status of the set operation.\r
+\r
+**/\r
+#define PcdSet8S(TokenName, Value) _PCD_SET_MODE_8_S_##TokenName ((Value))\r
+\r
+/**\r
+ Sets a 16-bit PCD token value based on a token name.\r
+\r
+ Sets the 16-bit value for the token specified by TokenName.\r
+ If TokenName is not a valid token in the token space, then the module will not build.\r
+\r
+ @param TokenName The name of the PCD token to retrieve a current value for.\r
+ @param Value The 16-bit value to set.\r
+\r
+ @return The status of the set operation.\r
+\r
+**/\r
+#define PcdSet16S(TokenName, Value) _PCD_SET_MODE_16_S_##TokenName ((Value))\r
+\r
+/**\r
+ Sets a 32-bit PCD token value based on a token name.\r
+\r
+ Sets the 32-bit value for the token specified by TokenName.\r
+ If TokenName is not a valid token in the token space, then the module will not build.\r
+\r
+ @param TokenName The name of the PCD token to retrieve a current value for.\r
+ @param Value The 32-bit value to set.\r
+\r
+ @return The status of the set operation.\r
+\r
+**/\r
+#define PcdSet32S(TokenName, Value) _PCD_SET_MODE_32_S_##TokenName ((Value))\r
+\r
+/**\r
+ Sets a 64-bit PCD token value based on a token name.\r
+\r
+ Sets the 64-bit value for the token specified by TokenName.\r
+ If TokenName is not a valid token in the token space, then the module will not build.\r
+\r
+ @param TokenName The name of the PCD token to retrieve a current value for.\r
+ @param Value The 64-bit value to set.\r
+\r
+ @return The status of the set operation.\r
+\r
+**/\r
+#define PcdSet64S(TokenName, Value) _PCD_SET_MODE_64_S_##TokenName ((Value))\r
+\r
+/**\r
+ Sets a pointer to a PCD token buffer based on a token name.\r
+\r
+ Sets the buffer for the token specified by TokenName.\r
+ If SizeOfBuffer is greater than the maximum size supported by TokenName,\r
+ then set SizeOfBuffer to the maximum size supported by TokenName and return\r
+ RETURN_INVALID_PARAMETER to indicate that the set operation was not actually performed.\r
+ If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to the maximum size\r
+ supported by TokenName and RETURN_INVALID_PARAMETER must be returned.\r
+ If TokenName is not a valid token in the token space, then the module will not build.\r
+\r
+ If SizeOfBuffer is NULL, then ASSERT().\r
+ If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
+\r
+ @param TokenName The name of the PCD token to set the current value for.\r
+ @param SizeOfBuffer A pointer to the size, in bytes, of Buffer.\r
+ @param Buffer A pointer to the buffer to set.\r
+\r
+ @return The status of the set operation.\r
+\r
+**/\r
+#define PcdSetPtrS(TokenName, SizeOfBuffer, Buffer) \\r
+ _PCD_SET_MODE_PTR_S_##TokenName ((SizeOfBuffer), (Buffer))\r
+\r
+\r
+\r
+/**\r
+ Sets a boolean PCD token value based on a token name.\r
+\r
+ Sets the boolean value for the token specified by TokenName.\r
+ If TokenName is not a valid token in the token space, then the module will not build.\r
+\r
+ @param TokenName The name of the PCD token to retrieve a current value for.\r
+ @param Value The boolean value to set.\r
+\r
+ @return The status of the set operation.\r
\r
+**/\r
+#define PcdSetBoolS(TokenName, Value) _PCD_SET_MODE_BOOL_S_##TokenName ((Value))\r
\r
/**\r
Retrieves a token number based on a GUID and a token name.\r
#define PcdGetExBool(Guid, TokenName) LibPcdGetExBool ((Guid), PcdTokenEx(Guid,TokenName))\r
\r
\r
+\r
+#ifndef DISABLE_NEW_DEPRECATED_INTERFACES\r
/**\r
Sets an 8-bit PCD token value based on a GUID and a token name.\r
\r
then the module will not build.\r
\r
If Guid is NULL, then ASSERT().\r
- If the set operation was not correctly performed, then ASSERT().\r
\r
@param Guid Pointer to a 128-bit unique value that designates \r
which namespace to retrieve a value from.\r
then the module will not build.\r
\r
If Guid is NULL, then ASSERT().\r
- If the set operation was not correctly performed, then ASSERT().\r
\r
@param Guid Pointer to a 128-bit unique value that designates \r
which namespace to retrieve a value from.\r
then the module will not build.\r
\r
If Guid is NULL, then ASSERT().\r
- If the set operation was not correctly performed, then ASSERT().\r
\r
@param Guid Pointer to a 128-bit unique value that designates \r
which namespace to retrieve a value from.\r
then the module will not build.\r
\r
If Guid is NULL, then ASSERT().\r
- If the set operation was not correctly performed, then ASSERT().\r
\r
@param Guid Pointer to a 128-bit unique value that designates \r
which namespace to retrieve a value from.\r
then set SizeOfBuffer to the maximum size supported by Guid and TokenName and return \r
NULL to indicate that the set operation was not actually performed. If SizeOfBuffer \r
is set to MAX_ADDRESS, then SizeOfBuffer must be set to the maximum size supported by\r
- Guid and TokenName and NULL must be returned, or ASSERT() if the set operation was not corretly performed.\r
+ Guid and TokenName and NULL must be returned.\r
If TokenName is not a valid token in the token space specified by Guid, \r
then the module will not build.\r
\r
then the module will not build.\r
\r
If Guid is NULL, then ASSERT().\r
- If the set operation was not correctly performed, then ASSERT().\r
\r
@param Guid Pointer to a 128-bit unique value that designates \r
which namespace to retrieve a value from.\r
**/ \r
#define PcdSetExBool(Guid, TokenName, Value) \\r
LibPcdSetExBool((Guid), PcdTokenEx(Guid,TokenName), (Value))\r
+#endif\r
+\r
+/**\r
+ Sets an 8-bit PCD token value based on a GUID and a token name.\r
+\r
+ Sets the 8-bit value for the token specified by Guid and TokenName.\r
+ If TokenName is not a valid token in the token space specified by Guid,\r
+ then the module will not build.\r
+\r
+ If Guid is NULL, then ASSERT().\r
+\r
+ @param Guid Pointer to a 128-bit unique value that designates\r
+ which namespace to retrieve a value from.\r
+ @param TokenName The name of the PCD token to set the current value for.\r
+ @param Value The 8-bit value to set.\r
+\r
+ @return The status of the set operation.\r
+\r
+**/\r
+#define PcdSetEx8S(Guid, TokenName, Value) LibPcdSetEx8S ((Guid), PcdTokenEx(Guid,TokenName), (Value))\r
+\r
+/**\r
+ Sets an 16-bit PCD token value based on a GUID and a token name.\r
+\r
+ Sets the 16-bit value for the token specified by Guid and TokenName.\r
+ If TokenName is not a valid token in the token space specified by Guid,\r
+ then the module will not build.\r
+\r
+ If Guid is NULL, then ASSERT().\r
+\r
+ @param Guid Pointer to a 128-bit unique value that designates\r
+ which namespace to retrieve a value from.\r
+ @param TokenName The name of the PCD token to set the current value for.\r
+ @param Value The 16-bit value to set.\r
+\r
+ @return The status of the set operation.\r
+\r
+**/\r
+#define PcdSetEx16S(Guid, TokenName, Value) LibPcdSetEx16S ((Guid), PcdTokenEx(Guid,TokenName), (Value))\r
+\r
+/**\r
+ Sets an 32-bit PCD token value based on a GUID and a token name.\r
+\r
+ Sets the 32-bit value for the token specified by Guid and TokenName.\r
+ If TokenName is not a valid token in the token space specified by Guid,\r
+ then the module will not build.\r
+\r
+ If Guid is NULL, then ASSERT().\r
+\r
+ @param Guid Pointer to a 128-bit unique value that designates\r
+ which namespace to retrieve a value from.\r
+ @param TokenName The name of the PCD token to set the current value for.\r
+ @param Value The 32-bit value to set.\r
+\r
+ @return The status of the set operation.\r
+\r
+**/\r
+#define PcdSetEx32S(Guid, TokenName, Value) LibPcdSetEx32S ((Guid), PcdTokenEx(Guid,TokenName), (Value))\r
+\r
+/**\r
+ Sets an 64-bit PCD token value based on a GUID and a token name.\r
+\r
+ Sets the 64-bit value for the token specified by Guid and TokenName.\r
+ If TokenName is not a valid token in the token space specified by Guid,\r
+ then the module will not build.\r
+\r
+ If Guid is NULL, then ASSERT().\r
+\r
+ @param Guid Pointer to a 128-bit unique value that designates\r
+ which namespace to retrieve a value from.\r
+ @param TokenName The name of the PCD token to set the current value for.\r
+ @param Value The 64-bit value to set.\r
+\r
+ @return The status of the set operation.\r
+\r
+**/\r
+#define PcdSetEx64S(Guid, TokenName, Value) LibPcdSetEx64S ((Guid), PcdTokenEx(Guid,TokenName), (Value))\r
+\r
+/**\r
+ Sets a pointer to a PCD token buffer based on a GUID and a token name.\r
+\r
+ Sets the buffer for the token specified by Guid and TokenName.\r
+ If SizeOfBuffer is greater than the maximum size supported by Guid and TokenName,\r
+ then set SizeOfBuffer to the maximum size supported by Guid and TokenName and return\r
+ RETURN_INVALID_PARAMETER to indicate that the set operation was not actually performed.\r
+ If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to the maximum size\r
+ supported by Guid and TokenName and RETURN_INVALID_PARAMETER must be returned.\r
+ If TokenName is not a valid token in the token space specified by Guid,\r
+ then the module will not build.\r
+\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 Guid Pointer to a 128-bit unique value that designates\r
+ which namespace to retrieve a value from.\r
+ @param TokenName The name of the PCD token to set the current value for.\r
+ @param SizeOfBuffer A pointer to the size, in bytes, of Buffer.\r
+ @param Buffer Pointer to the buffer to set.\r
+\r
+ @return The status of the set operation.\r
+\r
+**/\r
+#define PcdSetExPtrS(Guid, TokenName, SizeOfBuffer, Buffer) \\r
+ LibPcdSetExPtrS ((Guid), PcdTokenEx(Guid,TokenName), (SizeOfBuffer), (Buffer))\r
\r
\r
+/**\r
+ Sets an boolean PCD token value based on a GUID and a token name.\r
+\r
+ Sets the boolean value for the token specified by Guid and TokenName.\r
+ If TokenName is not a valid token in the token space specified by Guid,\r
+ then the module will not build.\r
+\r
+ If Guid is NULL, then ASSERT().\r
+\r
+ @param Guid Pointer to a 128-bit unique value that designates\r
+ which namespace to retrieve a value from.\r
+ @param TokenName The name of the PCD token to set the current value for.\r
+ @param Value The boolean value to set.\r
+\r
+ @return The status of the set operation.\r
+\r
+**/\r
+#define PcdSetExBoolS(Guid, TokenName, Value) \\r
+ LibPcdSetExBoolS ((Guid), PcdTokenEx(Guid,TokenName), (Value))\r
+\r
/**\r
This function provides a means by which SKU support can be established in the PCD infrastructure.\r
\r
);\r
\r
\r
+#ifndef DISABLE_NEW_DEPRECATED_INTERFACES\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
- If the set operation was not correctly performed, then ASSERT().\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
\r
Sets the 16-bit value for the token specified by TokenNumber \r
to the value specified by Value. Value is returned.\r
\r
- If the set operation was not correctly performed, then ASSERT().\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
\r
Sets the 32-bit value for the token specified by TokenNumber \r
to the value specified by Value. Value is returned.\r
\r
- If the set operation was not correctly performed, then ASSERT().\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
\r
Sets the 64-bit value for the token specified by TokenNumber \r
to the value specified by Value. Value is returned.\r
\r
- If the set operation was not correctly performed, then ASSERT().\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
\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
- or ASSERT() if the set operation was not corretly performed.\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
Sets the Boolean value for the token specified by TokenNumber \r
to the value specified by Value. Value is returned.\r
\r
- If the set operation was not correctly performed, then ASSERT().\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
\r
Guid to the value specified by Value. Value is returned.\r
\r
If Guid is NULL, then ASSERT().\r
- If the set operation was not correctly performed, 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
Guid to the value specified by Value. Value is returned.\r
\r
If Guid is NULL, then ASSERT().\r
- If the set operation was not correctly performed, 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
Guid to the value specified by Value. Value is returned.\r
\r
If Guid is NULL, then ASSERT().\r
- If the set operation was not correctly performed, 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
Guid to the value specified by Value. Value is returned.\r
\r
If Guid is NULL, then ASSERT().\r
- If the set operation was not correctly performed, 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
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, or ASSERT() if the set operation was not corretly performed.\r
+ was not actually performed.\r
\r
If Guid is NULL, then ASSERT().\r
If SizeOfBuffer is NULL, then ASSERT().\r
Guid to the value specified by Value. Value is returned.\r
\r
If Guid is NULL, then ASSERT().\r
- If the set operation was not correctly performed, 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
IN UINTN TokenNumber,\r
IN BOOLEAN Value\r
);\r
+#endif\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.\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
+\r
+ @return The status of the set operation.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPcdSet8S (\r
+ IN UINTN TokenNumber,\r
+ IN UINT8 Value\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.\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
+\r
+ @return The status of the set operation.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPcdSet16S (\r
+ IN UINTN TokenNumber,\r
+ IN UINT16 Value\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.\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
+\r
+ @return The status of the set operation.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPcdSet32S (\r
+ IN UINTN TokenNumber,\r
+ IN UINT32 Value\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.\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
+\r
+ @return The status of the set operation.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPcdSet64S (\r
+ IN UINTN TokenNumber,\r
+ IN UINT64 Value\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\r
+ by Buffer and SizeOfBuffer. If SizeOfBuffer is greater than the maximum size\r
+ support by TokenNumber, then set SizeOfBuffer to the maximum size supported by\r
+ TokenNumber and return RETURN_INVALID_PARAMETER to indicate that the set operation\r
+ 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 RETURN_INVALID_PARAMETER must be returned.\r
+\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] Buffer A pointer to the buffer to set.\r
+\r
+ @return The status of the set operation.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPcdSetPtrS (\r
+ IN UINTN TokenNumber,\r
+ IN OUT UINTN *SizeOfBuffer,\r
+ IN CONST VOID *Buffer\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.\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
+\r
+ @return The status of the set operation.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPcdSetBoolS (\r
+ IN UINTN TokenNumber,\r
+ IN BOOLEAN Value\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.\r
+\r
+ If Guid is NULL, then ASSERT().\r
+\r
+ @param[in] Guid The 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
+ @return The status of the set operation.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPcdSetEx8S (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN UINT8 Value\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.\r
+\r
+ If Guid is NULL, then ASSERT().\r
+\r
+ @param[in] Guid The 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
+ @return The status of the set operation.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPcdSetEx16S (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN UINT16 Value\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.\r
+\r
+ If Guid is NULL, then ASSERT().\r
+\r
+ @param[in] Guid The 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
+ @return The status of the set operation.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPcdSetEx32S (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN UINT32 Value\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.\r
+\r
+ If Guid is NULL, then ASSERT().\r
+\r
+ @param[in] Guid The 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
+ @return The status of the set operation.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPcdSetEx64S (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN UINT64 Value\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 SizeOfBuffer. If SizeOfBuffer is greater than the maximum size\r
+ support by TokenNumber, then set SizeOfBuffer to the maximum size supported by\r
+ TokenNumber and return RETURN_INVALID_PARAMETER to indicate that the set operation\r
+ was not actually performed.\r
+\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
+\r
+ @return The status of the set operation.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPcdSetExPtrS (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN OUT UINTN *SizeOfBuffer,\r
+ IN VOID *Buffer\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.\r
+\r
+ If Guid is NULL, then ASSERT().\r
+\r
+ @param[in] Guid The 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
+ @return The status of the set operation.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPcdSetExBoolS (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN BOOLEAN Value\r
+ );\r
\r
/**\r
This notification function serves two purposes.\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
+ @param[out] 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
VOID *\r
EFIAPI\r
LibPatchPcdSetPtr (\r
- IN VOID *PatchVariable,\r
+ OUT VOID *PatchVariable,\r
IN UINTN MaximumDatumSize,\r
IN OUT UINTN *SizeOfBuffer,\r
IN CONST VOID *Buffer\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\r
+ by Buffer and SizeOfBuffer. If SizeOfBuffer is greater than MaximumDatumSize,\r
+ then set SizeOfBuffer to MaximumDatumSize and return RETURN_INVALID_PARAMETER\r
+ 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 RETURN_INVALID_PARAMETER 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[out] 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 The status of the set operation.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPatchPcdSetPtrS (\r
+ OUT VOID *PatchVariable,\r
+ IN UINTN MaximumDatumSize,\r
+ IN OUT UINTN *SizeOfBuffer,\r
+ IN CONST VOID *Buffer\r
+ );\r
+\r
+/**\r
+ Sets a value and size 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 SizeOfPatchVariable is NULL, then ASSERT().\r
+ If SizeOfBuffer is NULL, then ASSERT().\r
+ If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
+\r
+ @param[out] PatchVariable A pointer to the global variable in a module that is \r
+ the target of the set operation.\r
+ @param[out] SizeOfPatchVariable A pointer to the size, in bytes, of PatchVariable.\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 that was set.\r
+\r
+**/\r
+VOID *\r
+EFIAPI\r
+LibPatchPcdSetPtrAndSize (\r
+ OUT VOID *PatchVariable,\r
+ OUT UINTN *SizeOfPatchVariable,\r
+ IN UINTN MaximumDatumSize,\r
+ IN OUT UINTN *SizeOfBuffer,\r
+ IN CONST VOID *Buffer\r
+ );\r
+\r
+/**\r
+ Sets a value and size of a patchable PCD entry that is type pointer.\r
+\r
+ Sets the PCD entry specified by PatchVariable to the value specified\r
+ by Buffer and SizeOfBuffer. If SizeOfBuffer is greater than MaximumDatumSize,\r
+ then set SizeOfBuffer to MaximumDatumSize and return RETURN_INVALID_PARAMETER\r
+ 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 RETURN_INVALID_PARAMETER must be returned.\r
+\r
+ If PatchVariable is NULL, then ASSERT().\r
+ If SizeOfPatchVariable is NULL, then ASSERT().\r
+ If SizeOfBuffer is NULL, then ASSERT().\r
+ If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
+\r
+ @param[out] PatchVariable A pointer to the global variable in a module that is\r
+ the target of the set operation.\r
+ @param[out] SizeOfPatchVariable A pointer to the size, in bytes, of PatchVariable.\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 The status of the set operation.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+LibPatchPcdSetPtrAndSizeS (\r
+ OUT VOID *PatchVariable,\r
+ OUT UINTN *SizeOfPatchVariable,\r
+ IN UINTN MaximumDatumSize,\r
+ IN OUT UINTN *SizeOfBuffer,\r
+ IN CONST VOID *Buffer\r
+ );\r
+\r
typedef enum {\r
PCD_TYPE_8,\r
PCD_TYPE_16,\r
projects / mirror_edk2.git / blobdiff