]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/Bis.h
Clarify the UEFI/EFI specification version in file header comments.
[mirror_edk2.git] / MdePkg / Include / Protocol / Bis.h
index 194a0b526c1599a95734f75838a081ce288ddb11..edb22f85466154aaddc77233aaf80b6a3c08385e 100644 (file)
@@ -1,16 +1,18 @@
 /** @file\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 - 2008, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2009, 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
   http://opensource.org/licenses/bsd-license.php                                            \r
 \r
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.        \r
+\r
+  @par Revision Reference:          \r
+  This Protocol is introduced in EFI Specification 1.10     \r
 \r
 **/\r
 \r
@@ -115,7 +117,7 @@ typedef struct {
 #define BIS_GET_SIGINFO_ARRAY(BisDataPtr) ((EFI_BIS_SIGNATURE_INFO *) (BisDataPtr)->Data)\r
 \r
 ///\r
-/// Support old name for backward compatible\r
+/// Support old name for backward compatibility\r
 ///\r
 #define BOOT_OBJECT_AUTHORIZATION_PARMSET_GUIDVALUE \\r
         BOOT_OBJECT_AUTHORIZATION_PARMSET_GUID\r
@@ -146,11 +148,11 @@ typedef struct {
                                    TargetAddress.Data was any other value that was not\r
                                    supported by the implementation.                   \r
   @retval EFI_OUT_OF_RESOURCES     The function failed due to lack of memory or other resources.                              \r
-  @retval EFI_DEVICE_ERROR         The function encountered an unexpected internal failure while\r
-                                   initializing a cryptographic software module, or\r
-                                   No cryptographic software module with compatible version was\r
-                                   found, or A resource limitation was encountered while using a\r
-                                   cryptographic software module.\r
+  @retval EFI_DEVICE_ERROR         One of the following device errors:\r
+                                   * The function encountered an unexpected internal failure while initializing a cryptographic software module\r
+                                   * No cryptographic software module with compatible version was found\r
+                                   found\r
+                                   * A resource limitation was encountered while using a cryptographic software module.\r
   @retval EFI_INVALID_PARAMETER    The This parameter supplied by the caller is NULL or does not\r
                                    reference a valid EFI_BIS_PROTOCOL object, or\r
                                    The AppHandle parameter supplied by the caller is NULL or\r
@@ -380,7 +382,7 @@ EFI_STATUS
                                    invalid (could not be parsed),                      \r
                                    or Platform-specific authorization failed, etc.   \r
   @retval EFI_DEVICE_ERROR         An unexpected internal error occurred while attempting to retrieve\r
-                                   the public key algorithm of the manifest¡¯s signer¡¯s certificate,\r
+                                   the public key algorithm of the manifest's signer's certificate,\r
                                    or An unexpected internal error occurred in a cryptographic software module.                                                                                                                                                                  \r
 **/ \r
 typedef\r