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

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

diff --git a/MdeModulePkg/Universal/SecurityStubDxe/SecurityStub.h b/MdeModulePkg/Universal/SecurityStubDxe/SecurityStub.h
index dedc14afdbe1e22ff4d3c47f982288cbcfeb4086..574957101d3cf3db1768a30258a723915759fbd0 100644 (file)
--- a/MdeModulePkg/Universal/SecurityStubDxe/SecurityStub.h
+++ b/MdeModulePkg/Universal/SecurityStubDxe/SecurityStub.h
@@ -1,7 +1,7 @@
 /** @file\r
-  Some definitions for Security Architectural Protocol stub driver\r
+  Inlcude the required definitions for Security Architectural Protocol stub driver\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
@@ -12,8 +12,8 @@
 \r
 **/\r
 \r
-#ifndef _SECURITY_STUB_ARCH_PROTOCOL_H\r
-#define _SECURITY_STUB_ARCH_PROTOCOL_H\r
+#ifndef __SECURITY_STUB_ARCH_PROTOCOL_H__\r
+#define __SECURITY_STUB_ARCH_PROTOCOL_H__\r
 \r
 \r
 //\r
@@ -28,6 +28,41 @@
 //\r
 // Function prototypes\r
 //\r
+/**\r
+  The EFI_SECURITY_ARCH_PROTOCOL (SAP) is used to abstract platform-specific \r
+  policy from the DXE core response to an attempt to use a file that returns a \r
+  given status for the authentication check from the section extraction protocol.  \r
+\r
+  The possible responses in a given SAP implementation may include locking \r
+  flash upon failure to authenticate, attestation logging for all signed drivers, \r
+  and other exception operations.  The File parameter allows for possible logging \r
+  within the SAP of the driver.\r
+\r
+  If File is NULL, then EFI_INVALID_PARAMETER is returned.\r
+\r
+  If the file specified by File with an authentication status specified by \r
+  AuthenticationStatus is safe for the DXE Core to use, then EFI_SUCCESS is returned.\r
+\r
+  If the file specified by File with an authentication status specified by \r
+  AuthenticationStatus is not safe for the DXE Core to use under any circumstances, \r
+  then EFI_ACCESS_DENIED is returned.\r
+\r
+  If the file specified by File with an authentication status specified by \r
+  AuthenticationStatus is not safe for the DXE Core to use right now, but it \r
+  might be possible to use it at a future time, then EFI_SECURITY_VIOLATION is \r
+  returned.\r
+\r
+  @param  This             The EFI_SECURITY_ARCH_PROTOCOL instance.\r
+  @param  AuthenticationStatus \r
+                           This is the authentication type returned from the Section\r
+                           Extraction protocol. See the Section Extraction Protocol\r
+                           Specification for details on this type.\r
+  @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            Do nothing and return.\r
+  @retval EFI_INVALID_PARAMETER  File is NULL.\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 SecurityStubAuthenticateState (\r
@@ -36,6 +71,17 @@ SecurityStubAuthenticateState (
   IN  EFI_DEVICE_PATH_PROTOCOL           *File\r
   );\r
 \r
+/**\r
+  The user Entry Point for DXE driver. 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 ImageHandle    The firmware allocated handle for the EFI image.  \r
+  @param SystemTable    A pointer to the EFI System Table.\r
+  \r
+  @retval EFI_SUCCESS   Install the sample Security Architectural Protocol successfully.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 SecurityStubInitialize (\r