LibPatchPcdSetPtr() interface. For FeatureFlag/Fixed PCD, the macro interface is\r
translated to a variable or macro that is auto-generated by build tool in\r
module's autogen.h/autogen.c.\r
- The PcdGetXX(), PcdSetXX(), PcdToken(), and PcdGetNextTokenSpace() operations are \r
- only available prior to ExitBootServices(). If access to PCD values are required \r
+ The PcdGetXX(), PcdSetXX(), PcdToken(), and PcdGetNextTokenSpace() operations are\r
+ only available prior to ExitBootServices(). If access to PCD values are required\r
at runtime, then their values must be collected prior to ExitBootServices().\r
There are no restrictions on the use of FeaturePcd(), FixedPcdGetXX(),\r
PatchPcdGetXX(), and PatchPcdSetXX().\r
\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
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __PCD_LIB_H__\r
#define __PCD_LIB_H__\r
\r
-#define PCD_MAX_SKU_ID 0x100\r
-\r
-\r
/**\r
Retrieves a token number based on a token name.\r
\r
- Returns the token number associated with the PCD token specified by TokenName.\r
+ Returns the token number associated with the PCD token specified by TokenName.\r
If TokenName is not a valid token in the token space, then the module will not build.\r
- If TokenName is not a feature flag, then the module will not build.\r
\r
@param TokenName The name of the PCD token to retrieve the token number for.\r
\r
@return The token number associated with the PCD.\r
\r
**/\r
-#define PcdToken(TokenName) _PCD_TOKEN_##TokenName\r
-\r
+#define PcdToken(TokenName) _PCD_TOKEN_##TokenName\r
\r
/**\r
Retrieves a Boolean PCD feature flag based on a token name.\r
\r
Returns the Boolean value for the PCD feature flag specified by TokenName.\r
If TokenName is not a valid token in the token space, then the module will not build.\r
- If TokenName is not a feature flag, then the module will not build.\r
+ If TokenName is not a feature flag PCD, then the module will not build.\r
\r
@param TokenName The name of the PCD token to retrieve a current value for.\r
\r
@return Boolean value for the PCD feature flag.\r
\r
**/\r
-#define FeaturePcdGet(TokenName) _PCD_GET_MODE_BOOL_##TokenName\r
-\r
+#define FeaturePcdGet(TokenName) _PCD_GET_MODE_BOOL_##TokenName\r
\r
/**\r
Retrieves an 8-bit fixed PCD token value based on a token name.\r
\r
Returns 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
- If TokenName is not a feature flag, then the module will not build.\r
+ If TokenName is not a fixed at build PCD, then the module will not build.\r
\r
@param TokenName The name of the PCD token to retrieve a current value for.\r
\r
@return 8-bit value for the token specified by TokenName.\r
\r
**/\r
-#define FixedPcdGet8(TokenName) _PCD_VALUE_##TokenName\r
-\r
+#define FixedPcdGet8(TokenName) _PCD_VALUE_##TokenName\r
\r
/**\r
Retrieves a 16-bit fixed PCD token value based on a token name.\r
\r
Returns 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
- If TokenName is not a feature flag, then the module will not build.\r
+ If TokenName is not a fixed at build PCD, then the module will not build.\r
\r
@param TokenName The name of the PCD token to retrieve a current value for.\r
\r
@return 16-bit value for the token specified by TokenName.\r
\r
**/\r
-#define FixedPcdGet16(TokenName) _PCD_VALUE_##TokenName\r
-\r
+#define FixedPcdGet16(TokenName) _PCD_VALUE_##TokenName\r
\r
/**\r
Retrieves a 32-bit fixed PCD token value based on a token name.\r
\r
Returns 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
- If TokenName is not a feature flag, then the module will not build.\r
+ If TokenName is not a fixed at build PCD, then the module will not build.\r
\r
@param TokenName The name of the PCD token to retrieve a current value for.\r
\r
@return 32-bit value for the token specified by TokenName.\r
\r
**/\r
-#define FixedPcdGet32(TokenName) _PCD_VALUE_##TokenName\r
-\r
+#define FixedPcdGet32(TokenName) _PCD_VALUE_##TokenName\r
\r
/**\r
Retrieves a 64-bit fixed PCD token value based on a token name.\r
\r
Returns 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
- If TokenName is not a feature flag, then the module will not build.\r
+ If TokenName is not a fixed at build PCD, then the module will not build.\r
\r
@param TokenName The name of the PCD token to retrieve a current value for.\r
\r
@return 64-bit value for the token specified by TokenName.\r
\r
**/\r
-#define FixedPcdGet64(TokenName) _PCD_VALUE_##TokenName\r
-\r
+#define FixedPcdGet64(TokenName) _PCD_VALUE_##TokenName\r
\r
/**\r
Retrieves a Boolean fixed PCD token value based on a token name.\r
\r
Returns 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
- If TokenName is not a feature flag, then the module will not build.\r
+ If TokenName is not a fixed at build PCD, then the module will not build.\r
\r
@param TokenName The name of the PCD token to retrieve a current value for.\r
\r
- @return The Boolean value for the token. \r
+ @return The Boolean value for the token.\r
\r
**/\r
-#define FixedPcdGetBool(TokenName) _PCD_VALUE_##TokenName\r
-\r
+#define FixedPcdGetBool(TokenName) _PCD_VALUE_##TokenName\r
\r
/**\r
Retrieves a pointer to a fixed PCD token buffer based on a token name.\r
\r
Returns a pointer to the buffer 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
- If TokenName is not a feature flag, then the module will not build.\r
+ If TokenName is not a fixed at build PCD, then the module will not build.\r
\r
@param TokenName The name of the PCD token to retrieve a current value for.\r
\r
- @return A pointer to the buffer. \r
+ @return A pointer to the buffer.\r
\r
**/\r
-#define FixedPcdGetPtr(TokenName) ((VOID *)_PCD_VALUE_##TokenName)\r
-\r
+#define FixedPcdGetPtr(TokenName) ((VOID *)_PCD_VALUE_##TokenName)\r
\r
/**\r
Retrieves an 8-bit binary patchable PCD token value based on a token name.\r
\r
Returns 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
- If TokenName is not a feature flag, then the module will not build.\r
+ If TokenName is not a patchable in module PCD, then the module will not build.\r
\r
@param TokenName The name of the PCD token to retrieve a current value for.\r
\r
@return An 8-bit binary patchable PCD token value.\r
\r
**/\r
-#define PatchPcdGet8(TokenName) _gPcd_BinaryPatch_##TokenName\r
+#define PatchPcdGet8(TokenName) _gPcd_BinaryPatch_##TokenName\r
\r
/**\r
Retrieves a 16-bit binary patchable PCD token value based on a token name.\r
\r
Returns 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
- If TokenName is not a feature flag, then the module will not build.\r
+ If TokenName is not a patchable in module PCD, then the module will not build.\r
\r
@param TokenName The name of the PCD token to retrieve a current value for.\r
\r
@return A 16-bit binary patchable PCD token value.\r
\r
**/\r
-#define PatchPcdGet16(TokenName) _gPcd_BinaryPatch_##TokenName\r
-\r
+#define PatchPcdGet16(TokenName) _gPcd_BinaryPatch_##TokenName\r
\r
/**\r
Retrieves a 32-bit binary patchable PCD token value based on a token name.\r
\r
Returns 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
- If TokenName is not a feature flag, then the module will not build.\r
+ If TokenName is not a patchable in module PCD, then the module will not build.\r
\r
@param TokenName The name of the PCD token to retrieve a current value for.\r
\r
@return A 32-bit binary patchable PCD token value.\r
\r
**/\r
-#define PatchPcdGet32(TokenName) _gPcd_BinaryPatch_##TokenName\r
-\r
+#define PatchPcdGet32(TokenName) _gPcd_BinaryPatch_##TokenName\r
\r
/**\r
Retrieves a 64-bit binary patchable PCD token value based on a token name.\r
\r
Returns 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
- If TokenName is not a feature flag, then the module will not build.\r
+ If TokenName is not a patchable in module PCD, then the module will not build.\r
\r
@param TokenName The name of the PCD token to retrieve a current value for.\r
\r
@return A 64-bit binary patchable PCD token value.\r
\r
**/\r
-#define PatchPcdGet64(TokenName) _gPcd_BinaryPatch_##TokenName\r
-\r
+#define PatchPcdGet64(TokenName) _gPcd_BinaryPatch_##TokenName\r
\r
/**\r
Retrieves a Boolean binary patchable PCD token value based on a token name.\r
\r
Returns 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
- If TokenName is not a feature flag, then the module will not build.\r
+ If TokenName is not a patchable in module PCD, then the module will not build.\r
\r
@param TokenName The name of the PCD token to retrieve a current value for.\r
\r
@return The Boolean value for the token.\r
\r
**/\r
-#define PatchPcdGetBool(TokenName) _gPcd_BinaryPatch_##TokenName\r
-\r
+#define PatchPcdGetBool(TokenName) _gPcd_BinaryPatch_##TokenName\r
\r
/**\r
Retrieves a pointer to a binary patchable PCD token buffer based on a token name.\r
\r
Returns a pointer to the buffer 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
- If TokenName is not a feature flag, then the module will not build.\r
+ If TokenName is not a patchable in module PCD, then the module will not build.\r
\r
@param TokenName The name of the PCD token to retrieve a current value for.\r
\r
@return A pointer to the buffer for the token.\r
\r
**/\r
-#define PatchPcdGetPtr(TokenName) ((VOID *)_gPcd_BinaryPatch_##TokenName)\r
-\r
+#define PatchPcdGetPtr(TokenName) ((VOID *)_gPcd_BinaryPatch_##TokenName)\r
\r
/**\r
Sets an 8-bit binary patchable 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
- If TokenName is not a feature flag, then the module will not build.\r
+ If TokenName is not a patchable in module PCD, then the module will not build.\r
\r
@param TokenName The name of the binary patchable PCD token to set the current value for.\r
@param Value The 8-bit value to set.\r
- \r
+\r
@return Return the Value that was set.\r
\r
**/\r
-#define PatchPcdSet8(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = (Value))\r
-\r
+#define PatchPcdSet8(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = (Value))\r
\r
/**\r
Sets a 16-bit binary patchable PCD token value based on a token name.\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
- If TokenName is not a feature flag, then the module will not build.\r
+ If TokenName is not a patchable in module PCD, then the module will not build.\r
\r
@param TokenName The name of the binary patchable PCD token to set the current value for.\r
@param Value The 16-bit value to set.\r
@return Return the Value that was set.\r
\r
**/\r
-#define PatchPcdSet16(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = (Value))\r
-\r
+#define PatchPcdSet16(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = (Value))\r
\r
/**\r
Sets a 32-bit binary patchable PCD token value based on a token name.\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
- If TokenName is not a feature flag, then the module will not build.\r
+ If TokenName is not a patchable in module PCD, then the module will not build.\r
\r
@param TokenName The name of the binary patchable PCD token to set the current value for.\r
@param Value The 32-bit value to set.\r
@return Return the Value that was set.\r
\r
**/\r
-#define PatchPcdSet32(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = (Value))\r
-\r
+#define PatchPcdSet32(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = (Value))\r
\r
/**\r
Sets a 64-bit binary patchable PCD token value based on a token name.\r
\r
Sets the 64-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
- If TokenName is not a feature flag, then the module will not build.\r
+ If TokenName is not a patchable in module PCD, then the module will not build.\r
\r
@param TokenName The name of the binary patchable PCD token to set the current value for.\r
@param Value The 64-bit value to set.\r
@return Return the Value that was set.\r
\r
**/\r
-#define PatchPcdSet64(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = (Value))\r
-\r
+#define PatchPcdSet64(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = (Value))\r
\r
/**\r
Sets a Boolean binary patchable PCD token value based on a token name.\r
\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
- If TokenName is not a feature flag, then the module will not build.\r
+ If TokenName is not a patchable in module PCD, then the module will not build.\r
\r
@param TokenName The name of the binary patchable PCD token to set the current value for.\r
@param Value The boolean value to set.\r
@return Return the Value that was set.\r
\r
**/\r
-#define PatchPcdSetBool(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = (Value))\r
-\r
+#define PatchPcdSetBool(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = (Value))\r
\r
/**\r
Sets a pointer to a binary patchable PCD token buffer based on a token name.\r
\r
- Sets the buffer for the token specified by TokenName. Buffer is returned. \r
+ Sets the buffer for the token specified by TokenName. Buffer is returned.\r
If SizeOfBuffer is greater than the maximum size supported by TokenName, then set SizeOfBuffer\r
- to the maximum size supported by TokenName and return NULL to indicate that the set operation \r
- was not actually performed. If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be \r
+ to the maximum size supported by TokenName and return NULL to indicate that the set operation\r
+ was not actually performed. If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be\r
set to the maximum size supported 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
- If TokenName is not a feature flag, then the module will not build.\r
- \r
+ If TokenName is not a patchable in module PCD, 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
+\r
@param TokenName The name of the binary patchable 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 value to set.\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
Retrieves an 8-bit PCD token value based on a token name.\r
- \r
+\r
Returns 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
+\r
@param TokenName The name of the PCD token to retrieve a current value for.\r
\r
@return 8-bit value for the token specified by TokenName.\r
\r
**/\r
-#define PcdGet8(TokenName) _PCD_GET_MODE_8_##TokenName\r
-\r
+#define PcdGet8(TokenName) _PCD_GET_MODE_8_##TokenName\r
\r
/**\r
Retrieves a 16-bit PCD token value based on a token name.\r
@return 16-bit value for the token specified by TokenName.\r
\r
**/\r
-#define PcdGet16(TokenName) _PCD_GET_MODE_16_##TokenName\r
-\r
+#define PcdGet16(TokenName) _PCD_GET_MODE_16_##TokenName\r
\r
/**\r
Retrieves a 32-bit PCD token value based on a token name.\r
@return 32-bit value for the token specified by TokenName.\r
\r
**/\r
-#define PcdGet32(TokenName) _PCD_GET_MODE_32_##TokenName\r
-\r
+#define PcdGet32(TokenName) _PCD_GET_MODE_32_##TokenName\r
\r
/**\r
Retrieves a 64-bit PCD token value based on a token name.\r
@return 64-bit value for the token specified by TokenName.\r
\r
**/\r
-#define PcdGet64(TokenName) _PCD_GET_MODE_64_##TokenName\r
-\r
+#define PcdGet64(TokenName) _PCD_GET_MODE_64_##TokenName\r
\r
/**\r
Retrieves a pointer to a PCD token buffer based on a token name.\r
@return A pointer to the buffer.\r
\r
**/\r
-#define PcdGetPtr(TokenName) _PCD_GET_MODE_PTR_##TokenName\r
-\r
+#define PcdGetPtr(TokenName) _PCD_GET_MODE_PTR_##TokenName\r
\r
/**\r
Retrieves a Boolean PCD token value based on a token name.\r
@return A Boolean PCD token value.\r
\r
**/\r
-#define PcdGetBool(TokenName) _PCD_GET_MODE_BOOL_##TokenName\r
+#define PcdGetBool(TokenName) _PCD_GET_MODE_BOOL_##TokenName\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
- Sets an 8-bit PCD token value based on a token name.\r
+ Retrieves the size of a binary patchable PCD token based on a token name.\r
\r
- Sets the 8-bit value for the token specified by TokenName. Value is returned.\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 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 Return the Value that was set.\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 PcdSet8(TokenName, Value) _PCD_SET_MODE_8_##TokenName ((Value))\r
+#define PatchPcdGetSize(TokenName) _gPcd_BinaryPatch_Size_##TokenName\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
- Sets a 16-bit PCD token value based on a token name.\r
+ Retrieve the size of a given PCD token.\r
\r
- Sets the 16-bit value for the token specified by TokenName. Value is returned.\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
+/**\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 16-bit value to set.\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 Return the Value that was set.\r
+ @return The status of the set operation.\r
\r
**/\r
-#define PcdSet16(TokenName, Value) _PCD_SET_MODE_16_##TokenName ((Value))\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. Value is returned.\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
+ @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 Return the Value that was set.\r
+ @return The status of the set operation.\r
\r
**/\r
-#define PcdSet32(TokenName, Value) _PCD_SET_MODE_32_##TokenName ((Value))\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. Value is returned.\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
+ @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 Return the Value that was set.\r
+ @return The status of the set operation.\r
\r
**/\r
-#define PcdSet64(TokenName, Value) _PCD_SET_MODE_64_##TokenName ((Value))\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. Buffer is returned. \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 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.\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
+\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 Return the pointer to the Buffer that was set.\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 PcdSetPtr(TokenName, SizeOfBuffer, Buffer) \\r
- _PCD_SET_MODE_PTR_##TokenName ((SizeOfBuffer), (Buffer))\r
- \r
+#define PcdSetPtrS(TokenName, SizeOfBuffer, Buffer) \\r
+ _PCD_SET_MODE_PTR_S_##TokenName ((SizeOfBuffer), (Buffer))\r
+\r
/**\r
- Sets a Boolean PCD token value based on a token name.\r
+ Sets a boolean PCD token value based on a token name.\r
\r
- Sets the Boolean value for the token specified by TokenName. Value is returned. \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 set the current value for.\r
- @param Buffer The Boolean value to set.\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 Return the Value that was set.\r
+ @return The status of the set operation.\r
\r
**/\r
-#define PcdSetBool(TokenName, Value) _PCD_SET_MODE_BOOL_##TokenName ((Value))\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
+\r
+ Returns the token number for the token specified by Guid and TokenName.\r
+ If TokenName is not a valid token in the token space, then the module will not build.\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 retrieve a current value for.\r
+\r
+ @return Return the token number.\r
+\r
+**/\r
+#define PcdTokenEx(Guid, TokenName) _PCD_TOKEN_EX_##TokenName(Guid)\r
\r
/**\r
Retrieves an 8-bit PCD token value based on a GUID and a token name.\r
\r
Returns 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
+ If TokenName is not a valid token in the token space specified by Guid,\r
then the module will not build.\r
- \r
+\r
If Guid is NULL, then ASSERT().\r
\r
- @param Guid Pointer to a 128-bit unique value that designates \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 retrieve a current value for. \r
+ @param TokenName The name of the PCD token to retrieve a current value for.\r
\r
@return An 8-bit PCD token value.\r
\r
**/\r
-#define PcdGetEx8(Guid, TokenName) LibPcdGetEx8 ((Guid), _PCD_TOKEN_##TokenName)\r
-\r
+#define PcdGetEx8(Guid, TokenName) LibPcdGetEx8 ((Guid), PcdTokenEx(Guid,TokenName))\r
\r
/**\r
Retrieves a 16-bit PCD token value based on a GUID and a token name.\r
\r
Returns 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
+ 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
+ @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 retrieve a current value for. \r
+ @param TokenName The name of the PCD token to retrieve a current value for.\r
\r
@return A 16-bit PCD token value.\r
\r
**/\r
-#define PcdGetEx16(Guid, TokenName) LibPcdGetEx16 ((Guid), _PCD_TOKEN_##TokenName)\r
-\r
+#define PcdGetEx16(Guid, TokenName) LibPcdGetEx16 ((Guid), PcdTokenEx(Guid,TokenName))\r
\r
/**\r
Retrieves a 32-bit PCD token value based on a GUID and a token name.\r
\r
Returns 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
+ 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
+ @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 retrieve a current value for. \r
+ @param TokenName The name of the PCD token to retrieve a current value for.\r
\r
@return A 32-bit PCD token value.\r
\r
**/\r
-#define PcdGetEx32(Guid, TokenName) LibPcdGetEx32 ((Guid), _PCD_TOKEN_##TokenName)\r
-\r
+#define PcdGetEx32(Guid, TokenName) LibPcdGetEx32 ((Guid), PcdTokenEx(Guid,TokenName))\r
\r
/**\r
Retrieves a 64-bit PCD token value based on a GUID and a token name.\r
\r
Returns 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
+ 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
+ @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 retrieve a current value for. \r
+ @param TokenName The name of the PCD token to retrieve a current value for.\r
\r
@return A 64-bit PCD token value.\r
\r
**/\r
-#define PcdGetEx64(Guid, TokenName) LibPcdGetEx64 ((Guid), _PCD_TOKEN_##TokenName)\r
-\r
+#define PcdGetEx64(Guid, TokenName) LibPcdGetEx64 ((Guid), PcdTokenEx(Guid,TokenName))\r
\r
/**\r
Retrieves a pointer to a PCD token buffer based on a GUID and a token name.\r
\r
Returns a pointer to the buffer for the token specified by Guid and TokenName.\r
- If TokenName is not a valid token in the token space specified by Guid, \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
+ @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 retrieve a current value for. \r
+ @param TokenName The name of the PCD token to retrieve a current value for.\r
\r
@return A pointer to a PCD token buffer.\r
\r
**/\r
-#define PcdGetExPtr(Guid, TokenName) LibPcdGetExPtr ((Guid), _PCD_TOKEN_##TokenName)\r
-\r
+#define PcdGetExPtr(Guid, TokenName) LibPcdGetExPtr ((Guid), PcdTokenEx(Guid,TokenName))\r
\r
/**\r
Retrieves a Boolean PCD token value based on a GUID and a token name.\r
\r
Returns 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
+ 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
+ @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 retrieve a current value for. \r
+ @param TokenName The name of the PCD token to retrieve a current value for.\r
\r
@return A Boolean PCD token value.\r
\r
**/\r
-#define PcdGetExBool(Guid, TokenName) LibPcdGetExBool ((Guid), _PCD_TOKEN_##TokenName)\r
-\r
+#define PcdGetExBool(Guid, TokenName) LibPcdGetExBool ((Guid), PcdTokenEx(Guid,TokenName))\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. Value is returned.\r
- If TokenName is not a valid token in the token space specified by Guid, \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
+ @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 Return the Value that was set.\r
+ @return The status of the set operation.\r
\r
**/\r
-#define PcdSetEx8(Guid, TokenName, Value) LibPcdSetEx8 ((Guid), _PCD_TOKEN_##TokenName, (Value))\r
-\r
+#define PcdSetEx8S(Guid, TokenName, Value) LibPcdSetEx8S ((Guid), PcdTokenEx(Guid,TokenName), (Value))\r
\r
/**\r
- Sets a 16-bit PCD token value based on a GUID and a token name.\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. Value is returned.\r
- If TokenName is not a valid token in the token space specified by Guid, \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
+ @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 Return the Value that was set.\r
+ @return The status of the set operation.\r
\r
**/\r
-#define PcdSetEx16(Guid, TokenName, Value) LibPcdSetEx16 ((Guid), _PCD_TOKEN_##TokenName, (Value))\r
-\r
+#define PcdSetEx16S(Guid, TokenName, Value) LibPcdSetEx16S ((Guid), PcdTokenEx(Guid,TokenName), (Value))\r
\r
/**\r
- Sets a 32-bit PCD token value based on a GUID and a token name.\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. Value is returned.\r
- If TokenName is not a valid token in the token space specified by Guid, \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
+ @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 Return the Value that was set.\r
+ @return The status of the set operation.\r
\r
**/\r
-#define PcdSetEx32(Guid, TokenName, Value) LibPcdSetEx32 ((Guid), _PCD_TOKEN_##TokenName, (Value))\r
-\r
+#define PcdSetEx32S(Guid, TokenName, Value) LibPcdSetEx32S ((Guid), PcdTokenEx(Guid,TokenName), (Value))\r
\r
/**\r
- Sets a 64-bit PCD token value based on a GUID and a token name.\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. Value is returned.\r
- If TokenName is not a valid token in the token space specified by Guid, \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
+ @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 Return the Value that was set.\r
+ @return The status of the set operation.\r
\r
**/\r
-#define PcdSetEx64(Guid, TokenName, Value) LibPcdSetEx64 ((Guid), _PCD_TOKEN_##TokenName, (Value))\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. Buffer is returned. \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
- 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.\r
- If TokenName is not a valid token in the token space specified by Guid, \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
+\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 Return the pointer to the Buffer that was set.\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
-**/\r
-#define PcdSetExPtr(Guid, TokenName, SizeOfBuffer, Buffer) \\r
- LibPcdSetExPtr ((Guid), _PCD_TOKEN_##TokenName, (SizeOfBuffer), (Buffer))\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
- Sets a Boolean PCD token value based on a GUID and a token name.\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. Value is returned. \r
- If TokenName is not a valid token in the token space specified by Guid, \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
+ @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 Return the Value that was set.\r
-\r
-**/ \r
-#define PcdSetExBool(Guid, TokenName, Value) \\r
- LibPcdSetExBool((Guid), _PCD_TOKEN_##TokenName, (Value))\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
Sets the current SKU in the PCD database to the value specified by SkuId. SkuId is returned.\r
- If SkuId >= PCD_MAX_SKU_ID, then ASSERT(). \r
\r
@param SkuId The SKU value that will be used when the PCD service retrieves and sets values\r
associated with a PCD token.\r
UINTN\r
EFIAPI\r
LibPcdSetSku (\r
- IN UINTN SkuId\r
+ IN UINTN SkuId\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
+ Returns the 8-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
- @return 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
EFIAPI\r
LibPcdGet8 (\r
- IN UINTN TokenNumber\r
+ IN UINTN TokenNumber\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
+ Returns the 16-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
- @return 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
EFIAPI\r
LibPcdGet16 (\r
- IN UINTN TokenNumber\r
+ IN UINTN TokenNumber\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
+ 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
UINT32\r
EFIAPI\r
LibPcdGet32 (\r
- IN UINTN TokenNumber\r
+ IN UINTN TokenNumber\r
);\r
\r
-\r
/**\r
This function provides a means by which to retrieve a value for a given PCD token.\r
- \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
UINT64\r
EFIAPI\r
LibPcdGet64 (\r
- IN UINTN TokenNumber\r
+ IN UINTN TokenNumber\r
);\r
\r
-\r
/**\r
This function provides a means by which to retrieve a value for a given PCD token.\r
- \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
VOID *\r
EFIAPI\r
LibPcdGetPtr (\r
- IN UINTN TokenNumber\r
+ IN UINTN TokenNumber\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
+ 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
- @return 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
+BOOLEAN\r
EFIAPI\r
LibPcdGetBool (\r
- IN UINTN TokenNumber\r
+ IN UINTN TokenNumber\r
);\r
\r
-\r
/**\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
- @return 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
EFIAPI\r
LibPcdGetSize (\r
- IN UINTN TokenNumber\r
+ IN UINTN TokenNumber\r
);\r
\r
-\r
/**\r
This function provides a means by which to retrieve a value for a given PCD token.\r
- \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
+ 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
UINT8\r
EFIAPI\r
LibPcdGetEx8 (\r
- IN CONST GUID *Guid,\r
- IN UINTN TokenNumber\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber\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
+ 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
UINT16\r
EFIAPI\r
LibPcdGetEx16 (\r
- IN CONST GUID *Guid,\r
- IN UINTN TokenNumber\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber\r
);\r
\r
-\r
/**\r
Returns the 32-bit value for the token specified by TokenNumber and Guid.\r
- If Guid is NULL, then ASSERT(). \r
+ If Guid is NULL, then ASSERT().\r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates \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
UINT32\r
EFIAPI\r
LibPcdGetEx32 (\r
- IN CONST GUID *Guid,\r
- IN UINTN TokenNumber\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber\r
);\r
\r
-\r
/**\r
This function provides a means by which to retrieve a value for a given PCD token.\r
- \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
+ 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
UINT64\r
EFIAPI\r
LibPcdGetEx64 (\r
- IN CONST GUID *Guid,\r
- IN UINTN TokenNumber\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber\r
);\r
\r
-\r
/**\r
This function provides a means by which to retrieve a value for a given PCD token.\r
- \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
+ 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
VOID *\r
EFIAPI\r
LibPcdGetExPtr (\r
- IN CONST GUID *Guid,\r
- IN UINTN TokenNumber\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber\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
+ 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
\r
BOOLEAN\r
EFIAPI\r
LibPcdGetExBool (\r
- IN CONST GUID *Guid,\r
- IN UINTN TokenNumber\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber\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
+ 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
\r
UINTN\r
EFIAPI\r
LibPcdGetExSize (\r
- IN CONST GUID *Guid,\r
- IN UINTN TokenNumber\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber\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
\r
- @return Return the Value that was set.\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
-UINT8\r
+RETURN_STATUS\r
EFIAPI\r
-LibPcdSet8 (\r
- IN UINTN TokenNumber,\r
- IN UINT8 Value\r
+LibPcdSet8S (\r
+ IN UINTN TokenNumber,\r
+ IN UINT8 Value\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
\r
- @return Return the Value that was set.\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
-UINT16\r
+RETURN_STATUS\r
EFIAPI\r
-LibPcdSet16 (\r
- IN UINTN TokenNumber,\r
- IN UINT16 Value\r
+LibPcdSet16S (\r
+ IN UINTN TokenNumber,\r
+ IN UINT16 Value\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
\r
- @return Return the Value that was set.\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
-UINT32\r
+RETURN_STATUS\r
EFIAPI\r
-LibPcdSet32 (\r
- IN UINTN TokenNumber,\r
- IN UINT32 Value\r
+LibPcdSet32S (\r
+ IN UINTN TokenNumber,\r
+ IN UINT32 Value\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
\r
- @return Return the Value that was set.\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
-UINT64\r
+RETURN_STATUS\r
EFIAPI\r
-LibPcdSet64 (\r
- IN UINTN TokenNumber,\r
- IN UINT64 Value\r
+LibPcdSet64S (\r
+ IN UINTN TokenNumber,\r
+ IN UINT64 Value\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 \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
+\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
+\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 Return the pointer for the Buffer that was set.\r
+ @return The status of the set operation.\r
\r
**/\r
-VOID *\r
+RETURN_STATUS\r
EFIAPI\r
-LibPcdSetPtr (\r
- IN UINTN TokenNumber,\r
- IN OUT UINTN *SizeOfBuffer,\r
- IN CONST VOID *Buffer\r
+LibPcdSetPtrS (\r
+ IN UINTN TokenNumber,\r
+ IN OUT UINTN *SizeOfBuffer,\r
+ IN CONST VOID *Buffer\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
\r
- @return Return the Value that was set.\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
-BOOLEAN\r
+RETURN_STATUS\r
EFIAPI\r
-LibPcdSetBool (\r
- IN UINTN TokenNumber,\r
- IN BOOLEAN Value\r
+LibPcdSetBoolS (\r
+ IN UINTN TokenNumber,\r
+ IN BOOLEAN Value\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
+\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 Pointer to a 128-bit unique value that \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
+ @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 Return the Value that was set.\r
+ @return The status of the set operation.\r
\r
**/\r
-UINT8\r
+RETURN_STATUS\r
EFIAPI\r
-LibPcdSetEx8 (\r
- IN CONST GUID *Guid,\r
- IN UINTN TokenNumber,\r
- IN UINT8 Value\r
+LibPcdSetEx8S (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN UINT8 Value\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
+\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 Pointer to a 128-bit unique value that \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
+ @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 Return the Value that was set.\r
+ @return The status of the set operation.\r
\r
**/\r
-UINT16\r
+RETURN_STATUS\r
EFIAPI\r
-LibPcdSetEx16 (\r
- IN CONST GUID *Guid,\r
- IN UINTN TokenNumber,\r
- IN UINT16 Value\r
+LibPcdSetEx16S (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN UINT16 Value\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
+\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 Pointer to a 128-bit unique value that \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
+ @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 Return the Value that was set.\r
+ @return The status of the set operation.\r
\r
**/\r
-UINT32\r
+RETURN_STATUS\r
EFIAPI\r
-LibPcdSetEx32 (\r
- IN CONST GUID *Guid,\r
- IN UINTN TokenNumber,\r
- IN UINT32 Value\r
+LibPcdSetEx32S (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN UINT32 Value\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
+\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 Pointer to a 128-bit unique value that \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
+ @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 Return the Value that was set.\r
+ @return The status of the set operation.\r
\r
**/\r
-UINT64\r
+RETURN_STATUS\r
EFIAPI\r
-LibPcdSetEx64 (\r
- IN CONST GUID *Guid,\r
- IN UINTN TokenNumber,\r
- IN UINT64 Value\r
+LibPcdSetEx64S (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN UINT64 Value\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 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
+\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
+\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] 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] Buffer A pointer to the buffer to set.\r
\r
- @return Return the pointer to the Buffer that was set.\r
+ @return The status of the set operation.\r
\r
**/\r
-VOID *\r
+RETURN_STATUS\r
EFIAPI\r
-LibPcdSetExPtr (\r
- IN CONST GUID *Guid,\r
- IN UINTN TokenNumber,\r
- IN OUT UINTN *SizeOfBuffer,\r
- IN VOID *Buffer\r
+LibPcdSetExPtrS (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN OUT UINTN *SizeOfBuffer,\r
+ IN VOID *Buffer\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
+\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 Pointer to a 128-bit unique value that \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
+ @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 Return the Value that was set.\r
+ @return The status of the set operation.\r
\r
**/\r
-BOOLEAN\r
+RETURN_STATUS\r
EFIAPI\r
-LibPcdSetExBool (\r
- IN CONST GUID *Guid,\r
- IN UINTN TokenNumber,\r
- IN BOOLEAN Value\r
+LibPcdSetExBoolS (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ IN BOOLEAN Value\r
);\r
\r
-\r
/**\r
This notification function serves two purposes.\r
\r
Secondly, it provides a mechanism for the module that did the registration to intercept\r
the set operation and override the value been set if necessary. After the invocation of\r
the callback function, TokenData will be used by PCD service PEIM or driver to modify th\r
- internal data in PCD database. \r
+ internal data in PCD database.\r
\r
@param[in] CallBackGuid The PCD token GUID being set.\r
@param[in] CallBackToken The PCD token number being set.\r
typedef\r
VOID\r
(EFIAPI *PCD_CALLBACK)(\r
- IN CONST GUID *CallBackGuid, OPTIONAL\r
+ IN CONST GUID *CallBackGuid OPTIONAL,\r
IN UINTN CallBackToken,\r
IN OUT VOID *TokenData,\r
IN UINTN TokenDataSize\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
+\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
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
+ @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
+ @param[in] NotificationFunction The function to call when the token\r
specified by Guid and TokenNumber is set.\r
\r
**/\r
VOID\r
EFIAPI\r
LibPcdCallbackOnSet (\r
- IN CONST GUID *Guid, OPTIONAL\r
- IN UINTN TokenNumber,\r
- IN PCD_CALLBACK NotificationFunction\r
+ IN CONST GUID *Guid OPTIONAL,\r
+ IN UINTN TokenNumber,\r
+ IN PCD_CALLBACK NotificationFunction\r
);\r
\r
-\r
/**\r
Disable a notification function that was established with LibPcdCallbackonSet().\r
- \r
+\r
Disable a notification function that was previously established with LibPcdCallbackOnSet().\r
If NotificationFunction is NULL, then ASSERT().\r
- If LibPcdCallbackOnSet() was not previously called with Guid, TokenNumber, \r
+ If LibPcdCallbackOnSet() was not previously called with Guid, TokenNumber,\r
and NotificationFunction, then ASSERT().\r
- \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
VOID\r
EFIAPI\r
LibPcdCancelCallback (\r
- IN CONST GUID *Guid, OPTIONAL\r
- IN UINTN TokenNumber,\r
- IN PCD_CALLBACK NotificationFunction\r
+ IN CONST GUID *Guid OPTIONAL,\r
+ IN UINTN TokenNumber,\r
+ IN PCD_CALLBACK NotificationFunction\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. \r
- \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.\r
+\r
If TokenNumber is not 0 and is not in the token space specified by Guid, then ASSERT().\r
\r
- @param[in] Guid Pointer to a 128-bit unique value that designates which namespace \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
+ @param[in] TokenNumber The previous PCD token number. If 0, then retrieves the first PCD\r
token number.\r
\r
@return The next valid token number.\r
\r
**/\r
-UINTN \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
-\r
-\r
/**\r
Used to retrieve the list of available PCD token space GUIDs.\r
- \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
+\r
@param TokenSpaceGuid Pointer to the a PCD token space GUID\r
\r
@return The next valid token namespace.\r
IN CONST GUID *TokenSpaceGuid\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
+\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
+\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
+ @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
+\r
@return Return the pointer to the Buffer that was 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
+ 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
+ PCD_TYPE_32,\r
+ PCD_TYPE_64,\r
+ PCD_TYPE_BOOL,\r
+ PCD_TYPE_PTR\r
+} PCD_TYPE;\r
+\r
+typedef struct {\r
+ ///\r
+ /// The returned information associated with the requested TokenNumber. If\r
+ /// TokenNumber is 0, then PcdType is set to PCD_TYPE_8.\r
+ ///\r
+ PCD_TYPE PcdType;\r
+ ///\r
+ /// The size of the data in bytes associated with the TokenNumber specified. If\r
+ /// TokenNumber is 0, then PcdSize is set 0.\r
+ ///\r
+ UINTN PcdSize;\r
+ ///\r
+ /// The null-terminated ASCII string associated with a given token. If the\r
+ /// TokenNumber specified was 0, then this field corresponds to the null-terminated\r
+ /// ASCII string associated with the token's namespace Guid. If NULL, there is no\r
+ /// name associated with this request.\r
+ ///\r
+ CHAR8 *PcdName;\r
+} PCD_INFO;\r
+\r
+/**\r
+ Retrieve additional information associated with a PCD token.\r
+\r
+ This includes information such as the type of value the TokenNumber is associated with as well as possible\r
+ human readable name that is associated with the token.\r
+\r
+ If TokenNumber is not in the default token space specified, then ASSERT().\r
+\r
+ @param[in] TokenNumber The PCD token number.\r
+ @param[out] PcdInfo The returned information associated with the requested TokenNumber.\r
+ The caller is responsible for freeing the buffer that is allocated by callee for PcdInfo->PcdName.\r
+**/\r
+VOID\r
+EFIAPI\r
+LibPcdGetInfo (\r
+ IN UINTN TokenNumber,\r
+ OUT PCD_INFO *PcdInfo\r
+ );\r
+\r
+/**\r
+ Retrieve additional information associated with a PCD token.\r
+\r
+ This includes information such as the type of value the TokenNumber is associated with as well as possible\r
+ human readable name that is associated with the token.\r
+\r
+ If TokenNumber is not in the token space specified by Guid, then ASSERT().\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[out] PcdInfo The returned information associated with the requested TokenNumber.\r
+ The caller is responsible for freeing the buffer that is allocated by callee for PcdInfo->PcdName.\r
+**/\r
+VOID\r
+EFIAPI\r
+LibPcdGetInfoEx (\r
+ IN CONST GUID *Guid,\r
+ IN UINTN TokenNumber,\r
+ OUT PCD_INFO *PcdInfo\r
+ );\r
+\r
+/**\r
+ Retrieve the currently set SKU Id.\r
+\r
+ @return The currently set SKU Id. If the platform has not set at a SKU Id, then the\r
+ default SKU Id value of 0 is returned. If the platform has set a SKU Id, then the currently set SKU\r
+ Id is returned.\r
+**/\r
+UINTN\r
+EFIAPI\r
+LibPcdGetSku (\r
+ VOID\r
);\r
\r
#endif\r
projects / mirror_edk2.git / blobdiff