]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/Bis.h
add a error macro to prevent this file from included for now #error "UEFI 2.1 HII...
[mirror_edk2.git] / MdePkg / Include / Protocol / Bis.h
index ffc66f622aad9af1ad9848e69eef4a07d46425fa..745f8fac3c776c0f857560ce4c8551a89e4a96b1 100644 (file)
@@ -10,8 +10,6 @@
   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
 \r
-  Module Name:  Bis.h\r
-\r
 **/\r
 \r
 #ifndef __BIS_H__\r
@@ -136,7 +134,7 @@ typedef struct {
                                    version numbers are updated with the major and minor version\r
                                    numbers of the interface                                    \r
   @param  TargetAddress            Indicates a network or device address of the BIS platform to connect to.                                                                 \r
-  \r
+\r
   @retval EFI_SUCCESS              The function completed successfully.\r
   @retval EFI_INCOMPATIBLE_VERSION The InterfaceVersion.Major requested by the                \r
                                    caller was not compatible with the interface version of the\r
@@ -161,10 +159,10 @@ EFI_STATUS
 /**                                                                 \r
   Frees memory structures allocated and returned by other functions in the EFI_BIS protocol.  \r
       \r
-  @param  AppHandle                An opaque handle that identifies the caller¡¯s instance of initialization\r
+  @param  AppHandle                An opaque handle that identifies the caller's instance of initialization\r
                                    of the BIS service.                                                                                         \r
   @param  ToFree                   An EFI_BIS_DATA* and associated memory block to be freed.\r
-  \r
+\r
   @retval EFI_SUCCESS              The function completed successfully.\r
   @retval EFI_NO_MAPPING           The AppHandle parameter is not or is no longer a valid\r
                                    application instance handle associated with the EFI_BIS protocol.                                     \r
@@ -181,12 +179,12 @@ EFI_STATUS
   );\r
 \r
 /**                                                                 \r
-  Shuts down an application¡¯s instance of the BIS service, invalidating the application handle. After\r
+  Shuts down an application's instance of the BIS service, invalidating the application handle. After\r
   this call, other BIS functions may no longer be invoked using the application handle value.         \r
       \r
-  @param  AppHandle                An opaque handle that identifies the caller¡¯s instance of initialization\r
+  @param  AppHandle                An opaque handle that identifies the caller's instance of initialization\r
                                    of the BIS service.                                                                                           \r
-  \r
+\r
   @retval EFI_SUCCESS              The function completed successfully.\r
   @retval EFI_NO_MAPPING           The AppHandle parameter is not or is no longer a valid\r
                                    application instance handle associated with the EFI_BIS protocol.                                     \r
@@ -204,11 +202,11 @@ EFI_STATUS
   Retrieves the certificate that has been configured as the identity of the organization designated as\r
   the source of authorization for signatures of boot objects.\r
       \r
-  @param  AppHandle                An opaque handle that identifies the caller¡¯s instance of initialization\r
+  @param  AppHandle                An opaque handle that identifies the caller's instance of initialization\r
                                    of the BIS service.                                                                                           \r
   @param  Certificate              The function writes an allocated EFI_BIS_DATA* containing the Boot\r
                                    Object Authorization Certificate object.                            \r
-  \r
+\r
   @retval EFI_SUCCESS              The function completed successfully.\r
   @retval EFI_NO_MAPPING           The AppHandle parameter is not or is no longer a valid\r
                                    application instance handle associated with the EFI_BIS protocol.                                     \r
@@ -229,7 +227,7 @@ EFI_STATUS
   Verifies the integrity and authorization of the indicated data object according to the\r
   indicated credentials.                                                                \r
       \r
-  @param  AppHandle                An opaque handle that identifies the caller¡¯s instance of initialization\r
+  @param  AppHandle                An opaque handle that identifies the caller's instance of initialization\r
                                    of the BIS service.                                                                                           \r
   @param  Credentials              A Signed Manifest containing verification information for the indicated\r
                                    data object.                                                            \r
@@ -259,7 +257,7 @@ EFI_STATUS
 /**                                                                 \r
   Retrieves the current status of the Boot Authorization Check Flag.\r
       \r
-  @param  AppHandle                An opaque handle that identifies the caller¡¯s instance of initialization\r
+  @param  AppHandle                An opaque handle that identifies the caller's instance of initialization\r
                                    of the BIS service.                                                                                           \r
   @param  CheckIsRequired          The function writes the value TRUE if a Boot Authorization Check is\r
                                    currently required on this platform, otherwise the function writes \r
@@ -284,7 +282,7 @@ EFI_STATUS
   Retrieves a unique token value to be included in the request credential for the next update of any\r
   parameter in the Boot Object Authorization set                                                    \r
       \r
-  @param  AppHandle                An opaque handle that identifies the caller¡¯s instance of initialization\r
+  @param  AppHandle                An opaque handle that identifies the caller's instance of initialization\r
                                    of the BIS service.                                                                                           \r
   @param  UpdateToken              The function writes an allocated EFI_BIS_DATA* containing the new\r
                                    unique update token value.                                                                          \r
@@ -308,7 +306,7 @@ EFI_STATUS
 /**                                                                 \r
   Updates one of the configurable parameters of the Boot Object Authorization set.\r
       \r
-  @param  AppHandle                An opaque handle that identifies the caller¡¯s instance of initialization\r
+  @param  AppHandle                An opaque handle that identifies the caller's instance of initialization\r
                                    of the BIS service.                                                                                           \r
   @param  RequestCredential        This is a Signed Manifest with embedded attributes that carry the details\r
                                    of the requested update.                                                 \r
@@ -337,7 +335,7 @@ EFI_STATUS
   Verifies the integrity and authorization of the indicated data object according to the indicated\r
   credentials and authority certificate.                                                          \r
       \r
-  @param  AppHandle                An opaque handle that identifies the caller¡¯s instance of initialization\r
+  @param  AppHandle                An opaque handle that identifies the caller's instance of initialization\r
                                    of the BIS service.                                                                                           \r
   @param  Credentials              A Signed Manifest containing verification information for the\r
                                    indicated data object.                                       \r
@@ -345,7 +343,7 @@ EFI_STATUS
   @param  SectionName              An ASCII (not Unicode) string giving the section name in the  \r
                                    manifest holding the verification information (in other words,\r
                                    hash value) that corresponds to DataObject.                             \r
-  @param  AuthorityCertificate     A digital certificate whose public key must match the signer¡¯s                              \r
+  @param  AuthorityCertificate     A digital certificate whose public key must match the signer's                              \r
                                    public key which is found in the credentials.                  \r
   @param  IsVerified               The function writes TRUE if the verification was successful.\r
                                    Otherwise, the function writes FALSE.                       \r
@@ -377,7 +375,7 @@ EFI_STATUS
   Retrieves a list of digital certificate identifier, digital signature algorithm, hash algorithm, and keylength\r
   combinations that the platform supports.                                                                      \r
       \r
-  @param  AppHandle                An opaque handle that identifies the caller¡¯s instance of initialization\r
+  @param  AppHandle                An opaque handle that identifies the caller's instance of initialization\r
                                    of the BIS service.                                                                                           \r
   @param  SignatureInfo            The function writes an allocated EFI_BIS_DATA* containing the array\r
                                    of EFI_BIS_SIGNATURE_INFO structures representing the supported    \r