]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/TrEEProtocol.h
MdePkg: Clean up source files
[mirror_edk2.git] / MdePkg / Include / Protocol / TrEEProtocol.h
index 9a437384bece5f4fa363b362ae93215ad5c2bc6c..dce830e72d50a135636626b5ca67208552227173 100644 (file)
@@ -1,13 +1,13 @@
 /** @file\r
   This protocol is defined to abstract TPM2 hardware access in boot phase.\r
 \r
-Copyright (c) 2013 - 2016, Intel Corporation. All rights reserved.<BR>\r
-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
+Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.<BR>\r
+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
+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
@@ -35,19 +35,19 @@ typedef UINT32 TREE_EVENT_LOG_FORMAT;
 \r
 typedef struct _TREE_BOOT_SERVICE_CAPABILITY {\r
   //\r
-  // Allocated size of the structure passed in \r
+  // Allocated size of the structure passed in\r
   //\r
   UINT8                 Size;\r
   //\r
   // Version of the TREE_BOOT_SERVICE_CAPABILITY structure itself.\r
   // For this version of the protocol, the Major version shall be set to 1\r
-  // and the Minor version shall be set to 0. \r
+  // and the Minor version shall be set to 0.\r
   //\r
   TREE_VERSION          StructureVersion;\r
   //\r
   // Version of the TrEE protocol.\r
   // For this version of the protocol, the Major version shall be set to 1\r
-  // and the Minor version shall be set to 0. \r
+  // and the Minor version shall be set to 0.\r
   //\r
   TREE_VERSION          ProtocolVersion;\r
   //\r
@@ -59,20 +59,20 @@ typedef struct _TREE_BOOT_SERVICE_CAPABILITY {
   //\r
   TREE_EVENT_LOG_BITMAP SupportedEventLogs;\r
   //\r
-  // False = TrEE not present \r
+  // False = TrEE not present\r
   //\r
   BOOLEAN               TrEEPresentFlag;\r
   //\r
-  // Max size (in bytes) of a command that can be sent to the TrEE \r
+  // Max size (in bytes) of a command that can be sent to the TrEE\r
   //\r
   UINT16                MaxCommandSize;\r
   //\r
-  // Max size (in bytes) of a response that can be provided by the TrEE \r
+  // Max size (in bytes) of a response that can be provided by the TrEE\r
   //\r
   UINT16                MaxResponseSize;\r
   //\r
   // 4-byte Vendor ID (see Trusted Computing Group, "TCG Vendor ID Registry,"\r
-  // Version 1.0, Revision 0.1, August 31, 2007, "TPM Capabilities Vendor ID" section) \r
+  // Version 1.0, Revision 0.1, August 31, 2007, "TPM Capabilities Vendor ID" section)\r
   //\r
   UINT32                ManufacturerID;\r
 } TREE_BOOT_SERVICE_CAPABILITY_1_0;\r
@@ -103,7 +103,7 @@ typedef UINT32 TrEE_EVENTTYPE;
 \r
 typedef struct {\r
   //\r
-  // Size of the event header itself (sizeof(TrEE_EVENT_HEADER)). \r
+  // Size of the event header itself (sizeof(TrEE_EVENT_HEADER)).\r
   //\r
   UINT32            HeaderSize;\r
   //\r
@@ -111,18 +111,18 @@ typedef struct {
   //\r
   UINT16            HeaderVersion;\r
   //\r
-  // Index of the PCR that shall be extended (0 - 23). \r
+  // Index of the PCR that shall be extended (0 - 23).\r
   //\r
   TrEE_PCRINDEX     PCRIndex;\r
   //\r
-  // Type of the event that shall be extended (and optionally logged). \r
+  // Type of the event that shall be extended (and optionally logged).\r
   //\r
   TrEE_EVENTTYPE    EventType;\r
 } TrEE_EVENT_HEADER;\r
 \r
 typedef struct {\r
   //\r
-  // Total size of the event including the Size component, the header and the Event data. \r
+  // Total size of the event including the Size component, the header and the Event data.\r
   //\r
   UINT32            Size;\r
   TrEE_EVENT_HEADER Header;\r
@@ -144,11 +144,11 @@ typedef struct {
 \r
   @retval EFI_SUCCESS            Operation completed successfully.\r
   @retval EFI_DEVICE_ERROR       The command was unsuccessful.\r
-                                 The ProtocolCapability variable will not be populated. \r
+                                 The ProtocolCapability variable will not be populated.\r
   @retval EFI_INVALID_PARAMETER  One or more of the parameters are incorrect.\r
                                  The ProtocolCapability variable will not be populated.\r
   @retval EFI_BUFFER_TOO_SMALL   The ProtocolCapability variable is too small to hold the full response.\r
-                                 It will be partially populated (required Size field will be set). \r
+                                 It will be partially populated (required Size field will be set).\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -159,7 +159,7 @@ EFI_STATUS
 \r
 /**\r
   The EFI_TREE_PROTOCOL Get Event Log function call allows a caller to\r
-  retrieve the address of a given event log and its last entry. \r
+  retrieve the address of a given event log and its last entry.\r
 \r
   @param[in]  This               Indicates the calling context\r
   @param[in]  EventLogFormat     The type of the event log for which the information is requested.\r
@@ -187,13 +187,13 @@ EFI_STATUS
 /**\r
   The EFI_TREE_PROTOCOL HashLogExtendEvent function call provides callers with\r
   an opportunity to extend and optionally log events without requiring\r
-  knowledge of actual TPM commands. \r
+  knowledge of actual TPM commands.\r
   The extend operation will occur even if this function cannot create an event\r
-  log entry (e.g. due to the event log being full). \r
+  log entry (e.g. due to the event log being full).\r
 \r
   @param[in]  This               Indicates the calling context\r
   @param[in]  Flags              Bitmap providing additional information.\r
-  @param[in]  DataToHash         Physical address of the start of the data buffer to be hashed. \r
+  @param[in]  DataToHash         Physical address of the start of the data buffer to be hashed.\r
   @param[in]  DataToHashLen      The length in bytes of the buffer referenced by DataToHash.\r
   @param[in]  Event              Pointer to data buffer containing information about the event.\r
 \r
@@ -225,7 +225,7 @@ EFI_STATUS
   @retval EFI_SUCCESS            The command byte stream was successfully sent to the device and a response was successfully received.\r
   @retval EFI_DEVICE_ERROR       The command was not successfully sent to the device or a response was not successfully received from the device.\r
   @retval EFI_INVALID_PARAMETER  One or more of the parameters are incorrect.\r
-  @retval EFI_BUFFER_TOO_SMALL   The output parameter block is too small. \r
+  @retval EFI_BUFFER_TOO_SMALL   The output parameter block is too small.\r
 **/\r
 typedef\r
 EFI_STATUS\r