MdePkg/ProcessorBind: add defines for page allocation granularity

[mirror_edk2.git] / MdePkg / Include / Ppi / LoadImage.h

diff --git a/MdePkg/Include/Ppi/LoadImage.h b/MdePkg/Include/Ppi/LoadImage.h
index 40fc7ea289bef1f97240511c2e9ad2373470b0d9..75f743a58cad44e3b059f94c347c710aadd3876a 100644 (file)
--- a/MdePkg/Include/Ppi/LoadImage.h
+++ b/MdePkg/Include/Ppi/LoadImage.h
@@ -1,9 +1,9 @@
-/* @file\r
-  The file descript the PPI which notifies other drivers \r
-       of the PEIM being initialized by the PEI Dispatcher.\r
+/** @file\r
+  The file describes the PPI which notifies other drivers \r
+  of the PEIM being initialized by the PEI Dispatcher.\r
 \r
-  Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
-  All rights reserved. This program and the accompanying materials                          \r
+  Copyright (c) 2006 - 2008, 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
@@ -11,11 +11,8 @@
   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
-  Module Name:  LoadImage.h\r
-\r
   @par Revision Reference:\r
-  This PPI is defined in PI.\r
-  Version 1.00.\r
+  This PPI is introduced in PI Version 1.0.\r
 \r
 **/\r
 \r
@@ -23,28 +20,30 @@
 #define __LOADED_IMAGE_PPI_H__\r
 \r
 #define EFI_PEI_LOADED_IMAGE_PPI_GUID \\r
-       { 0xc1fcd448, 0x6300, 0x4458, { 0xb8, 0x64, 0x28, 0xdf, 0x1, 0x53, 0x64, 0xbc } }\r
-\r
-\r
-typedef struct _EFI_PEI_LOADED_IMAGE_PPI       EFI_PEI_LOADED_IMAGE_PPI;\r
+  { 0xc1fcd448, 0x6300, 0x4458, { 0xb8, 0x64, 0x28, 0xdf, 0x1, 0x53, 0x64, 0xbc } }\r
 \r
-/*\r
-       This interface is installed by the PEI Dispatcher after the image has been\r
-       loaded and after all security checks have been performed, \r
-       to notify other PEIMs of the files which are being loaded.\r
 \r
-  @param  ImageAddress  Address of the image at the address where it will be executed.\r
+typedef struct _EFI_PEI_LOADED_IMAGE_PPI  EFI_PEI_LOADED_IMAGE_PPI;\r
 \r
-  @param  ImageSize     Size of the image as it will be executed.\r
-\r
-  @param  FileHandle           File handle from which the image was loaded. Can be NULL, \r
-                                                                                               indicating the image was not loaded from a handle.\r
-\r
-**/\r
+///\r
+/// This interface is installed by the PEI Dispatcher after the image has been\r
+/// loaded and after all security checks have been performed, \r
+/// to notify other PEIMs of the files which are being loaded.\r
+///\r
 struct _EFI_PEI_LOADED_IMAGE_PPI {\r
-       EFI_PHYSICAL_ADDRESS    ImageAddress;\r
-       UINT64                                                          ImageSize;\r
-       EFI_PEI_FILE_HANDLE     FileHandle;\r
+  ///\r
+  /// Address of the image at the address where it will be executed.\r
+  ///\r
+  EFI_PHYSICAL_ADDRESS  ImageAddress;\r
+  ///\r
+  /// Size of the image as it will be executed.\r
+  ///\r
+  UINT64                ImageSize;\r
+  ///\r
+  /// File handle from which the image was loaded.\r
+  /// Can be NULL, indicating the image was not loaded from a handle.\r
+  ///\r
+  EFI_PEI_FILE_HANDLE   FileHandle;\r
 };\r
 \r
 \r