Add in function description and comments.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@1026 6f19259b-4bc3-4df7-8a09-765794883524

5 files changed, 18 insertions, 24 deletions

diff --git a/EdkModulePkg/Universal/PCD/Dxe/Pcd.c b/EdkModulePkg/Universal/PCD/Dxe/Pcd.c
index 437006f05c..4e6b11a046 100644
--- a/EdkModulePkg/Universal/PCD/Dxe/Pcd.c
+++ b/EdkModulePkg/Universal/PCD/Dxe/Pcd.c
@@ -80,10 +80,6 @@ PcdDxeInit (
 

   BuildPcdDxeDataBase ();

 

-  //

-  // BugBug Check if PcdDatabase is already installed.

-  //

-  

   Status = gBS->InstallProtocolInterface (

                   &NewHandle,

                   &gPcdProtocolGuid,

diff --git a/EdkModulePkg/Universal/PCD/Dxe/Pcd.dxs b/EdkModulePkg/Universal/PCD/Dxe/Pcd.dxs
index 9e814a6f85..d65291b091 100644
--- a/EdkModulePkg/Universal/PCD/Dxe/Pcd.dxs
+++ b/EdkModulePkg/Universal/PCD/Dxe/Pcd.dxs
@@ -11,7 +11,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 

 Module Name:

 

-  PcdEmulator.dxs

+  Pcd.dxs

 

 Abstract:

 

diff --git a/EdkModulePkg/Universal/PCD/Dxe/Service.c b/EdkModulePkg/Universal/PCD/Dxe/Service.c
index 1a377fe763..ff93ef5421 100644
--- a/EdkModulePkg/Universal/PCD/Dxe/Service.c
+++ b/EdkModulePkg/Universal/PCD/Dxe/Service.c
@@ -1,5 +1,5 @@
 /** @file

-Private functions used by PCD DXE driver.s

+Private functions used by PCD DXE driver.

 

 Copyright (c) 2006, Intel Corporation

 All rights reserved. This program and the accompanying materials

@@ -17,11 +17,6 @@ Module Name: Service.c
 #include "Service.h"

 

 

-//

-// Build Tool will generate DXE_PCD_DB_INIT_VALUE in Autogen.h

-// Compression Algorithm will take care of the size optimization.

-//

-

 PCD_DATABASE * mPcdDatabase;

 

 LIST_ENTRY *mCallbackFnTable;

@@ -341,7 +336,6 @@ BuildPcdDxeDataBase (
   ASSERT (mPcdDatabase != NULL);

 

   GuidHob = GetFirstGuidHob (&gPcdDataBaseHobGuid);

-

   if (GuidHob != NULL) {

 

     //

diff --git a/EdkModulePkg/Universal/PCD/Pei/Pcd.dxs b/EdkModulePkg/Universal/PCD/Pei/Pcd.dxs
index ea579976c8..3bad561b78 100644
--- a/EdkModulePkg/Universal/PCD/Pei/Pcd.dxs
+++ b/EdkModulePkg/Universal/PCD/Pei/Pcd.dxs
@@ -11,7 +11,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 

 Module Name:

 

-  PcdEmulator.dxs

+  Pcd.dxs

 

 Abstract:

 

diff --git a/EdkModulePkg/Universal/PCD/Pei/Service.c b/EdkModulePkg/Universal/PCD/Pei/Service.c
index 7b13dc2fa0..255267c9ab 100644
--- a/EdkModulePkg/Universal/PCD/Pei/Service.c
+++ b/EdkModulePkg/Universal/PCD/Pei/Service.c
@@ -20,12 +20,15 @@ Module Name: Service.c
   The function registers the CallBackOnSet fucntion

   according to TokenNumber and EFI_GUID space.

 

-  @param[in]  TokenNumber       The token number.

-  @param[in]  Guid              The GUID space.

-  @param[in]  CallBackFunction  The Callback function to be registered.

+  @param  TokenNumber       The token number.

+  @param  Guid              The GUID space.

+  @param  CallBackFunction  The Callback function to be registered.

+  @param  Register          To register or unregister the callback function.

 

   @retval EFI_SUCCESS If the Callback function is registered.

   @retval EFI_NOT_FOUND If the PCD Entry is not found according to Token Number and GUID space.

+  @retval EFI_OUT_OF_RESOURCES If the callback function can't be registered because there is not free

+                                slot left in the CallbackFnTable.

 --*/

 EFI_STATUS

 PeiRegisterCallBackWorker (

@@ -103,10 +106,9 @@ PeiRegisterCallBackWorker (
 

 

 /**

-  The function builds the PCD database based on the

-  PCD_IMAGE on the flash.

+  The function builds the PCD database.

 

-  @param[in] PcdImageOnFlash  The PCD image on flash.

+  @param VOID

 

   @retval VOID

 --*/

@@ -144,13 +146,13 @@ BuildPcdDatabase (
   The function is provided by PCD PEIM and PCD DXE driver to

   do the work of reading a HII variable from variable service.

 

-  @param[in] VariableGuid     The Variable GUID.

-  @param[in] VariableName     The Variable Name.

-  @param[out] VariableData    The output data.

-  @param[out] VariableSize    The size of the variable.

+  @param VariableGuid     The Variable GUID.

+  @param VariableName     The Variable Name.

+  @param VariableData    The output data.

+  @param VariableSize    The size of the variable.

 

   @retval EFI_SUCCESS         Operation successful.

-  @retval EFI_SUCCESS         Variablel not found.

+  @retval EFI_NOT_FOUND         Variablel not found.

 --*/

 EFI_STATUS

 GetHiiVariable (

@@ -580,6 +582,7 @@ GetWorker (
 }

 

 

+

 UINTN           

 GetExPcdTokenNumber (

   IN CONST EFI_GUID             *Guid,

@@ -635,6 +638,7 @@ GetPcdDatabase (
 }

 

 

+

 SKU_ID *

 GetSkuIdArray (

   IN    UINTN             LocalTokenNumberTableIdx,