/** @file\r
Implementation of PcdLib class library for PEI phase.\r
\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
-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
/**\r
Retrieve the PCD_PPI pointer.\r
\r
- This function is to locate PCD_PPI PPI via PeiService. \r
+ This function is to locate PCD_PPI PPI via PeiService.\r
If fail to locate PCD_PPI, then ASSERT_EFI_ERROR().\r
- \r
+\r
@retval PCD_PPI * The pointer to the PCD_PPI.\r
\r
**/\r
PCD_PPI *\r
GetPcdPpiPointer (\r
VOID\r
- ) \r
+ )\r
{\r
EFI_STATUS Status;\r
PCD_PPI *PcdPpi;\r
- \r
+\r
Status = PeiServicesLocatePpi (&gPcdPpiGuid, 0, NULL, (VOID **)&PcdPpi);\r
ASSERT_EFI_ERROR (Status);\r
\r
/**\r
Retrieve the pointer of EFI_PEI_PCD_PPI defined in PI 1.2 Vol 3.\r
\r
- This function is to locate EFI_PEI_PCD_PPI PPI via PeiService. \r
+ This function is to locate EFI_PEI_PCD_PPI PPI via PeiService.\r
If fail to locate EFI_PEI_PCD_PPI, then ASSERT_EFI_ERROR().\r
- \r
+\r
@retval EFI_PEI_PCD_PPI * The pointer to the EFI_PEI_PCD_PPI.\r
\r
**/\r
{\r
EFI_STATUS Status;\r
EFI_PEI_PCD_PPI *PiPcdPpi;\r
- \r
+\r
Status = PeiServicesLocatePpi (&gEfiPeiPcdPpiGuid, 0, NULL, (VOID **)&PiPcdPpi);\r
ASSERT_EFI_ERROR (Status);\r
- \r
+\r
return PiPcdPpi;\r
-} \r
+}\r
\r
/**\r
Retrieve the GET_PCD_INFO_PPI pointer.\r
\r
- This function is to locate GET_PCD_INFO_PPI PPI via PeiService. \r
+ This function is to locate GET_PCD_INFO_PPI PPI via PeiService.\r
If fail to locate GET_PCD_INFO_PPI, then ASSERT_EFI_ERROR().\r
\r
@retval GET_PCD_INFO_PPI * The pointer to the GET_PCD_INFO_PPI.\r
GET_PCD_INFO_PPI *\r
GetPcdInfoPpiPointer (\r
VOID\r
- ) \r
+ )\r
{\r
EFI_STATUS Status;\r
GET_PCD_INFO_PPI *PcdInfoPpi;\r
- \r
+\r
Status = PeiServicesLocatePpi (&gGetPcdInfoPpiGuid, 0, NULL, (VOID **)&PcdInfoPpi);\r
ASSERT_EFI_ERROR (Status);\r
\r
/**\r
Retrieve the pointer of EFI_GET_PCD_INFO_PPI defined in PI 1.2.1 Vol 3.\r
\r
- This function is to locate EFI_GET_PCD_INFO_PPI PPI via PeiService. \r
+ This function is to locate EFI_GET_PCD_INFO_PPI PPI via PeiService.\r
If fail to locate EFI_GET_PCD_INFO_PPI, then ASSERT_EFI_ERROR().\r
\r
@retval EFI_GET_PCD_INFO_PPI * The pointer to the EFI_GET_PCD_INFO_PPI.\r
{\r
EFI_STATUS Status;\r
EFI_GET_PCD_INFO_PPI *PiPcdInfoPpi;\r
- \r
+\r
Status = PeiServicesLocatePpi (&gEfiGetPcdInfoPpiGuid, 0, NULL, (VOID **)&PiPcdInfoPpi);\r
ASSERT_EFI_ERROR (Status);\r
- \r
+\r
return PiPcdInfoPpi;\r
-} \r
+}\r
\r
/**\r
This function provides a means by which SKU support can be established in the PCD infrastructure.\r
\r
Sets the current SKU in the PCD database to the value specified by SkuId. SkuId is returned.\r
- If SkuId >= PCD_MAX_SKU_ID, then ASSERT(). \r
\r
- @param SkuId The SKU value that will be used when the PCD service retrieves \r
+ @param SkuId The SKU value that will be used when the PCD service retrieves\r
and sets values associated with a PCD token.\r
\r
@return Return the SKU ID that just be set.\r
IN UINTN SkuId\r
)\r
{\r
-\r
- ASSERT (SkuId < PCD_MAX_SKU_ID);\r
-\r
GetPiPcdPpiPointer()->SetSku (SkuId);\r
- \r
+\r
return 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
\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
\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
\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
\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
\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
\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
\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 The pointer to a 128-bit unique value that designates \r
+ If Guid is NULL, then ASSERT().\r
+\r
+ @param[in] Guid The 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
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 The pointer to a 128-bit unique value that designates \r
+ If Guid is NULL, then ASSERT().\r
+\r
+ @param[in] Guid The 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
\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 The pointer to a 128-bit unique value that designates \r
+ @param[in] Guid The 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
\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 The pointer to a 128-bit unique value that designates \r
+ If Guid is NULL, then ASSERT().\r
+\r
+ @param[in] Guid The 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
\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 The pointer to a 128-bit unique value that designates \r
+ If Guid is NULL, then ASSERT().\r
+\r
+ @param[in] Guid The 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
\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 The 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 The 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
\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 The 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 The 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
#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
+\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
)\r
{\r
(GetPcdPpiPointer ())->Set8 (TokenNumber, Value);\r
- \r
+\r
return 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
+\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
)\r
{\r
(GetPcdPpiPointer ())->Set16 (TokenNumber, Value);\r
- \r
+\r
return 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
+\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
\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
+\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
\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
+\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
+ 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
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
/**\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
+\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
\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
+\r
+ Sets the 8-bit value for the token specified by TokenNumber and\r
Guid to the value specified by Value. Value is returned.\r
\r
If Guid is NULL, then ASSERT().\r
\r
- @param[in] Guid The pointer to a 128-bit unique value that \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
/**\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
+\r
+ Sets the 16-bit value for the token specified by TokenNumber and\r
Guid to the value specified by Value. Value is returned.\r
\r
If Guid is NULL, then ASSERT().\r
\r
- @param[in] Guid The pointer to a 128-bit unique value that \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
/**\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
+\r
+ Sets the 32-bit value for the token specified by TokenNumber and\r
Guid to the value specified by Value. Value is returned.\r
\r
If Guid is NULL, then ASSERT().\r
\r
- @param[in] Guid The pointer to a 128-bit unique value that \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
/**\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
+\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
If Guid is NULL, then ASSERT().\r
\r
- @param[in] Guid The pointer to a 128-bit unique value that \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
/**\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
+\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
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 The 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, out] SizeOfBuffer The size, in bytes, of Buffer.\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
+\r
+ Sets the Boolean value for the token specified by TokenNumber and\r
Guid to the value specified by Value. Value is returned.\r
\r
If Guid is NULL, then ASSERT().\r
\r
- @param[in] Guid The pointer to a 128-bit unique value that \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
/**\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 The pointer to a 128-bit unique value that \r
- designates which namespace to set a value from. \r
+ @param[in] Guid The pointer to a 128-bit unique value that\r
+ designates which namespace to set a value from.\r
If NULL, then the default 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
\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
\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 The pointer to a 128-bit unique value that designates which namespace \r
+ @param[in] Guid The 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
\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 The pointer to the a PCD token space GUID\r
\r
@return The next valid token namespace.\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 been set.\r
\r
**/\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
ASSERT (PatchVariable != NULL);\r
ASSERT (SizeOfBuffer != NULL);\r
- \r
+\r
if (*SizeOfBuffer > 0) {\r
ASSERT (Buffer != NULL);\r
}\r
*SizeOfBuffer = MaximumDatumSize;\r
return NULL;\r
}\r
- \r
+\r
CopyMem (PatchVariable, Buffer, *SizeOfBuffer);\r
- \r
+\r
return (VOID *) Buffer;\r
}\r
\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 The status of the set operation.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
LibPatchPcdSetPtrS (\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
+ ASSERT (PatchVariable != NULL);\r
+ ASSERT (SizeOfBuffer != NULL);\r
+\r
+ if (*SizeOfBuffer > 0) {\r
+ ASSERT (Buffer != NULL);\r
+ }\r
+\r
+ if ((*SizeOfBuffer > MaximumDatumSize) ||\r
+ (*SizeOfBuffer == MAX_ADDRESS)) {\r
+ *SizeOfBuffer = MaximumDatumSize;\r
+ return RETURN_INVALID_PARAMETER;\r
+ }\r
+\r
+ CopyMem (PatchVariable, Buffer, *SizeOfBuffer);\r
+\r
+ return RETURN_SUCCESS;\r
+}\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 been 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
+ ASSERT (PatchVariable != NULL);\r
+ ASSERT (SizeOfPatchVariable != NULL);\r
+ ASSERT (SizeOfBuffer != NULL);\r
+\r
+ if (*SizeOfBuffer > 0) {\r
+ ASSERT (Buffer != NULL);\r
+ }\r
+\r
+ if ((*SizeOfBuffer > MaximumDatumSize) ||\r
+ (*SizeOfBuffer == MAX_ADDRESS)) {\r
+ *SizeOfBuffer = MaximumDatumSize;\r
+ return NULL;\r
+ }\r
+\r
+ CopyMem (PatchVariable, Buffer, *SizeOfBuffer);\r
+ *SizeOfPatchVariable = *SizeOfBuffer;\r
+\r
+ return (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
ASSERT (PatchVariable != NULL);\r
+ ASSERT (SizeOfPatchVariable != NULL);\r
ASSERT (SizeOfBuffer != NULL);\r
- \r
+\r
if (*SizeOfBuffer > 0) {\r
ASSERT (Buffer != NULL);\r
}\r
}\r
\r
CopyMem (PatchVariable, Buffer, *SizeOfBuffer);\r
+ *SizeOfPatchVariable = *SizeOfBuffer;\r
\r
return RETURN_SUCCESS;\r
}\r
/**\r
Retrieve the currently set SKU Id.\r
\r
- If the sku id got >= PCD_MAX_SKU_ID, then ASSERT().\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
VOID\r
)\r
{\r
- UINTN SkuId;\r
-\r
- SkuId = GetPiPcdInfoPpiPointer()->GetSku ();\r
- ASSERT (SkuId < PCD_MAX_SKU_ID);\r
-\r
- return SkuId;\r
+ return GetPiPcdInfoPpiPointer()->GetSku ();\r
}\r
projects / mirror_edk2.git / blobdiff