Add comments for Tcg Platform protocol.

[mirror_edk2.git] / MdeModulePkg / Include / Protocol / TcgPlatform.h

diff --git a/MdeModulePkg/Include/Protocol/TcgPlatform.h b/MdeModulePkg/Include/Protocol/TcgPlatform.h
index a1f8c43725441bed1ad142fea8cd795683459730..4c87b58a5da004d9f4e51a0bdf85c36c6e13006b 100644 (file)
--- a/MdeModulePkg/Include/Protocol/TcgPlatform.h
+++ b/MdeModulePkg/Include/Protocol/TcgPlatform.h
@@ -24,6 +24,24 @@ typedef struct tdEFI_TCG_PLATFORM_PROTOCOL EFI_TCG_PLATFORM_PROTOCOL;
 //\r
 // EFI TCG Platform Protocol\r
 //\r
+/**\r
+  \r
+  Measure PE/COFF Image File prior to the application of any fix-ups or relocations.\r
+  \r
+  @param  BootPolicy      If TRUE, indicates that the request originates from the boot manager,\r
+                          and that the boot manager is attempting to load FilePath as a boot selection.\r
+  @param  ImageAddress    The memory address to PE/COFF image.\r
+  @param  ImageSize       The size of PE/COFF image.\r
+  @param  LinkTimeBase    The image base address in the original PeImage.\r
+  @param  ImageType       The subsystem type of the PeImage.\r
+  @param  DeviceHandle    The handle to device matched the file path. \r
+  @param  FilePath        The specific file path from which the image is loaded.\r
+  \r
+  @retval EFI_SUCCESS           Measure successfully.\r
+  @retval EFI_UNSUPPORTED       The loaded PeImage is not supported.\r
+  @retval EFI_OUT_OF_RESOURCES  The resource of memory is not enough.\r
+\r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_TCG_MEASURE_PE_IMAGE) (\r
@@ -36,6 +54,15 @@ EFI_STATUS
   IN      EFI_DEVICE_PATH_PROTOCOL  *FilePath\r
   );\r
 \r
+/**\r
+  \r
+  Measure efi action string.\r
+  \r
+  @param  ActionString  Pointer to action string.\r
+  \r
+  @retval EFI_SUCCESS   Measure action string successfully.\r
+\r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_TCG_MEASURE_ACTION) (\r