]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/Hash.h
clean up the un-suitable ';' location when declaring the functions.
[mirror_edk2.git] / MdePkg / Include / Protocol / Hash.h
index 7007c78142c3e8cd9b0d7e71898cc280b794834e..bb4d6515816927ef71fcdde6d609230da90ca886 100644 (file)
@@ -6,7 +6,7 @@
   so that a multiple drivers can use the underlying hashing services.\r
   The EFI Service Binding Protocol defines the generic Service Binding Protocol functions.\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
@@ -15,8 +15,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:  Hash.h\r
-\r
 **/\r
 \r
 #ifndef __EFI_HASH_PROTOCOL_H__\r
@@ -85,7 +83,7 @@ typedef union {
 \r
   @param  This                  Points to this instance of EFI_HASH_PROTOCOL.\r
   @param  HashAlgorithm         Points to the EFI_GUID which identifies the algorithm to use.\r
-  @param  HashSize              Holds the returned size of the algorithm¡¯s hash.\r
+  @param  HashSize              Holds the returned size of the algorithm's hash.\r
 \r
   @retval EFI_SUCCESS           Hash size returned successfully.\r
   @retval EFI_INVALID_PARAMETER HashSize is NULL\r
@@ -95,12 +93,11 @@ typedef union {
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_HASH_GET_HASH_SIZE) (\r
+(EFIAPI *EFI_HASH_GET_HASH_SIZE)(\r
   IN  CONST EFI_HASH_PROTOCOL     *This,\r
   IN  CONST EFI_GUID              *HashAlgorithm,\r
   OUT UINTN                       *HashSize\r
-  )\r
-;      \r
+  );      \r
 \r
 /**\r
   Returns the size of the hash which results from a specific algorithm.\r
@@ -117,21 +114,32 @@ EFI_STATUS
   @retval EFI_SUCCESS           Hash returned successfully.\r
   @retval EFI_INVALID_PARAMETER Message or Hash is NULL\r
   @retval EFI_UNSUPPORTED       The algorithm specified by HashAlgorithm is not supported by this\r
-                                 driver. Or extend is TRUE and the algorithm doesn¡¯t support extending the hash.\r
+                                 driver. Or extend is TRUE and the algorithm doesn't support extending the hash.\r
 \r
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_HASH_HASH) (\r
+(EFIAPI *EFI_HASH_HASH)(\r
   IN CONST EFI_HASH_PROTOCOL      *This,\r
   IN CONST EFI_GUID               *HashAlgorithm,\r
   IN BOOLEAN                      Extend,\r
   IN CONST UINT8                  *Message,\r
   IN UINT64                       MessageSize,\r
   IN OUT EFI_HASH_OUTPUT          *Hash\r
-  )\r
-;    \r
+  );    \r
+\r
+/**\r
+  @par Protocol Description:\r
+  This protocol allows creating a hash of an arbitrary message digest \r
+  using one or more hash algorithms.\r
 \r
+  @param GetHashSize\r
+  Return the size of a specific type of resulting hash.\r
+  \r
+  @param Hash\r
+  Create a hash for the specified message.\r
+\r
+**/\r
 struct _EFI_HASH_PROTOCOL {\r
   EFI_HASH_GET_HASH_SIZE          GetHashSize;\r
   EFI_HASH_HASH                   Hash;\r