Code scrub for the Capsule, SecurityStub, and Crc32 library instance.

[mirror_edk2.git] / MdeModulePkg / Universal / SecurityStubDxe / SecurityStub.c

diff --git a/MdeModulePkg/Universal/SecurityStubDxe/SecurityStub.c b/MdeModulePkg/Universal/SecurityStubDxe/SecurityStub.c
index 2eb325ec56148fc124c0d944148a1701ba2f839c..f60c98ca433a00ba6bfaf556c19ed6f8f1853062 100644 (file)
--- a/MdeModulePkg/Universal/SecurityStubDxe/SecurityStub.c
+++ b/MdeModulePkg/Universal/SecurityStubDxe/SecurityStub.c
@@ -1,7 +1,8 @@
 /** @file\r
-  This driver supports platform security service.\r
+  This driver implements one sample platform security service, which does \r
+  nothing and always return EFI_SUCCESS.\r
   \r
-  Copyright (c) 2006 - 2007, Intel Corporation                                              \r
+  Copyright (c) 2006 - 2008, 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
   which accompanies this distribution.  The full text of the license may be found at        \r
@@ -60,18 +61,8 @@ EFI_SECURITY_ARCH_PROTOCOL  mSecurityStub = {
   @param  File             This is a pointer to the device path of the file that is\r
                            being dispatched. This will optionally be used for logging.\r
 \r
-  @retval EFI_SUCCESS           The file specified by File did authenticate, and the\r
-                                platform policy dictates that the DXE Core may use File.\r
-  @retval EFI_INVALID_PARAMETER Driver is NULL.\r
-  @retval EFI_SECURITY_VIOLATION The file specified by File did not authenticate, and\r
-                                the platform policy dictates that File should be placed\r
-                                in the untrusted state. A file may be promoted from\r
-                                the untrusted to the trusted state at a future time\r
-                                with a call to the Trust() DXE Service.\r
-  @retval EFI_ACCESS_DENIED     The file specified by File did not authenticate, and\r
-                                the platform policy dictates that File should not be\r
-                                used for any purpose.\r
-\r
+  @retval EFI_SUCCESS            Do nothing and return.\r
+  @retval EFI_INVALID_PARAMETER  File is NULL.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -90,15 +81,14 @@ SecurityStubAuthenticateState (
 \r
 \r
 /**\r
-  The user Entry Point for DXE driver. The user code starts with this function\r
+  The user Entry Point installs SAP. The user code starts with this function\r
   as the real entry point for the image goes into a library that calls this \r
   function.\r
 \r
-  @param[in] ImageHandle    The firmware allocated handle for the EFI image.  \r
-  @param[in] SystemTable    A pointer to the EFI System Table.\r
+  @param ImageHandle    The firmware allocated handle for the EFI image.  \r
+  @param SystemTable    A pointer to the EFI System Table.\r
   \r
-  @retval EFI_SUCCESS       The entry point is executed successfully.\r
-  @retval other             Some error occurs when executing this entry point.\r
+  @retval EFI_SUCCESS   Install the sample Security Architectural Protocol successfully.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -126,5 +116,5 @@ SecurityStubInitialize (
                   );\r
   ASSERT_EFI_ERROR (Status);\r
 \r
-  return Status;\r
+  return EFI_SUCCESS;\r
 }\r