Formalize comments for Protocols and PPIs.

[mirror_edk2.git] / MdePkg / Include / Protocol / LoadedImage.h

diff --git a/MdePkg/Include/Protocol/LoadedImage.h b/MdePkg/Include/Protocol/LoadedImage.h
index c94cb77a08490bd6b799abc3a801d6846f2cd6eb..c31b27545ad5f4d7b576f5d6e2a3de8805e38904 100644 (file)
--- a/MdePkg/Include/Protocol/LoadedImage.h
+++ b/MdePkg/Include/Protocol/LoadedImage.h
@@ -1,10 +1,10 @@
 /** @file\r
-  EFI 1.0 Loaded image protocol definition.\r
+  UEFI 2.0 Loaded image protocol definition.\r
 \r
   Every EFI driver and application is passed an image handle when it is loaded.\r
   This image handle will contain a Loaded Image Protocol.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, 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
@@ -25,51 +25,98 @@
     0x5B1B31A1, 0x9562, 0x11d2, {0x8E, 0x3F, 0x00, 0xA0, 0xC9, 0x69, 0x72, 0x3B } \\r
   }\r
 \r
-//\r
-// Protocol GUID defined in EFI1.1.\r
-// \r
+#define EFI_LOADED_IMAGE_DEVICE_PATH_PROTOCOL_GUID \\r
+  { \\r
+    0xbc62157e, 0x3e33, 0x4fec, {0x99, 0x20, 0x2d, 0x3b, 0x36, 0xd7, 0x50, 0xdf } \\r
+  }\r
+\r
+///\r
+/// Protocol GUID defined in EFI1.1.\r
+/// \r
 #define LOADED_IMAGE_PROTOCOL   EFI_LOADED_IMAGE_PROTOCOL_GUID\r
 \r
-//\r
-// EFI_SYSTEM_TABLE & EFI_IMAGE_UNLOAD are defined in EfiApi.h\r
-//\r
+///\r
+/// EFI_SYSTEM_TABLE & EFI_IMAGE_UNLOAD are defined in EfiApi.h\r
+///\r
 #define EFI_LOADED_IMAGE_PROTOCOL_REVISION  0x1000\r
 \r
-//\r
-// Revision defined in EFI1.1.\r
-// \r
+///\r
+/// Revision defined in EFI1.1.\r
+/// \r
 #define EFI_LOADED_IMAGE_INFORMATION_REVISION    EFI_LOADED_IMAGE_PROTOCOL_REVISION\r
 \r
-\r
+///\r
+/// Can be used on any image handle to obtain information about the loaded image.\r
+///\r
 typedef struct {\r
+  ///\r
+  /// Defines the revision of the EFI_LOADED_IMAGE_PROTOCOL structure. \r
+  /// All future revisions will be backward compatible to the current revision.\r
+  ///\r
   UINT32                    Revision;\r
+\r
+  ///\r
+  /// Parent image's image handle. NULL if the image is loaded directly from \r
+  /// the firmware's boot manager. \r
+  ///\r
   EFI_HANDLE                ParentHandle;\r
+\r
+  ///\r
+  /// the image's EFI system table pointer.\r
+  ///\r
   EFI_SYSTEM_TABLE          *SystemTable;\r
 \r
   //\r
   // Source location of image\r
   //\r
+  ///\r
+  /// The device handle that the EFI Image was loaded from. \r
+  ///\r
   EFI_HANDLE                DeviceHandle;\r
+  \r
+  ///\r
+  /// A pointer to the file path portion specific to DeviceHandle \r
+  /// that the EFI Image was loaded from. \r
+  ///\r
   EFI_DEVICE_PATH_PROTOCOL  *FilePath;\r
-  VOID                      *Reserved;\r
+  VOID                      *Reserved;       ///< Reserved. DO NOT USE.\r
 \r
   //\r
   // Images load options\r
   //\r
+  ///\r
+  /// The size in bytes of LoadOptions.\r
+  ///\r
   UINT32                    LoadOptionsSize;\r
+  \r
+  ///\r
+  /// A pointer to the image's binary load options.\r
+  ///\r
   VOID                      *LoadOptions;\r
 \r
   //\r
   // Location of where image was loaded\r
   //\r
+  ///\r
+  /// The base address at which the image was loaded.\r
+  ///\r
   VOID                      *ImageBase;\r
+  \r
+  ///\r
+  /// The size in bytes of the loaded image.\r
+  ///\r
   UINT64                    ImageSize;\r
+\r
+  ///\r
+  /// The memory type that the code sections were loaded as.\r
+  ///\r
   EFI_MEMORY_TYPE           ImageCodeType;\r
+\r
+  ///\r
+  /// The memory type that the data sections were loaded as.\r
+  ///\r
   EFI_MEMORY_TYPE           ImageDataType;\r
 \r
-  //\r
-  // If the driver image supports a dynamic unload request\r
-  //\r
   EFI_IMAGE_UNLOAD          Unload;\r
 \r
 } EFI_LOADED_IMAGE_PROTOCOL;\r
@@ -80,5 +127,6 @@ typedef struct {
 typedef EFI_LOADED_IMAGE_PROTOCOL EFI_LOADED_IMAGE;\r
 \r
 extern EFI_GUID gEfiLoadedImageProtocolGuid;\r
+extern EFI_GUID gEfiLoadedImageDevicePathProtocolGuid;\r
 \r
 #endif\r