code clean up for Security.h.

[mirror_edk2.git] / IntelFrameworkPkg / Include / Ppi / Security.h

diff --git a/IntelFrameworkPkg/Include/Ppi/Security.h b/IntelFrameworkPkg/Include/Ppi/Security.h
index 4656e577743d437a81cb2dee9f7c183df1d47967..48a99a84cc7e8244bfa332b55d435794f8c4bdb7 100644 (file)
--- a/IntelFrameworkPkg/Include/Ppi/Security.h
+++ b/IntelFrameworkPkg/Include/Ppi/Security.h
@@ -1,6 +1,10 @@
 /** @file\r
   This file declares Security Architectural PPI.\r
-\r
+  \r
+  This PPI is installed by some platform PEIM that abstracts the security policy to the PEI\r
+  Foundation, namely the case of a PEIM's authentication state being returned during the PEI section\r
+  extraction process.\r
+  \r
   Copyright (c) 2006, Intel Corporation\r
   All rights reserved. This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
@@ -34,38 +38,28 @@ typedef struct _EFI_PEI_SECURITY_PPI  EFI_PEI_SECURITY_PPI;
   Allows the platform builder to implement a security policy in response\r
   to varying file authentication states.\r
 \r
-  @param  PeiServices    Pointer to the PEI Services Table.\r
-  @param  This           Interface pointer that implements the particular EFI_PEI_SECURITY_PPI instance.\r
-  @param  AuthenticationStatus\r
-                         Status returned by the verification service as part of section extraction.\r
-  @param  FfsFileHeader  Pointer to the file under review.\r
-  @param  DeferExecution Pointer to a variable that alerts the PEI Foundation to defer execution of a PEIM.\r
-\r
-  @retval EFI_SUCCESS           The service performed its action successfully.\r
-  @retval EFI_SECURITY_VIOLATION The object cannot be trusted\r
+  @param  PeiServices             Pointer to the PEI Services Table.\r
+  @param  This                    Interface pointer that implements the particular EFI_PEI_SECURITY_PPI instance.\r
+  @param  AuthenticationStatus    Status returned by the verification service as part of section extraction.\r
+  @param  FfsFileHeader           Pointer to the file under review.\r
+  @param  DeferExecution          Pointer to a variable that alerts the PEI Foundation to defer execution of a PEIM.\r
 \r
+  @retval EFI_SUCCESS             The service performed its action successfully.\r
+  @retval EFI_SECURITY_VIOLATION  The object cannot be trusted\r
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PEI_SECURITY_AUTHENTICATION_STATE) (\r
+(EFIAPI *EFI_PEI_SECURITY_AUTHENTICATION_STATE)(\r
   IN EFI_PEI_SERVICES             **PeiServices,\r
   IN EFI_PEI_SECURITY_PPI         *This,\r
   IN UINT32                       AuthenticationStatus,\r
   IN EFI_FFS_FILE_HEADER          *FfsFileHeader,\r
-  IN OUT BOOLEAN                  *StartCrisisRecovery\r
+  IN OUT BOOLEAN                  *DeferExecution\r
   );\r
 \r
-/**\r
-  @par Ppi Description:\r
-  This PPI is installed by some platform PEIM that abstracts the security\r
-  policy to the PEI Foundation, namely the case of a PEIM's authentication\r
-  state being returned during the PEI section extraction process.\r
-\r
-  @param AuthenticationState\r
-  Allows the platform builder to implement a security policy in response\r
-  to varying file authentication states.\r
-\r
-**/\r
+//\r
+// PPI interface structure of Security PPI\r
+//\r
 struct _EFI_PEI_SECURITY_PPI {\r
   EFI_PEI_SECURITY_AUTHENTICATION_STATE  AuthenticationState;\r
 };\r