MdeModulePkg/Variable/RuntimeDxe: move MOR func. declarations to header

The MorLockInit() and SetVariableCheckHandlerMor() functions have separate
implementations for VariableRuntimeDxe (= unprivileged, unified
DXE_RUNTIME driver) and VariableSmm (= privileged, DXE_SMM back-end of the
split variable driver).

Move their declarations from "Variable.c" to "PrivilegePolymorphic.h", so
that the compiler enforce that the declarations and the definitions match.
(All C source files with the call sites and the function definitions
already include "PrivilegePolymorphic.h" via "Variable.h".)

At the same time:

- replace two typos in the MorLockInit() description:
  - replace "EFI_SUCEESS" with "EFI_SUCCESS",
  - replace "MOR Lock Control" with "MOR Control Lock";

- in the SetVariableCheckHandlerMor() description:
  - replace @param with @param[in],
  - correct the description of the Attributes parameter (suggested by Star
    Zeng <star.zeng@intel.com>),
  - rewrap the comment to 80 columns.

This change cleans up commit 2f6aa774fe38 ("MdeModulePkg: Add MorLock to
variable driver.", 2016-01-19).

Cc: Eric Dong <eric.dong@intel.com>
Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Ladi Prosek <lprosek@redhat.com>
Cc: Star Zeng <star.zeng@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
Reviewed-by: Jiewen Yao <jiewen.yao@intel.com>
Tested-by: Ladi Prosek <lprosek@redhat.com>

4 files changed, 70 insertions, 64 deletions

diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/PrivilegePolymorphic.h b/MdeModulePkg/Universal/Variable/RuntimeDxe/PrivilegePolymorphic.h
index 0aa0d4f48f..cf0d237195 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/PrivilegePolymorphic.h
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/PrivilegePolymorphic.h
@@ -35,4 +35,43 @@ SecureBootHook (
   IN EFI_GUID                               *VendorGuid

   );

 

+/**

+  Initialization for MOR Control Lock.

+

+  @retval EFI_SUCCESS     MorLock initialization success.

+  @return Others          Some error occurs.

+**/

+EFI_STATUS

+MorLockInit (

+  VOID

+  );

+

+/**

+  This service is an MOR/MorLock checker handler for the SetVariable().

+

+  @param[in]  VariableName the name of the vendor's variable, as a

+                           Null-Terminated Unicode String

+  @param[in]  VendorGuid   Unify identifier for vendor.

+  @param[in]  Attributes   Attributes bitmask to set for the variable.

+  @param[in]  DataSize     The size in bytes of Data-Buffer.

+  @param[in]  Data         Point to the content of the variable.

+

+  @retval  EFI_SUCCESS            The MOR/MorLock check pass, and Variable

+                                  driver can store the variable data.

+  @retval  EFI_INVALID_PARAMETER  The MOR/MorLock data or data size or

+                                  attributes is not allowed for MOR variable.

+  @retval  EFI_ACCESS_DENIED      The MOR/MorLock is locked.

+  @retval  EFI_ALREADY_STARTED    The MorLock variable is handled inside this

+                                  function. Variable driver can just return

+                                  EFI_SUCCESS.

+**/

+EFI_STATUS

+SetVariableCheckHandlerMor (

+  IN CHAR16     *VariableName,

+  IN EFI_GUID   *VendorGuid,

+  IN UINT32     Attributes,

+  IN UINTN      DataSize,

+  IN VOID       *Data

+  );

+

 #endif

diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/TcgMorLockDxe.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/TcgMorLockDxe.c
index c32eb3b1ac..dfdc1febc8 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/TcgMorLockDxe.c
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/TcgMorLockDxe.c
@@ -28,19 +28,21 @@ extern EDKII_VARIABLE_LOCK_PROTOCOL     mVariableLock;
 /**

   This service is an MOR/MorLock checker handler for the SetVariable().

 

-  @param  VariableName the name of the vendor's variable, as a

-                       Null-Terminated Unicode String

-  @param  VendorGuid   Unify identifier for vendor.

-  @param  Attributes   Point to memory location to return the attributes of variable. If the point

-                       is NULL, the parameter would be ignored.

-  @param  DataSize     The size in bytes of Data-Buffer.

-  @param  Data         Point to the content of the variable.

+  @param[in]  VariableName the name of the vendor's variable, as a

+                           Null-Terminated Unicode String

+  @param[in]  VendorGuid   Unify identifier for vendor.

+  @param[in]  Attributes   Attributes bitmask to set for the variable.

+  @param[in]  DataSize     The size in bytes of Data-Buffer.

+  @param[in]  Data         Point to the content of the variable.

 

-  @retval  EFI_SUCCESS            The MOR/MorLock check pass, and Variable driver can store the variable data.

-  @retval  EFI_INVALID_PARAMETER  The MOR/MorLock data or data size or attributes is not allowed for MOR variable.

+  @retval  EFI_SUCCESS            The MOR/MorLock check pass, and Variable

+                                  driver can store the variable data.

+  @retval  EFI_INVALID_PARAMETER  The MOR/MorLock data or data size or

+                                  attributes is not allowed for MOR variable.

   @retval  EFI_ACCESS_DENIED      The MOR/MorLock is locked.

-  @retval  EFI_ALREADY_STARTED    The MorLock variable is handled inside this function.

-                                  Variable driver can just return EFI_SUCCESS.

+  @retval  EFI_ALREADY_STARTED    The MorLock variable is handled inside this

+                                  function. Variable driver can just return

+                                  EFI_SUCCESS.

 **/

 EFI_STATUS

 SetVariableCheckHandlerMor (

@@ -58,9 +60,9 @@ SetVariableCheckHandlerMor (
 }

 

 /**

-  Initialization for MOR Lock Control.

+  Initialization for MOR Control Lock.

 

-  @retval EFI_SUCEESS     MorLock initialization success.

+  @retval EFI_SUCCESS     MorLock initialization success.

   @return Others          Some error occurs.

 **/

 EFI_STATUS

diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/TcgMorLockSmm.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/TcgMorLockSmm.c
index d06317ca9c..20ec98e8e8 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/TcgMorLockSmm.c
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/TcgMorLockSmm.c
@@ -309,19 +309,21 @@ SetVariableCheckHandlerMorLock (
 /**

   This service is an MOR/MorLock checker handler for the SetVariable().

 

-  @param  VariableName the name of the vendor's variable, as a

-                       Null-Terminated Unicode String

-  @param  VendorGuid   Unify identifier for vendor.

-  @param  Attributes   Point to memory location to return the attributes of variable. If the point

-                       is NULL, the parameter would be ignored.

-  @param  DataSize     The size in bytes of Data-Buffer.

-  @param  Data         Point to the content of the variable.

-

-  @retval  EFI_SUCCESS            The MOR/MorLock check pass, and Variable driver can store the variable data.

-  @retval  EFI_INVALID_PARAMETER  The MOR/MorLock data or data size or attributes is not allowed for MOR variable.

+  @param[in]  VariableName the name of the vendor's variable, as a

+                           Null-Terminated Unicode String

+  @param[in]  VendorGuid   Unify identifier for vendor.

+  @param[in]  Attributes   Attributes bitmask to set for the variable.

+  @param[in]  DataSize     The size in bytes of Data-Buffer.

+  @param[in]  Data         Point to the content of the variable.

+

+  @retval  EFI_SUCCESS            The MOR/MorLock check pass, and Variable

+                                  driver can store the variable data.

+  @retval  EFI_INVALID_PARAMETER  The MOR/MorLock data or data size or

+                                  attributes is not allowed for MOR variable.

   @retval  EFI_ACCESS_DENIED      The MOR/MorLock is locked.

-  @retval  EFI_ALREADY_STARTED    The MorLock variable is handled inside this function.

-                                  Variable driver can just return EFI_SUCCESS.

+  @retval  EFI_ALREADY_STARTED    The MorLock variable is handled inside this

+                                  function. Variable driver can just return

+                                  EFI_SUCCESS.

 **/

 EFI_STATUS

 SetVariableCheckHandlerMor (

@@ -377,9 +379,9 @@ SetVariableCheckHandlerMor (
 }

 

 /**

-  Initialization for MOR Lock Control.

+  Initialization for MOR Control Lock.

 

-  @retval EFI_SUCEESS     MorLock initialization success.

+  @retval EFI_SUCCESS     MorLock initialization success.

   @return Others          Some error occurs.

 **/

 EFI_STATUS

diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
index 28e4ac8f38..d68dfbe648 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
@@ -98,43 +98,6 @@ AUTH_VAR_LIB_CONTEXT_IN mAuthContextIn = {
 AUTH_VAR_LIB_CONTEXT_OUT mAuthContextOut;

 

 /**

-  Initialization for MOR Lock Control.

-

-  @retval EFI_SUCEESS     MorLock initialization success.

-  @return Others          Some error occurs.

-**/

-EFI_STATUS

-MorLockInit (

-  VOID

-  );

-

-/**

-  This service is an MOR/MorLock checker handler for the SetVariable().

-

-  @param  VariableName the name of the vendor's variable, as a

-                       Null-Terminated Unicode String

-  @param  VendorGuid   Unify identifier for vendor.

-  @param  Attributes   Point to memory location to return the attributes of variable. If the point

-                       is NULL, the parameter would be ignored.

-  @param  DataSize     The size in bytes of Data-Buffer.

-  @param  Data         Point to the content of the variable.

-

-  @retval  EFI_SUCCESS            The MOR/MorLock check pass, and Variable driver can store the variable data.

-  @retval  EFI_INVALID_PARAMETER  The MOR/MorLock data or data size or attributes is not allowed for MOR variable.

-  @retval  EFI_ACCESS_DENIED      The MOR/MorLock is locked.

-  @retval  EFI_ALREADY_STARTED    The MorLock variable is handled inside this function.

-                                  Variable driver can just return EFI_SUCCESS.

-**/

-EFI_STATUS

-SetVariableCheckHandlerMor (

-  IN CHAR16     *VariableName,

-  IN EFI_GUID   *VendorGuid,

-  IN UINT32     Attributes,

-  IN UINTN      DataSize,

-  IN VOID       *Data

-  );

-

-/**

   Routine used to track statistical information about variable usage.

   The data is stored in the EFI system table so it can be accessed later.

   VariableInfo.efi can dump out the table. Only Boot Services variable