summaryrefslogtreecommitdiff
path: root/MdePkg/Include/Ppi/LoadImage.h
diff options
context:
space:
mode:
Diffstat (limited to 'MdePkg/Include/Ppi/LoadImage.h')
-rw-r--r--MdePkg/Include/Ppi/LoadImage.h31
1 files changed, 16 insertions, 15 deletions
diff --git a/MdePkg/Include/Ppi/LoadImage.h b/MdePkg/Include/Ppi/LoadImage.h
index 5d07fd96b8..8bd3e576ac 100644
--- a/MdePkg/Include/Ppi/LoadImage.h
+++ b/MdePkg/Include/Ppi/LoadImage.h
@@ -1,5 +1,5 @@
/** @file
- The file descript the PPI which notifies other drivers
+ The file describes the PPI which notifies other drivers
of the PEIM being initialized by the PEI Dispatcher.
Copyright (c) 2006 - 2008, Intel Corporation
@@ -26,23 +26,24 @@
typedef struct _EFI_PEI_LOADED_IMAGE_PPI EFI_PEI_LOADED_IMAGE_PPI;
-/**
- @par Ppi Description:
- This interface is installed by the PEI Dispatcher after the image has been
- loaded and after all security checks have been performed,
- to notify other PEIMs of the files which are being loaded.
-
- @param ImageAddress Address of the image at the address where it will be executed.
-
- @param ImageSize Size of the image as it will be executed.
-
- @param FileHandle File handle from which the image was loaded. Can be NULL,
- indicating the image was not loaded from a handle.
-
-**/
+///
+/// This interface is installed by the PEI Dispatcher after the image has been
+/// loaded and after all security checks have been performed,
+/// to notify other PEIMs of the files which are being loaded.
+///
struct _EFI_PEI_LOADED_IMAGE_PPI {
+ ///
+ /// Address of the image at the address where it will be executed.
+ ///
EFI_PHYSICAL_ADDRESS ImageAddress;
+ ///
+ /// Size of the image as it will be executed.
+ ///
UINT64 ImageSize;
+ ///
+ /// File handle from which the image was loaded.
+ /// Can be NULL, indicating the image was not loaded from a handle.
+ ///
EFI_PEI_FILE_HANDLE FileHandle;
};