1. Removed #ifdef EDK_RELEASE_VERSION from all c files for all modules

2. Removed #ifdef EFI_SPECIFICATION_VERSION from all c files for all modules
3. Added comments for file VariableWorker.c

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

7 files changed, 122 insertions, 82 deletions

diff --git a/EdkModulePkg/Universal/Variable/Pei/Ipf/VariableWorker.c b/EdkModulePkg/Universal/Variable/Pei/Ipf/VariableWorker.c
index 302bc14689..0a4ee95774 100644
--- a/EdkModulePkg/Universal/Variable/Pei/Ipf/VariableWorker.c
+++ b/EdkModulePkg/Universal/Variable/Pei/Ipf/VariableWorker.c
@@ -1,27 +1,29 @@
-/*++

+/** @file

+  Variable worker functions.

 

-Copyright (c) 2007, Intel Corporation

-All rights reserved. This program and the accompanying materials

-are licensed and made available under the terms and conditions of the BSD License

-which accompanies this distribution.  The full text of the license may be found at

-http://opensource.org/licenses/bsd-license.php

+  Copyright (c) 2006, Intel Corporation<BR>

+  All rights reserved. This program and the accompanying materials

+  are licensed and made available under the terms and conditions of the BSD License

+  which accompanies this distribution.  The full text of the license may be found at

+  http://opensource.org/licenses/bsd-license.php

 

-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 

-Module Name:

+**/

 

-  VariableWorker.c

-

-Abstract:

+#include <Variable.h>

 

-  Framework PEIM to provide the Variable functionality

 

---*/

