]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/Hash.h
MdePkg/ProcessorBind: add defines for page allocation granularity
[mirror_edk2.git] / MdePkg / Include / Protocol / Hash.h
index 6441bfe7a8de8ab7bafb68a9f0cb4766aba0c0c8..0bee694a5b10d2b7b1b138631c86e4aff4f7e28f 100644 (file)
@@ -4,23 +4,22 @@
   The EFI Hash Service Binding Protocol is used to locate hashing services support \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 - 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
-  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
+Copyright (c) 2006 - 2014, 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
     0xaf7c79c, 0x65b5, 0x4319, {0xb0, 0xae, 0x44, 0xec, 0x48, 0x4e, 0x4a, 0xd7 } \\r
   }\r
 \r
+#define EFI_HASH_ALGORITHM_SHA1_NOPAD_GUID \\r
+  { \\r
+    0x24c5dc2f, 0x53e2, 0x40ca, {0x9e, 0xd6, 0xa5, 0xd9, 0xa4, 0x9f, 0x46, 0x3b } \\r
+  }\r
+\r
+#define EFI_HASH_ALGORITHM_SHA256_NOPAD_GUID \\r
+  { \\r
+    0x8628752a, 0x6cb7, 0x4814, {0x96, 0xfc, 0x24, 0xa8, 0x15, 0xac, 0x22, 0x26 } \\r
+  }\r
+\r
+//\r
+// Note: Use of the following algorithms with EFI_HASH_PROTOCOL is deprecated.\r
+//       EFI_HASH_ALGORITHM_SHA1_GUID\r
+//       EFI_HASH_ALGORITHM_SHA224_GUID\r
+//       EFI_HASH_ALGORITHM_SHA256_GUID\r
+//       EFI_HASH_ALGORITHM_SHA384_GUID\r
+//       EFI_HASH_ALGORITHM_SHA512_GUID\r
+//       EFI_HASH_ALGORTIHM_MD5_GUID\r
+//\r
+\r
 typedef struct _EFI_HASH_PROTOCOL EFI_HASH_PROTOCOL;\r
 \r
 typedef UINT8  EFI_MD5_HASH[16];\r
@@ -81,12 +100,12 @@ 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
+  @retval EFI_INVALID_PARAMETER HashSize is NULL or HashAlgorithm is NULL.\r
   @retval EFI_UNSUPPORTED       The algorithm specified by HashAlgorithm is not supported \r
                                 by this driver.\r
 \r
@@ -100,21 +119,26 @@ EFI_STATUS
   );      \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
-\r
+  Creates a hash for the specified message text.\r
+\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 parameter holds a pointer \r
+                            to a pointer to an array containing the hash to extend. If Extend \r
+                            is FALSE, then this parameter holds a pointer to a pointer to a \r
+                            caller-allocated array that will receive the result of the hash \r
+                            computation. On output (regardless of the value of Extend), the \r
+                            array will contain the result of the hash computation.\r
+  \r
   @retval EFI_SUCCESS           Hash returned successfully.\r
-  @retval EFI_INVALID_PARAMETER Message or Hash is NULL\r
+  @retval EFI_INVALID_PARAMETER Message or Hash, HashAlgorithm is NULL or MessageSize is 0.\r
+                                MessageSize is not an integer multiple of block size.\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
@@ -145,5 +169,7 @@ extern EFI_GUID gEfiHashAlgorithmSha256Guid;
 extern EFI_GUID gEfiHashAlgorithmSha384Guid;\r
 extern EFI_GUID gEfiHashAlgorithmSha512Guid;\r
 extern EFI_GUID gEfiHashAlgorithmMD5Guid;\r
+extern EFI_GUID gEfiHashAlgorithmSha1NoPadGuid;\r
+extern EFI_GUID gEfiHashAlgorithmSha256NoPadGuid;\r
 \r
 #endif\r