/** @file\r
-PCD Library Class provides PCD usage macro interface for all PCD types. It should be \r
-included at any module who use PCD. \r
+ Provides library services to get and set Platform Configuration Database entries.\r
\r
-If module use dynamic/dynamicex PCD, module should be linked to PEIM/DXE library \r
-instance to access that PCD.\r
-If module uses PatchableInModule type PCD, also need library instance produce LibPatchPcdSetPtr()\r
-interface.\r
-For FeatureFlag/Fixed PCD, macro interface is translated to an variable or macro\r
-which is auto-generated by build tool in module's autogen.h/autogen.c\r
+ PCD Library Class provides PCD usage macro interface for all PCD types.\r
+ It should be included at any module who use PCD. If module use dynamic/dynamicex\r
+ PCD, module should be linked to PEIM/DXE library instance to access that PCD.\r
+ If module uses PatchableInModule type PCD, also need library instance produce\r
+ LibPatchPcdSetPtr() interface. For FeatureFlag/Fixed PCD, macro interface is\r
+ translated to an variable or macro which is auto-generated by build tool in\r
+ module's autogen.h/autogen.c.\r
\r
-Copyright (c) 2006 - 2008, Intel Corporation. <BR> \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 - 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
\r
**/\r
\r
#ifndef __PCD_LIB_H__\r
#define __PCD_LIB_H__\r
\r
-#define PCD_INVALID_TOKEN_NUMBER ((UINTN) 0)\r
#define PCD_MAX_SKU_ID 0x100\r
\r
#define PcdToken(TokenName) _PCD_TOKEN_##TokenName\r
\r
/**\r
Sets a buffer for the token specified by TokenNumber to the value \r
- specified by Buffer and SizeOfValue. Buffer is returned. \r
- If SizeOfValue is greater than the maximum size support by TokenNumber, \r
- then set SizeOfValue to the maximum size supported by TokenNumber and \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 SizeOfValue is set to MAX_ADDRESS, then SizeOfValue must be set to the \r
+ If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to the \r
maximum size supported by TokenName and NULL must be returned.\r
\r
- If SizeOfValue is NULL, then ASSERT().\r
- If SizeOfValue > 0 and Buffer is NULL, then ASSERT().\r
+ If SizeOfBuffer is NULL, then ASSERT().\r
+ If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
\r
@param[in] TokenNumber The PCD token number to set a current value for.\r
- @param[in,out] SizeOfBuffer The size, in bytes, of Buffer.\r
+ @param[in, out] SizeOfBuffer The size, in bytes, of Buffer.\r
@param[in] Buffer Value A pointer to the buffer to set.\r
\r
@return Return the pointer for the buffer been set.\r
\r
/**\r
Sets a buffer for the token specified by TokenNumber to the value specified by \r
- Buffer and SizeOfValue. Buffer is returned. If SizeOfValue is greater than \r
- the maximum size support by TokenNumber, then set SizeOfValue to the maximum size \r
+ Buffer and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than \r
+ the maximum size support by TokenNumber, then set SizeOfBuffer to the maximum size \r
supported by TokenNumber and return NULL to indicate that the set operation \r
was not actually performed. \r
\r
If Guid is NULL, then ASSERT().\r
- If SizeOfValue is NULL, then ASSERT().\r
- If SizeOfValue > 0 and Buffer is NULL, then ASSERT().\r
+ If SizeOfBuffer is NULL, then ASSERT().\r
+ If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
\r
@param[in] Guid Pointer to a 128-bit unique value that \r
designates which namespace to set a value from.\r
\r
/**\r
Sets the PCD entry specified by PatchVariable to the value specified by Buffer \r
- and SizeOfValue. Buffer is returned. If SizeOfValue is greater than \r
- MaximumDatumSize, then set SizeOfValue to MaximumDatumSize and return \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 SizeOfValue is set to MAX_ADDRESS, then SizeOfValue must be set to \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 SizeOfValue is NULL, then ASSERT().\r
- If SizeOfValue > 0 and Buffer is NULL, then ASSERT().\r
+ If SizeOfBuffer is NULL, then ASSERT().\r
+ If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
\r
@param[in] PatchVariable A pointer to the global variable in a module that is \r
the target of the set operation.\r
projects / mirror_edk2.git / blobdiff