ECC clanup: Update the doxygen comment.

[mirror_edk2.git] / MdeModulePkg / Core / Pei / Security / Security.c

diff --git a/MdeModulePkg/Core/Pei/Security/Security.c b/MdeModulePkg/Core/Pei/Security/Security.c
index 7460707a274f164589a5befc2b744856f6703984..27c4f52f1b153b7be20532fa03314a300c517a6c 100644 (file)
--- a/MdeModulePkg/Core/Pei/Security/Security.c
+++ b/MdeModulePkg/Core/Pei/Security/Security.c
@@ -12,7 +12,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 **/\r
 \r
-#include <PeiMain.h>\r
+#include "PeiMain.h"\r
 \r
 /**\r
 \r
@@ -33,7 +33,7 @@ SecurityPpiNotifyCallback (
   IN VOID                       *Ppi\r
   );\r
 \r
-STATIC EFI_PEI_NOTIFY_DESCRIPTOR mNotifyList = {\r
+EFI_PEI_NOTIFY_DESCRIPTOR mNotifyList = {\r
    EFI_PEI_PPI_DESCRIPTOR_NOTIFY_DISPATCH | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST,\r
    &gEfiPeiSecurity2PpiGuid,\r
    SecurityPpiNotifyCallback\r
@@ -62,7 +62,8 @@ InitializeSecurityServices (
 /**\r
 \r
   Provide a callback for when the security PPI is installed.\r
-\r
+  This routine will cache installed security PPI into PeiCore's private data.\r
+  \r
   @param PeiServices        An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
   @param NotifyDescriptor   The descriptor for the notification event.\r
   @param Ppi                Pointer to the PPI in question.\r
@@ -105,7 +106,7 @@ SecurityPpiNotifyCallback (
 \r
   @retval EFI_SUCCESS              Image is OK\r
   @retval EFI_SECURITY_VIOLATION   Image is illegal\r
-\r
+  @retval EFI_NOT_FOUND            If security PPI is not installed.\r
 **/\r
 EFI_STATUS\r
 VerifyPeim (\r
@@ -148,10 +149,9 @@ VerifyPeim (
 /**\r
   Verify a Firmware volume.\r
 \r
-  @param CurrentFvAddress - Pointer to the current Firmware Volume under consideration\r
+  @param CurrentFvAddress   Pointer to the current Firmware Volume under consideration\r
 \r
-  @retval EFI_SUCCESS              Firmware Volume is legal\r
-  @retval EFI_SECURITY_VIOLATION   Firmware Volume fails integrity test\r
+  @retval EFI_SUCCESS       Firmware Volume is legal\r
 \r
 **/\r
 EFI_STATUS\r