code clean up for Security.h.
authorrsun3 <rsun3@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 2 Jul 2009 05:58:27 +0000 (05:58 +0000)
committerrsun3 <rsun3@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 2 Jul 2009 05:58:27 +0000 (05:58 +0000)
1. Incorrect comment style preceding _EFI_PEI_SECURITY_PPI.  The comments in the file have the format used to describe a function, and should have the format for a structure.
2.  Latest PEI CIS (0.91) indicates the param should be:
IN OUT BOOLEAN     *DeferExecution
whereas in the H file it's:
IN OUT BOOLEAN     *StartCrisisRecovery

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

IntelFrameworkPkg/Include/Ppi/Security.h

index 44b48d6058b71ec8d64c8aa9cf4f975aa424a1f5..48a99a84cc7e8244bfa332b55d435794f8c4bdb7 100644 (file)
@@ -38,16 +38,14 @@ 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
-\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
@@ -56,20 +54,12 @@ EFI_STATUS
   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