Improve status codes returned for functions of EFI_TCG_PROTOCOL. Note that after...

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9552 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdePkg/Include/Protocol/TcgService.h b/MdePkg/Include/Protocol/TcgService.h
index 519cfbbfc5a5b9ef5536e944d3fa1492fff573f8..3f27b9a3aed4e63538c1f3abe52a82040be5e814 100644 (file)
--- a/MdePkg/Include/Protocol/TcgService.h
+++ b/MdePkg/Include/Protocol/TcgService.h
@@ -2,7 +2,7 @@
   TCG Service Protocol as defined in TCG_EFI_Protocol_1_20_Final\r
   See http://trustedcomputinggroup.org for the latest specification\r
 \r
-  Copyright (c) 2007 - 2008, Intel Corporation \r
+  Copyright (c) 2007 - 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
@@ -42,6 +42,12 @@ typedef struct _TCG_EFI_BOOT_SERVICE_CAPABILITY {
 \r
 typedef UINT32   TCG_ALGORITHM_ID;\r
 \r
+///\r
+/// Note:\r
+///   Status codes returned for functions of EFI_TCG_PROTOCOL do not exactly match\r
+///   those defined in the TCG EFI Protocol 1.20 Final Specification.\r
+///\r
+\r
 /**\r
   This service provides EFI protocol capability information, state information \r
   about the TPM, and Event Log state information.\r
@@ -61,11 +67,7 @@ typedef UINT32   TCG_ALGORITHM_ID;
                                  the last entry in the event log in memory. \r
 \r
   @retval EFI_SUCCESS            Operation completed successfully.\r
-  @retval EFI_DEVICE_ERROR       The command was unsuccessful.\r
-  @retval EFI_INVALID_PARAMETER  One or more of the parameters are incorrect.\r
-  @retval EFI_BUFFER_TOO_SMALL   The receive buffer is too small.\r
-  @retval EFI_NOT_FOUND          The component was not running\r
-\r
+  @retval EFI_INVALID_PARAMETER  ProtocolCapability does not match TCG capability.\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -89,11 +91,11 @@ EFI_STATUS
   @param  HashedDataResult       Resultant buffer of the hashed data  \r
   \r
   @retval EFI_SUCCESS            Operation completed successfully.\r
-  @retval EFI_DEVICE_ERROR       The command was unsuccessful.\r
-  @retval EFI_INVALID_PARAMETER  One or more of the parameters are incorrect.\r
-  @retval EFI_BUFFER_TOO_SMALL   The receive buffer is too small.\r
-  @retval EFI_NOT_FOUND          The component was not running\r
-\r
+  @retval EFI_INVALID_PARAMETER  HashDataLen is NULL.\r
+  @retval EFI_INVALID_PARAMETER  HashDataLenResult is NULL.\r
+  @retval EFI_OUT_OF_RESOURCES   Cannot allocate buffer of size *HashedDataLen.\r
+  @retval EFI_UNSUPPORTED        AlgorithmId not supported.\r
+  @retval EFI_BUFFER_TOO_SMALL   *HashedDataLen < sizeof (TCG_DIGEST).\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -120,10 +122,7 @@ EFI_STATUS
                                  other bits are reserved. \r
  \r
   @retval EFI_SUCCESS            Operation completed successfully.\r
-  @retval EFI_DEVICE_ERROR       The command was unsuccessful.\r
-  @retval EFI_INVALID_PARAMETER  One or more of the parameters are incorrect.\r
-  @retval EFI_BUFFER_TOO_SMALL   The receive buffer is too small.\r
-  @retval EFI_NOT_FOUND          The component was not running\r
+  @retval EFI_OUT_OF_RESOURCES   Insufficient memory in the event log to complete this action.\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -144,10 +143,9 @@ EFI_STATUS
   @param  TpmOutputParameterBlock     Pointer to the TPM output parameter block\r
 \r
   @retval EFI_SUCCESS            Operation completed successfully.\r
-  @retval EFI_DEVICE_ERROR       The command was unsuccessful.\r
-  @retval EFI_INVALID_PARAMETER  One or more of the parameters are incorrect.\r
-  @retval EFI_BUFFER_TOO_SMALL   The receive buffer is too small.\r
-  @retval EFI_NOT_FOUND          The component was not running\r
+  @retval EFI_INVALID_PARAMETER  Invalid ordinal.\r
+  @retval EFI_UNSUPPORTED        Current Task Priority Level  >= EFI_TPL_CALLBACK.\r
+  @retval EFI_TIMEOUT            The TIS timed-out.\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -177,10 +175,9 @@ EFI_STATUS
                                  the start of the Event Log.\r
 \r
   @retval EFI_SUCCESS            Operation completed successfully.\r
+  @retval EFI_UNSUPPORTED        AlgorithmId != TPM_ALG_SHA.\r
+  @retval EFI_UNSUPPORTED        Current TPL >= EFI_TPL_CALLBACK.\r
   @retval EFI_DEVICE_ERROR       The command was unsuccessful.\r
-  @retval EFI_INVALID_PARAMETER  One or more of the parameters are incorrect.\r
-  @retval EFI_BUFFER_TOO_SMALL   The receive buffer is too small.\r
-  @retval EFI_NOT_FOUND          The component was not running\r
 **/\r
 typedef\r
 EFI_STATUS\r