+/**

+  Get one variable by the index count.

 

-#include <Variable.h>

+  @param  IndexTable  The pointer to variable index table.

+  @param  Count       The index count of variable in index table.

 

+  @return The pointer to variable header indexed by count.

 

+**/

 VARIABLE_HEADER *

 GetVariableByIndex (

   IN VARIABLE_INDEX_TABLE        *IndexTable,

@@ -31,6 +33,17 @@ GetVariableByIndex (
   return (VARIABLE_HEADER *) (UINTN) ((((UINT32)IndexTable->Index[Count]) << 2) + ((UINT32)(UINTN)IndexTable->StartPtr & 0xFFFC0000) );

 }

 

+/**

+  Record Variable in VariableIndex HOB.

+

+  Record Variable in VariableIndex HOB and update the length of variable index table.

+

+  @param  IndexTable  The pointer to variable index table.

+  @param  Variable    The pointer to the variable that will be recorded.

+

+  @retval VOID

+

+**/

 VOID

 VariableIndexTableUpdate (

   IN OUT  VARIABLE_INDEX_TABLE   *IndexTable,

diff --git a/EdkModulePkg/Universal/Variable/Pei/Variable.h b/EdkModulePkg/Universal/Variable/Pei/Variable.h
index d400af4d14..519fcf9c22 100644
--- a/EdkModulePkg/Universal/Variable/Pei/Variable.h
+++ b/EdkModulePkg/Universal/Variable/Pei/Variable.h
@@ -1,6 +1,6 @@
 /*++

 

-Copyright (c) 2006, Intel Corporation

+Copyright (c) 2006 - 2007, Intel Corporation

 All rights reserved. This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -150,12 +150,32 @@ Returns:
 --*/

 ;

 

+/**

+  Get one variable by the index count.

+

+  @param  IndexTable  The pointer to variable index table.

+  @param  Count       The index count of variable in index table.

+

+  @return The pointer to variable header indexed by count.

+

+**/

 VARIABLE_HEADER *

 GetVariableByIndex (

   IN VARIABLE_INDEX_TABLE        *IndexTable,

   IN UINT32                      Count

   );

 

+/**

+  Record Variable in VariableIndex HOB.

+

+  Record Variable in VariableIndex HOB and update the length of variable index table.

+

+  @param  IndexTable  The pointer to variable index table.

+  @param  Variable    The pointer to the variable that will be recorded.

+

+  @retval VOID

+

+**/

 VOID

 VariableIndexTableUpdate (

   IN OUT  VARIABLE_INDEX_TABLE   *IndexTable,

diff --git a/EdkModulePkg/Universal/Variable/Pei/VariableWorker.c b/EdkModulePkg/Universal/Variable/Pei/VariableWorker.c
index ae64cb07ca..1a49ee8c98 100644
--- a/EdkModulePkg/Universal/Variable/Pei/VariableWorker.c
+++ b/EdkModulePkg/Universal/Variable/Pei/VariableWorker.c
@@ -21,7 +21,15 @@ Abstract:
 

 #include <Variable.h>

 

+/**

+  Get one variable by the index count.

 

+  @param  IndexTable  The pointer to variable index table.

+  @param  Count       The index count of variable in index table.

+

+  @return The pointer to variable header indexed by count.

+

+**/

 VARIABLE_HEADER *

 GetVariableByIndex (

   IN VARIABLE_INDEX_TABLE        *IndexTable,

@@ -31,6 +39,17 @@ GetVariableByIndex (
   return (VARIABLE_HEADER *) (UINTN) (IndexTable->Index[Count] + ((UINTN) IndexTable->StartPtr & 0xFFFF0000));

 }

 

+/**

+  Record Variable in VariableIndex HOB.

+

+  Record Variable in VariableIndex HOB and update the length of variable index table.

+

+  @param  IndexTable  The pointer to variable index table.

+  @param  Variable    The pointer to the variable that will be recorded.

+

+  @retval VOID

+

+**/

 VOID

 VariableIndexTableUpdate (

   IN OUT  VARIABLE_INDEX_TABLE   *IndexTable,

diff --git a/EdkModulePkg/Universal/Variable/RuntimeDxe/InitVariable.c b/EdkModulePkg/Universal/Variable/RuntimeDxe/InitVariable.c
index 570ba7257e..efff41c253 100644
--- a/EdkModulePkg/Universal/Variable/RuntimeDxe/InitVariable.c
+++ b/EdkModulePkg/Universal/Variable/RuntimeDxe/InitVariable.c
@@ -1,13 +1,13 @@
 /*++

 

-Copyright (c) 2006 - 2007, Intel Corporation                                                         

-All rights reserved. This program and the accompanying materials                          

-are licensed and made available under the terms and conditions of the BSD License         

-which accompanies this distribution.  The full text of the license may be found at        

-http://opensource.org/licenses/bsd-license.php                                            

-                                                                                          

-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

+Copyright (c) 2006 - 2007, Intel Corporation

+All rights reserved. This program and the accompanying materials

+are licensed and made available under the terms and conditions of the BSD License

+which accompanies this distribution.  The full text of the license may be found at

+http://opensource.org/licenses/bsd-license.php

+

+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 

 Module Name:

 

@@ -114,7 +114,6 @@ Returns:
           );

 }

 

-#if (EFI_SPECIFICATION_VERSION >= 0x00020000)

 EFI_STATUS

 EFIAPI

 RuntimeServiceQueryVariableInfo (

@@ -142,7 +141,6 @@ Returns:
           mVariableModuleGlobal->FvbInstance

           );

 }

-#endif

 

 VOID

 EFIAPI

@@ -196,9 +194,7 @@ Returns:
   SystemTable->RuntimeServices->GetVariable         = RuntimeServiceGetVariable;

   SystemTable->RuntimeServices->GetNextVariableName = RuntimeServiceGetNextVariableName;

   SystemTable->RuntimeServices->SetVariable         = RuntimeServiceSetVariable;

-#if (EFI_SPECIFICATION_VERSION >= 0x00020000)

   SystemTable->RuntimeServices->QueryVariableInfo   = RuntimeServiceQueryVariableInfo;

-#endif

 

   //

   // Now install the Variable Runtime Architectural Protocol on a new handle

diff --git a/EdkModulePkg/Universal/Variable/RuntimeDxe/Ipf/InitVariable.c b/EdkModulePkg/Universal/Variable/RuntimeDxe/Ipf/InitVariable.c
index bc74a67121..a7cb5f68c9 100644
--- a/EdkModulePkg/Universal/Variable/RuntimeDxe/Ipf/InitVariable.c
+++ b/EdkModulePkg/Universal/Variable/RuntimeDxe/Ipf/InitVariable.c
@@ -1,13 +1,13 @@
 /*++

 

-Copyright (c) 2006 - 2007, Intel Corporation                                                         

-All rights reserved. This program and the accompanying materials                          

-are licensed and made available under the terms and conditions of the BSD License         

-which accompanies this distribution.  The full text of the license may be found at        

-http://opensource.org/licenses/bsd-license.php                                            

-                                                                                          

-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

+Copyright (c) 2006 - 2007, Intel Corporation

+All rights reserved. This program and the accompanying materials

+are licensed and made available under the terms and conditions of the BSD License

+which accompanies this distribution.  The full text of the license may be found at

+http://opensource.org/licenses/bsd-license.php

+

+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 

 Module Name:

 

@@ -89,7 +89,6 @@ Returns:
                         );

     return ReturnVal;

 

-#if (EFI_SPECIFICATION_VERSION >= 0x00020000)

   case EsalQueryVariableInfo:

     ReturnVal.Status = QueryVariableInfo (

                         (UINT32) Arg2,

@@ -100,7 +99,6 @@ Returns:
                         Global->FvbInstance

                         );

     return ReturnVal;

-#endif

 

   default:

     ReturnVal.Status = EFI_SAL_INVALID_ARGUMENT;

@@ -173,10 +171,8 @@ Returns:
     EsalGetNextVariableName,

     EsalVariableCommonEntry,

     EsalSetVariable,

-#if (EFI_SPECIFICATION_VERSION >= 0x00020000)

     EsalVariableCommonEntry,

     EsalQueryVariableInfo,

-#endif

     NULL

     );

 

diff --git a/EdkModulePkg/Universal/Variable/RuntimeDxe/Variable.c b/EdkModulePkg/Universal/Variable/RuntimeDxe/Variable.c
index a9dff65494..98137c6a3f 100644
--- a/EdkModulePkg/Universal/Variable/RuntimeDxe/Variable.c
+++ b/EdkModulePkg/Universal/Variable/RuntimeDxe/Variable.c
@@ -1,13 +1,13 @@
 /*++

 

-Copyright (c) 2006 - 2007, Intel Corporation                                                         

-All rights reserved. This program and the accompanying materials                          

-are licensed and made available under the terms and conditions of the BSD License         

-which accompanies this distribution.  The full text of the license may be found at        

-http://opensource.org/licenses/bsd-license.php                                            

-                                                                                          

-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

+Copyright (c) 2006 - 2007, Intel Corporation

+All rights reserved. This program and the accompanying materials

+are licensed and made available under the terms and conditions of the BSD License

+which accompanies this distribution.  The full text of the license may be found at

+http://opensource.org/licenses/bsd-license.php

+

+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 

 Module Name:

 

@@ -28,7 +28,7 @@ Revision History
 ESAL_VARIABLE_GLOBAL  *mVariableModuleGlobal;

 

 //

-// This is a temperary function which will be removed 

+// This is a temperary function which will be removed

 // when EfiAcquireLock in UefiLib can handle the

 // the call in UEFI Runtimer driver in RT phase.

 //

@@ -44,7 +44,7 @@ AcquireLockOnlyAtBootTime (
 }

 

 //

-// This is a temperary function which will be removed 

+// This is a temperary function which will be removed

 // when EfiAcquireLock in UefiLib can handle the

 // the call in UEFI Runtimer driver in RT phase.

 //

@@ -260,7 +260,7 @@ Returns:
 

   EfiRaw        Variable store status is raw

   EfiValid      Variable store status is valid

-  EfiInvalid    Variable store status is invalid  

+  EfiInvalid    Variable store status is invalid

 

 --*/

 {

@@ -833,8 +833,8 @@ Returns:
     goto Done;

   } else if (!EFI_ERROR (Status) && Variable.Volatile && EfiAtRuntime()) {

     //

-    // If EfiAtRuntime and the variable is Volatile and Runtime Access,  

-    // the volatile is ReadOnly, and SetVariable should be aborted and 

+    // If EfiAtRuntime and the variable is Volatile and Runtime Access,

+    // the volatile is ReadOnly, and SetVariable should be aborted and

     // return EFI_WRITE_PROTECTED.

     //

     Status = EFI_WRITE_PROTECTED;

@@ -848,11 +848,11 @@ Returns:
     goto Done;

   } else if (Attributes == EFI_VARIABLE_NON_VOLATILE) {

     //

-    //  Make sure not only EFI_VARIABLE_NON_VOLATILE is set 

+    //  Make sure not only EFI_VARIABLE_NON_VOLATILE is set

     //

     Status = EFI_INVALID_PARAMETER;

     goto Done;

-  } else if ((Attributes & (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)) == 

+  } else if ((Attributes & (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)) ==

                 EFI_VARIABLE_RUNTIME_ACCESS) {

     //

     //  Make sure if runtime bit is set, boot service bit is set also

@@ -998,7 +998,7 @@ Returns:
           Status = EFI_OUT_OF_RESOURCES;

           goto Done;

         }

-        

+

         Reclaimed = TRUE;

       }

       //

@@ -1084,7 +1084,7 @@ Returns:
           Status = EFI_OUT_OF_RESOURCES;

           goto Done;

         }

-        

+

         Reclaimed = TRUE;

       }

 

@@ -1134,7 +1134,6 @@ Done:
   return Status;

 }

 

-#if (EFI_SPECIFICATION_VERSION >= 0x00020000)

 EFI_STATUS

 EFIAPI

 QueryVariableInfo (

@@ -1153,11 +1152,11 @@ Routine Description:
 

 Arguments:

 

-  Attributes                      Attributes bitmask to specify the type of variables 

+  Attributes                      Attributes bitmask to specify the type of variables

                                   on which to return information.

   MaximumVariableStorageSize      Pointer to the maximum size of the storage space available

                                   for the EFI variables associated with the attributes specified.

-  RemainingVariableStorageSize    Pointer to the remaining size of the storage space available 

+  RemainingVariableStorageSize    Pointer to the remaining size of the storage space available

                                   for the EFI variables associated with the attributes specified.

   MaximumVariableSize             Pointer to the maximum size of the individual EFI variables

                                   associated with the attributes specified.

@@ -1200,12 +1199,12 @@ Returns:
   }

 

   AcquireLockOnlyAtBootTime(&Global->VariableServicesLock);

-  

+

   if((Attributes & EFI_VARIABLE_NON_VOLATILE) == 0) {

     //

     // Query is Volatile related.

     //

-    VariableStoreHeader = (VARIABLE_STORE_HEADER *) ((UINTN) Global->VolatileVariableBase);    

+    VariableStoreHeader = (VARIABLE_STORE_HEADER *) ((UINTN) Global->VolatileVariableBase);

   } else {

     //

     // Query is Non-Volatile related.

@@ -1214,7 +1213,7 @@ Returns:
   }

 

   //

-  // Now let's fill *MaximumVariableStorageSize *RemainingVariableStorageSize 

+  // Now let's fill *MaximumVariableStorageSize *RemainingVariableStorageSize

   // with the storage size (excluding the storage header size).

   //

   *MaximumVariableStorageSize   = VariableStoreHeader->Size - sizeof (VARIABLE_STORE_HEADER);

@@ -1239,15 +1238,15 @@ Returns:
 

     if (EfiAtRuntime ()) {

       //

-      // we don't take the state of the variables in mind 

+      // we don't take the state of the variables in mind

       // when calculating RemainingVariableStorageSize,

-      // since the space occupied by variables not marked with 

+      // since the space occupied by variables not marked with

       // VAR_ADDED is not allowed to be reclaimed in Runtime.

       //

       *RemainingVariableStorageSize -= VariableSize;

     } else {

       //

-      // Only care about Variables with State VAR_ADDED,because 

+      // Only care about Variables with State VAR_ADDED,because

       // the space not marked as VAR_ADDED is reclaimable now.

       //

       if (Variable->State == VAR_ADDED) {

@@ -1264,7 +1263,6 @@ Returns:
   ReleaseLockOnlyAtBootTime (&Global->VariableServicesLock);

   return EFI_SUCCESS;

 }

-#endif

 

 EFI_STATUS

 EFIAPI

@@ -1283,9 +1281,9 @@ Arguments:
   SystemTable   - A pointer to the EFI System Table.

 

 Returns:

-  

+

   Status code.

-  

+

   EFI_NOT_FOUND     - Variable store area not found.

   EFI_UNSUPPORTED   - Currently only one non-volatile variable store is supported.

   EFI_SUCCESS       - Variable services successfully initialized.

@@ -1321,7 +1319,7 @@ Returns:
   }

 

   EfiInitializeLock(&mVariableModuleGlobal->VariableGlobal[Physical].VariableServicesLock, EFI_TPL_NOTIFY);

-  

+

   //

   // Allocate memory for volatile variable store

   //

diff --git a/EdkModulePkg/Universal/Variable/RuntimeDxe/Variable.h b/EdkModulePkg/Universal/Variable/RuntimeDxe/Variable.h
index 790b3dc50a..bb781b4c5b 100644
--- a/EdkModulePkg/Universal/Variable/RuntimeDxe/Variable.h
+++ b/EdkModulePkg/Universal/Variable/RuntimeDxe/Variable.h
@@ -1,18 +1,18 @@
 /*++

 

-Copyright (c) 2006 - 2007, Intel Corporation                                                         

-All rights reserved. This program and the accompanying materials                          

-are licensed and made available under the terms and conditions of the BSD License         

-which accompanies this distribution.  The full text of the license may be found at        

-http://opensource.org/licenses/bsd-license.php                                            

-                                                                                          

-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

+Copyright (c) 2006 - 2007, Intel Corporation

+All rights reserved. This program and the accompanying materials

+are licensed and made available under the terms and conditions of the BSD License

+which accompanies this distribution.  The full text of the license may be found at

+http://opensource.org/licenses/bsd-license.php

+

+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 

 Module Name:

 

   Variable.h

-  

+

 Abstract:

 

 --*/

@@ -26,7 +26,7 @@ Abstract:
 

 //

 // BugBug: We need relcate the head file.

-// 

+//

 #include <Common/Variable.h>

 

 #if defined (MDE_CPU_IPF)

@@ -144,7 +144,6 @@ SetVariable (
   )

 ;

 

-#if (EFI_SPECIFICATION_VERSION >= 0x00020000)

 EFI_STATUS

 EFIAPI

 QueryVariableInfo (

@@ -156,6 +155,5 @@ QueryVariableInfo (
   IN  UINT32                 Instance

   )

 ;

-#endif

 

 #endif