]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/TcgService.h
Grammatical and disclaimer changes (does not follow internal C coding stds.)
[mirror_edk2.git] / MdePkg / Include / Protocol / TcgService.h
index 3f27b9a3aed4e63538c1f3abe52a82040be5e814..5e956253a18f61ae17d0b2a107f7955b4f60a4d0 100644 (file)
@@ -2,14 +2,14 @@
   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 - 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
-  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) 2007 - 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
@@ -31,13 +31,13 @@ typedef struct {
 } TCG_VERSION;\r
 \r
 typedef struct _TCG_EFI_BOOT_SERVICE_CAPABILITY {\r
-  UINT8          Size;                /// Size of this structure\r
+  UINT8          Size;                /// Size of this structure.\r
   TCG_VERSION    StructureVersion;    \r
   TCG_VERSION    ProtocolSpecVersion;\r
-  UINT8          HashAlgorithmBitmap; /// Hash algorithms  \r
-                                      /// this protocol is capable of : 01=SHA-1\r
-  BOOLEAN        TPMPresentFlag;      /// 00h = TPM not present\r
-  BOOLEAN        TPMDeactivatedFlag;  /// 01h = TPM currently deactivated\r
+  UINT8          HashAlgorithmBitmap; /// Hash algorithms . \r
+                                      /// This protocol is capable of : 01=SHA-1.\r
+  BOOLEAN        TPMPresentFlag;      /// 00h = TPM not present.\r
+  BOOLEAN        TPMDeactivatedFlag;  /// 01h = TPM currently deactivated.\r
 } TCG_EFI_BOOT_SERVICE_CAPABILITY;\r
 \r
 typedef UINT32   TCG_ALGORITHM_ID;\r
@@ -66,7 +66,7 @@ typedef UINT32   TCG_ALGORITHM_ID;
                                  this is a pointer to the address of the start of \r
                                  the last entry in the event log in memory. \r
 \r
-  @retval EFI_SUCCESS            Operation completed successfully.\r
+  @retval EFI_SUCCESS            The operation completed successfully.\r
   @retval EFI_INVALID_PARAMETER  ProtocolCapability does not match TCG capability.\r
 **/\r
 typedef\r
@@ -83,14 +83,14 @@ EFI_STATUS
 /**\r
   This service abstracts the capability to do a hash operation on a data buffer.\r
   \r
-  @param  This                   Indicates the calling context\r
-  @param  HashData               Pointer to the data buffer to be hashed\r
-  @param  HashDataLen            Length of the data buffer to be hashed\r
-  @param  AlgorithmId            Identification of the Algorithm to use for the hashing operation\r
-  @param  HashedDataLen          Resultant length of the hashed data\r
-  @param  HashedDataResult       Resultant buffer of the hashed data  \r
+  @param  This                   Indicates the calling context.\r
+  @param  HashData               The pointer to the data buffer to be hashed.\r
+  @param  HashDataLen            The length of the data buffer to be hashed.\r
+  @param  AlgorithmId            Identification of the Algorithm to use for the hashing operation.\r
+  @param  HashedDataLen          Resultant length of the hashed data.\r
+  @param  HashedDataResult       Resultant buffer of the hashed data.\r
   \r
-  @retval EFI_SUCCESS            Operation completed successfully.\r
+  @retval EFI_SUCCESS            The operation completed successfully.\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
@@ -112,16 +112,16 @@ EFI_STATUS
   This service abstracts the capability to add an entry to the Event Log.\r
 \r
   @param  This                   Indicates the calling context\r
-  @param  TCGLogData             Pointer to the start of the data buffer containing \r
+  @param  TCGLogData             The pointer to the start of the data buffer containing \r
                                  the TCG_PCR_EVENT data structure. All fields in \r
                                  this structure are properly filled by the caller.\r
-  @param  EventNumber            The event number of the event just logged\r
-  @param  Flags                  Indicate additional flags. Only one flag has been \r
+  @param  EventNumber            The event number of the event just logged.\r
+  @param  Flags                  Indicates additional flags. Only one flag has been \r
                                  defined at this time, which is 0x01 and means the \r
                                  extend operation should not be performed. All \r
                                  other bits are reserved. \r
  \r
-  @retval EFI_SUCCESS            Operation completed successfully.\r
+  @retval EFI_SUCCESS            The operation completed successfully.\r
   @retval EFI_OUT_OF_RESOURCES   Insufficient memory in the event log to complete this action.\r
 **/\r
 typedef\r
@@ -136,13 +136,13 @@ EFI_STATUS
 /**\r
   This service is a proxy for commands to the TPM.\r
 \r
-  @param  This                        Indicates the calling context\r
-  @param  TpmInputParameterBlockSize  Size of the TPM input parameter block\r
-  @param  TpmInputParameterBlock      Pointer to the TPM input parameter block\r
-  @param  TpmOutputParameterBlockSize Size of the TPM output parameter block\r
-  @param  TpmOutputParameterBlock     Pointer to the TPM output parameter block\r
+  @param  This                        Indicates the calling context.\r
+  @param  TpmInputParameterBlockSize  Size of the TPM input parameter block.\r
+  @param  TpmInputParameterBlock      The pointer to the TPM input parameter block.\r
+  @param  TpmOutputParameterBlockSize Size of the TPM output parameter block.\r
+  @param  TpmOutputParameterBlock     The pointer to the TPM output parameter block.\r
 \r
-  @retval EFI_SUCCESS            Operation completed successfully.\r
+  @retval EFI_SUCCESS            The operation completed successfully.\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
@@ -161,20 +161,20 @@ EFI_STATUS
   This service abstracts the capability to do a hash operation on a data buffer, extend a specific TPM PCR with the hash result, and add an entry to the Event Log\r
 \r
   @param  This                   Indicates the calling context\r
-  @param  HashData               Physical address of the start of the data buffer \r
+  @param  HashData               The physical address of the start of the data buffer \r
                                  to be hashed, extended, and logged.\r
   @param  HashDataLen            The length, in bytes, of the buffer referenced by HashData\r
   @param  AlgorithmId            Identification of the Algorithm to use for the hashing operation\r
   @param  TCGLogData             The physical address of the start of the data \r
                                  buffer containing the TCG_PCR_EVENT data structure.\r
   @param  EventNumber            The event number of the event just logged.\r
-  @param  EventLogLastEntry      Physical address of the first byte of the entry \r
+  @param  EventLogLastEntry      The physical address of the first byte of the entry \r
                                  just placed in the Event Log. If the Event Log was \r
                                  empty when this function was called then this physical \r
                                  address will be the same as the physical address of \r
                                  the start of the Event Log.\r
 \r
-  @retval EFI_SUCCESS            Operation completed successfully.\r
+  @retval EFI_SUCCESS            The 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