Update the copyright notice format

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

diff --git a/MdePkg/Include/Protocol/Hash.h b/MdePkg/Include/Protocol/Hash.h
index 9355da4fffe4a39a34db42f66e0cc8d9e8687393..2034b0a378406190c5ed49de6c32e92e63199562 100644 (file)
--- a/MdePkg/Include/Protocol/Hash.h
+++ b/MdePkg/Include/Protocol/Hash.h
@@ -2,27 +2,24 @@
   EFI_HASH_SERVICE_BINDING_PROTOCOL as defined in UEFI 2.0.\r
   EFI_HASH_PROTOCOL as defined in UEFI 2.0.\r
   The EFI Hash Service Binding Protocol is used to locate hashing services support \r
-  provided by a driver and create and destroy instances of the EFI Hash Protocol \r
+  provided by a driver and to create and destroy instances of the EFI Hash Protocol \r
   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
-  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
-\r
-  Module Name:  Hash.h\r
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+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
 \r
 **/\r
 \r
 #ifndef __EFI_HASH_PROTOCOL_H__\r
 #define __EFI_HASH_PROTOCOL_H__\r
 \r
-#define EFI_HASH_SERVICE_BINDING_PROTOCOL \\r
+#define EFI_HASH_SERVICE_BINDING_PROTOCOL_GUID \\r
   { \\r
     0x42881c98, 0xa4f3, 0x44b0, {0xa3, 0x9d, 0xdf, 0xa1, 0x86, 0x67, 0xd8, 0xcd } \\r
   }\r
@@ -83,9 +80,9 @@ typedef union {
 /**\r
   Returns the size of the hash which results from a specific algorithm.\r
 \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[in]  This                  Points to this instance of EFI_HASH_PROTOCOL.\r
+  @param[in]  HashAlgorithm         Points to the EFI_GUID which identifies the algorithm to use.\r
+  @param[out] 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,43 +92,45 @@ 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
 \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  Extend        Specifies whether to create a new hash (FALSE) or extend the specified\r
-                        existing hash (TRUE).\r
-  @param  Message       Points to the start of the message.\r
-  @param  MessageSize   The size of Message, in bytes.\r
-  @param  Hash          On input, if Extend is TRUE, then this holds the hash to extend. On\r
-                        output, holds the resulting hash computed from the message.\r
+  @param[in]  This          Points to this instance of EFI_HASH_PROTOCOL.\r
+  @param[in]  HashAlgorithm Points to the EFI_GUID which identifies the algorithm to use.\r
+  @param[in]  Extend        Specifies whether to create a new hash (FALSE) or extend the specified\r
+                            existing hash (TRUE).\r
+  @param[in]  Message       Points to the start of the message.\r
+  @param[in]  MessageSize   The size of Message, in bytes.\r
+  @param[in,out]  Hash      On input, if Extend is TRUE, then this holds the hash to extend. On\r
+                            output, holds the resulting hash computed from the message.\r
 \r
   @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
+/// This protocol allows creating a hash of an arbitrary message digest \r
+/// using one or more hash algorithms.\r
+///\r
 struct _EFI_HASH_PROTOCOL {\r
   EFI_HASH_GET_HASH_SIZE          GetHashSize;\r
   EFI_HASH_HASH                   Hash;\r