Code Scrub for Protocol and Ppi Definition

[mirror_edk2.git] / MdePkg / Include / Protocol / Bis.h

diff --git a/MdePkg/Include/Protocol/Bis.h b/MdePkg/Include/Protocol/Bis.h
index aa4905b04e54775a6f61ef96c2d42386fd22dc6a..e01d049cbfaffe4208205c2d1576992867a2ea6f 100644 (file)
--- a/MdePkg/Include/Protocol/Bis.h
+++ b/MdePkg/Include/Protocol/Bis.h
@@ -1,7 +1,9 @@
 /** @file\r
-  This file defines the BIS protocol.\r
+  BIS protocol are defined in the UEFI specification.\r
+  The EFI_BIS_PROTOCOL is used to check a digital signature of a data block \r
+  against a digital certificate for the purpose of an integrity and authorization check.\r
 \r
-  Copyright (c) 2006, 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
@@ -397,6 +399,60 @@ EFI_STATUS
   OUT EFI_BIS_DATA            **SignatureInfo      \r
   );\r
 \r
+/**\r
+  @par Protocol Description:\r
+  The EFI_BIS_PROTOCOL is used to check a digital signature of a data block against a digital\r
+  certificate for the purpose of an integrity and authorization check.\r
+\r
+  @param initialize\r
+  Initializes an application instance of the EFI_BIS protocol,\r
+  returning a handle for the application instance. Other functions in\r
+  the EFI_BIS protocol require a valid application instance\r
+  handle obtained from this function.\r
+  \r
+  @param Shutdown \r
+  Ends the lifetime of an application instance of the EFI_BIS\r
+  protocol, invalidating its application instance handle. The\r
+  application instance handle may no longer be used in other\r
+  functions in the EFI_BIS protocol.\r
+\r
+  @param Free \r
+  Frees memory structures allocated and returned by other\r
+  functions in the EFI_BIS protocol. \r
+\r
+  @param GetBootObjectAuthorizationCertificate\r
+  Retrieves the current digital certificate (if any) used by the\r
+  EFI_BIS protocol as the source of authorization for verifying\r
+  boot objects and altering configuration parameters.\r
+\r
+  @param GetBootObjectAuthorizationCheckFlag\r
+  Retrieves the current setting of the authorization check flag that\r
+  indicates whether or not authorization checks are required for\r
+  boot objects.\r
+\r
+  @param GetBootObjectAuthorizationUpdateToken\r
+  Retrieves an uninterpreted token whose value gets included and\r
+  signed in a subsequent request to alter the configuration\r
+  parameters, to protect against attempts to replay such a request.\r
+\r
+  @param GetSignatureInfo \r
+  Retrieves information about the digital signature algorithms\r
+  supported and the identity of the installed authorization\r
+  certificate, if any.\r
+\r
+  @param UpdateBootObjectAuthorization\r
+  Requests that the configuration parameters be altered by\r
+  installing or removing an authorization certificate or changing the\r
+  setting of the check flag. \r
+\r
+  @param VerifyBootObject\r
+  Verifies a boot object according to the supplied digital signature\r
+  and the current authorization certificate and check flag setting.\r
+\r
+  @param VerifyObjectWithCredential\r
+  Verifies a data object according to a supplied digital signature\r
+  and a supplied digital certificate.  \r
+**/\r
 struct _EFI_BIS_PROTOCOL {\r
   EFI_BIS_INITIALIZE                                  Initialize;\r
   EFI_BIS_SHUTDOWN                                    Shutdown;\r