Update MdePkg/Include/Ppi according to code review comments.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5818 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdePkg/Include/Ppi/CpuIo.h b/MdePkg/Include/Ppi/CpuIo.h
index cdb83a92d431a0939e496ebd0f5b2cf49ac523d1..396643202884a733cb1b7a1a301e351c068e1be8 100644 (file)
--- a/MdePkg/Include/Ppi/CpuIo.h
+++ b/MdePkg/Include/Ppi/CpuIo.h
@@ -20,7 +20,6 @@
 #ifndef __PEI_CPUIO_PPI_H__\r
 #define __PEI_CPUIO_PPI_H__\r
 \r
 #ifndef __PEI_CPUIO_PPI_H__\r
 #define __PEI_CPUIO_PPI_H__\r
 \r

-#include <ProcessorBind.h>\r

 #include <Pi/PiPeiCis.h>\r
 \r
 #define EFI_PEI_CPU_IO_PPI_INSTALLED_GUID \\r
 #include <Pi/PiPeiCis.h>\r
 \r
 #define EFI_PEI_CPU_IO_PPI_INSTALLED_GUID \\r


@@ -52,12 +51,13 @@ typedef enum {
 /**\r
   Memory-based access services and I/O-based access services.\r
 \r
 /**\r
   Memory-based access services and I/O-based access services.\r
 \r

-  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
-  @param  This           Pointer to local data for the interface.\r
-  @param  Width          The width of the access. Enumerated in bytes.\r
-  @param  Address        The physical address of the access.\r
-  @param  Count          The number of accesses to perform.\r
-  @param  Buffer         A pointer to the buffer of data.\r
+  @param  PeiServices           An indirect pointer to the PEI Services Table\r
+                                published by the PEI Foundation.\r
+  @param  This                  Pointer to local data for the interface.\r
+  @param  Width                 The width of the access. Enumerated in bytes.\r
+  @param  Address               The physical address of the access.\r
+  @param  Count                 The number of accesses to perform.\r
+  @param  Buffer                A pointer to the buffer of data.\r

 \r
   @retval EFI_SUCCESS           The function completed successfully.\r
   @retval EFI_NOT_YET_AVAILABLE The service has not been installed.\r
 \r
   @retval EFI_SUCCESS           The function completed successfully.\r
   @retval EFI_NOT_YET_AVAILABLE The service has not been installed.\r


@@ -66,8 +66,8 @@ typedef enum {
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_IO_MEM)(\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_IO_MEM)(\r

-  IN  EFI_PEI_SERVICES                  **PeiServices,\r
-  IN  EFI_PEI_CPU_IO_PPI                *This,\r
+  IN  CONST EFI_PEI_SERVICES            **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI          *This,\r

   IN  EFI_PEI_CPU_IO_PPI_WIDTH          Width,\r
   IN  UINT64                            Address,\r
   IN  UINTN                             Count,\r
   IN  EFI_PEI_CPU_IO_PPI_WIDTH          Width,\r
   IN  UINT64                            Address,\r
   IN  UINTN                             Count,\r


@@ -80,7 +80,13 @@ EFI_STATUS
 /// *******************************************************\r
 ///\r
 typedef struct {\r
 /// *******************************************************\r
 ///\r
 typedef struct {\r

+  ///\r
+  /// This service provides the various modalities of memory and I/O read.\r
+  ///\r

   EFI_PEI_CPU_IO_PPI_IO_MEM Read;\r
   EFI_PEI_CPU_IO_PPI_IO_MEM Read;\r

+  ///\r
+  /// This service provides the various modalities of memory and I/O write.\r
+  ///\r

   EFI_PEI_CPU_IO_PPI_IO_MEM Write;\r
 } EFI_PEI_CPU_IO_PPI_ACCESS;\r
 \r
   EFI_PEI_CPU_IO_PPI_IO_MEM Write;\r
 } EFI_PEI_CPU_IO_PPI_ACCESS;\r
 \r


@@ -91,15 +97,15 @@ typedef struct {
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r

-  @return UINT8          An 8-bit value is returned from the I/O space.\r
+  @return An 8-bit value returned from the I/O space.\r

 \r
 **/\r
 typedef\r
 UINT8\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_IO_READ8)(\r
 \r
 **/\r
 typedef\r
 UINT8\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_IO_READ8)(\r

-  IN  EFI_PEI_SERVICES        **PeiServices,\r
-  IN  EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                  Address\r
+  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
+  IN  UINT64                        Address\r

   );\r
 \r
 /**\r
   );\r
 \r
 /**\r


@@ -109,15 +115,15 @@ UINT8
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r

-  @return UINT16         A 16-bit value is returned from the I/O space.\r
+  @return A 16-bit value returned from the I/O space.\r

 \r
 **/\r
 typedef\r
 UINT16\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_IO_READ16)(\r
 \r
 **/\r
 typedef\r
 UINT16\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_IO_READ16)(\r

-  IN  EFI_PEI_SERVICES        **PeiServices,\r
-  IN  EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                  Address\r
+  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
+  IN  UINT64                        Address\r

   );\r
 \r
 /**\r
   );\r
 \r
 /**\r


@@ -127,15 +133,15 @@ UINT16
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r

-  @return UINT32         A 32-bit value is returned from the I/O space.\r
+  @return A 32-bit value returned from the I/O space.\r

 \r
 **/\r
 typedef\r
 UINT32\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_IO_READ32)(\r
 \r
 **/\r
 typedef\r
 UINT32\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_IO_READ32)(\r

-  IN  EFI_PEI_SERVICES        **PeiServices,\r
-  IN  EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                  Address\r
+  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
+  IN  UINT64                        Address\r

   );\r
 \r
 /**\r
   );\r
 \r
 /**\r


@@ -145,15 +151,15 @@ UINT32
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r

-  @return UINT64         A 64-bit value is returned from the I/O space.\r
+  @return A 64-bit value returned from the I/O space.\r

 \r
 **/\r
 typedef\r
 UINT64\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_IO_READ64)(\r
 \r
 **/\r
 typedef\r
 UINT64\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_IO_READ64)(\r

-  IN  EFI_PEI_SERVICES        **PeiServices,\r
-  IN  EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                  Address\r
+  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
+  IN  UINT64                        Address\r

   );\r
 \r
 /**\r
   );\r
 \r
 /**\r


@@ -164,16 +170,14 @@ UINT64
   @param  Address        The physical address of the access.\r
   @param  Data           The data to write.\r
 \r
   @param  Address        The physical address of the access.\r
   @param  Data           The data to write.\r
 \r

-  @return None\r
-\r

 **/\r
 typedef\r
 VOID\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_IO_WRITE8)(\r
 **/\r
 typedef\r
 VOID\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_IO_WRITE8)(\r

-  IN  EFI_PEI_SERVICES        **PeiServices,\r
-  IN  EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                  Address,\r
-  IN  UINT8                   Data\r
+  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
+  IN  UINT64                        Address,\r
+  IN  UINT8                         Data\r

   );\r
 \r
 /**\r
   );\r
 \r
 /**\r


@@ -184,16 +188,14 @@ VOID
   @param  Address        The physical address of the access.\r
   @param  Data           The data to write.\r
 \r
   @param  Address        The physical address of the access.\r
   @param  Data           The data to write.\r
 \r

-  @return None\r
-\r

 **/\r
 typedef\r
 VOID\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_IO_WRITE16)(\r
 **/\r
 typedef\r
 VOID\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_IO_WRITE16)(\r

-  IN  EFI_PEI_SERVICES        **PeiServices,\r
-  IN  EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                  Address,\r
-  IN  UINT16                  Data\r
+  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
+  IN  UINT64                        Address,\r
+  IN  UINT16                        Data\r

   );\r
 \r
 /**\r
   );\r
 \r
 /**\r


@@ -204,16 +206,14 @@ VOID
   @param  Address        The physical address of the access.\r
   @param  Data           The data to write.\r
 \r
   @param  Address        The physical address of the access.\r
   @param  Data           The data to write.\r
 \r

-  @return None\r
-\r

 **/\r
 typedef\r
 VOID\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_IO_WRITE32)(\r
 **/\r
 typedef\r
 VOID\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_IO_WRITE32)(\r

-  IN  EFI_PEI_SERVICES        **PeiServices,\r
-  IN  EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                  Address,\r
-  IN  UINT32                  Data\r
+  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
+  IN  UINT64                        Address,\r
+  IN  UINT32                        Data\r

   );\r
 \r
 /**\r
   );\r
 \r
 /**\r


@@ -224,248 +224,236 @@ VOID
   @param  Address        The physical address of the access.\r
   @param  Data           The data to write.\r
 \r
   @param  Address        The physical address of the access.\r
   @param  Data           The data to write.\r
 \r

-  @return None\r
-\r

 **/\r
 typedef\r
 VOID\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_IO_WRITE64)(\r
 **/\r
 typedef\r
 VOID\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_IO_WRITE64)(\r

-  IN  EFI_PEI_SERVICES        **PeiServices,\r
-  IN  EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                  Address,\r
-  IN  UINT64                  Data\r
+  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
+  IN  UINT64                        Address,\r
+  IN  UINT64                        Data\r

   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  8-bit Memory read operations.\r
+  8-bit memory read operations.\r

 \r
   @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r
 \r
   @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r

-  @return UINT8          An 8-bit value is returned from the memory space.\r
+  @return An 8-bit value returned from the memory space.\r

 \r
 **/\r
 typedef\r
 UINT8\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_READ8)(\r
 \r
 **/\r
 typedef\r
 UINT8\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_READ8)(\r

-  IN  EFI_PEI_SERVICES        **PeiServices,\r
-  IN  EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                  Address\r
+  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
+  IN  UINT64                        Address\r

   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  16-bit Memory read operations.\r
+  16-bit memory read operations.\r

 \r
   @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r
 \r
   @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r

-  @return UINT16         A 16-bit value is returned from the memory space.\r
+  @return A 16-bit value returned from the memory space.\r

 \r
 **/\r
 typedef\r
 UINT16\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_READ16)(\r
 \r
 **/\r
 typedef\r
 UINT16\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_READ16)(\r

-  IN  EFI_PEI_SERVICES        **PeiServices,\r
-  IN  EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                  Address\r
+  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
+  IN  UINT64                        Address\r

   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  32-bit Memory read operations.\r
+  32-bit memory read operations.\r

 \r
   @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r
 \r
   @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r

-  @return UINT32         A 32-bit value is returned from the memory space.\r
+  @return A 32-bit value returned from the memory space.\r

 \r
 **/\r
 typedef\r
 UINT32\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_READ32)(\r
 \r
 **/\r
 typedef\r
 UINT32\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_READ32)(\r

-  IN  EFI_PEI_SERVICES        **PeiServices,\r
-  IN  EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                  Address\r
+  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
+  IN  UINT64                        Address\r

   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  64-bit Memory read operations.\r
+  64-bit memory read operations.\r

 \r
   @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r
 \r
   @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
 \r

-  @return UINT64         A 64-bit value is returned from the memory space.\r
+  @return A 64-bit value returned from the memory space.\r

 \r
 **/\r
 typedef\r
 UINT64\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_READ64)(\r
 \r
 **/\r
 typedef\r
 UINT64\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_READ64)(\r

-  IN  EFI_PEI_SERVICES        **PeiServices,\r
-  IN  EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                  Address\r
+  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
+  IN  UINT64                        Address\r

   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  8-bit Memory write operations.\r
+  8-bit memory write operations.\r

 \r
   @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
   @param  Data           The data to write.\r
 \r
 \r
   @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
   @param  Data           The data to write.\r
 \r

-  @return None\r
-\r

 **/\r
 typedef\r
 VOID\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_WRITE8)(\r
 **/\r
 typedef\r
 VOID\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_WRITE8)(\r

-  IN  EFI_PEI_SERVICES        **PeiServices,\r
-  IN  EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                  Address,\r
-  IN  UINT8                   Data\r
+  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
+  IN  UINT64                        Address,\r
+  IN  UINT8                         Data\r

   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  16-bit Memory write operations.\r
+  16-bit memory write operations.\r

 \r
   @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
   @param  Data           The data to write.\r
 \r
 \r
   @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
   @param  Data           The data to write.\r
 \r

-  @return None\r
-\r

 **/\r
 typedef\r
 VOID\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_WRITE16)(\r
 **/\r
 typedef\r
 VOID\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_WRITE16)(\r

-  IN  EFI_PEI_SERVICES        **PeiServices,\r
-  IN  EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                  Address,\r
-  IN  UINT16                  Data\r
+  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
+  IN  UINT64                        Address,\r
+  IN  UINT16                        Data\r

   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  32-bit Memory write operations.\r
+  32-bit memory write operations.\r

 \r
   @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
   @param  Data           The data to write.\r
 \r
 \r
   @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
   @param  Data           The data to write.\r
 \r

-  @return None\r
-\r

 **/\r
 typedef\r
 VOID\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_WRITE32)(\r
 **/\r
 typedef\r
 VOID\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_WRITE32)(\r

-  IN  EFI_PEI_SERVICES        **PeiServices,\r
-  IN  EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                  Address,\r
-  IN  UINT32                  Data\r
+  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
+  IN  UINT64                        Address,\r
+  IN  UINT32                        Data\r

   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  64-bit Memory write operations.\r
+  64-bit memory write operations.\r

 \r
   @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
   @param  Data           The data to write.\r
 \r
 \r
   @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
   @param  This           Pointer to local data for the interface.\r
   @param  Address        The physical address of the access.\r
   @param  Data           The data to write.\r
 \r

-  @return None\r
-\r

 **/\r
 typedef\r
 VOID\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_WRITE64)(\r
 **/\r
 typedef\r
 VOID\r
 (EFIAPI *EFI_PEI_CPU_IO_PPI_MEM_WRITE64)(\r

-  IN  EFI_PEI_SERVICES        **PeiServices,\r
-  IN  EFI_PEI_CPU_IO_PPI      *This,\r
-  IN  UINT64                  Address,\r
-  IN  UINT64                  Data\r
+  IN  CONST EFI_PEI_SERVICES        **PeiServices,\r
+  IN  CONST EFI_PEI_CPU_IO_PPI      *This,\r
+  IN  UINT64                        Address,\r
+  IN  UINT64                        Data\r

   );\r
 \r
   );\r
 \r

-/**\r
-  @par Ppi Description:\r
-  EFI_PEI_CPU_IO_PPI provides a set of memory and I/O-based services.\r
-  The perspective of the services is that of the processor, not the bus or system.\r
-\r
-  @param Mem\r
-  Collection of memory-access services.\r
-\r
-  @param I/O\r
-  Collection of I/O-access services.\r
-\r
-  @param IoRead8\r
-  8-bit read service.\r
-\r
-  @param IoRead16\r
-  16-bit read service.\r
-\r
-  @param IoRead32\r
-  32-bit read service.\r
-\r
-  @param IoRead64\r
-  64-bit read service.\r
-\r
-  @param IoWrite8\r
-  8-bit write service.\r
-\r
-  @param IoWrite16\r
-  16-bit write service.\r
-\r
-  @param IoWrite32\r
-  32-bit write service.\r
-\r
-  @param IoWrite64\r
-  64-bit write service.\r
-\r
-  @param MemRead8\r
-  8-bit read service.\r
-\r
-  @param MemRead16\r
-  16-bit read service.\r
-\r
-  @param MemRead32\r
-  32-bit read service.\r
-\r
-  @param MemRead64\r
-  64-bit read service.\r
-\r
-  @param MemWrite8\r
-  8-bit write service.\r
-\r
-  @param MemWrite16\r
-  16-bit write service.\r
-\r
-  @param MemWrite32\r
-  32-bit write service.\r
-\r
-  @param MemWrite64\r
-  64-bit write service.\r
-\r
-**/\r
+///\r
+/// EFI_PEI_CPU_IO_PPI provides a set of memory and I/O-based services.\r
+/// The perspective of the services is that of the processor, not the bus or system.\r
+///\r

 struct _EFI_PEI_CPU_IO_PPI {\r
 struct _EFI_PEI_CPU_IO_PPI {\r

+  ///\r
+  /// Collection of memory-access services.\r
+  ///\r

   EFI_PEI_CPU_IO_PPI_ACCESS       Mem;\r
   EFI_PEI_CPU_IO_PPI_ACCESS       Mem;\r

+  ///\r
+  /// Collection of I/O-access services.\r
+  ///\r

   EFI_PEI_CPU_IO_PPI_ACCESS       Io;\r
   EFI_PEI_CPU_IO_PPI_ACCESS       Io;\r

+  ///\r
+  /// 8-bit I/O read service.\r
+  ///\r

   EFI_PEI_CPU_IO_PPI_IO_READ8     IoRead8;\r
   EFI_PEI_CPU_IO_PPI_IO_READ8     IoRead8;\r

+  ///\r
+  /// 16-bit I/O read service.\r
+  ///\r

   EFI_PEI_CPU_IO_PPI_IO_READ16    IoRead16;\r
   EFI_PEI_CPU_IO_PPI_IO_READ16    IoRead16;\r

+  ///\r
+  /// 32-bit I/O read service.\r
+  ///\r

   EFI_PEI_CPU_IO_PPI_IO_READ32    IoRead32;\r
   EFI_PEI_CPU_IO_PPI_IO_READ32    IoRead32;\r

+  ///\r
+  /// 64-bit I/O read service.\r
+  ///\r

   EFI_PEI_CPU_IO_PPI_IO_READ64    IoRead64;\r
   EFI_PEI_CPU_IO_PPI_IO_READ64    IoRead64;\r

+  ///\r
+  /// 8-bit I/O write service.\r
+  ///\r

   EFI_PEI_CPU_IO_PPI_IO_WRITE8    IoWrite8;\r
   EFI_PEI_CPU_IO_PPI_IO_WRITE8    IoWrite8;\r

+  ///\r
+  /// 16-bit I/O write service.\r
+  ///\r

   EFI_PEI_CPU_IO_PPI_IO_WRITE16   IoWrite16;\r
   EFI_PEI_CPU_IO_PPI_IO_WRITE16   IoWrite16;\r

+  ///\r
+  /// 32-bit I/O write service.\r
+  ///\r

   EFI_PEI_CPU_IO_PPI_IO_WRITE32   IoWrite32;\r
   EFI_PEI_CPU_IO_PPI_IO_WRITE32   IoWrite32;\r

+  ///\r
+  /// 64-bit I/O write service.\r
+  ///\r

   EFI_PEI_CPU_IO_PPI_IO_WRITE64   IoWrite64;\r
   EFI_PEI_CPU_IO_PPI_IO_WRITE64   IoWrite64;\r

+  ///\r
+  /// 8-bit memory read service.\r
+  ///\r

   EFI_PEI_CPU_IO_PPI_MEM_READ8    MemRead8;\r
   EFI_PEI_CPU_IO_PPI_MEM_READ8    MemRead8;\r

+  ///\r
+  /// 16-bit memory read service.\r
+  ///\r

   EFI_PEI_CPU_IO_PPI_MEM_READ16   MemRead16;\r
   EFI_PEI_CPU_IO_PPI_MEM_READ16   MemRead16;\r

+  ///\r
+  /// 32-bit memory read service.\r
+  ///\r

   EFI_PEI_CPU_IO_PPI_MEM_READ32   MemRead32;\r
   EFI_PEI_CPU_IO_PPI_MEM_READ32   MemRead32;\r

+  ///\r
+  /// 64-bit memory read service.\r
+  ///\r

   EFI_PEI_CPU_IO_PPI_MEM_READ64   MemRead64;\r
   EFI_PEI_CPU_IO_PPI_MEM_READ64   MemRead64;\r

+  ///\r
+  /// 8-bit memory write service.\r
+  ///\r

   EFI_PEI_CPU_IO_PPI_MEM_WRITE8   MemWrite8;\r
   EFI_PEI_CPU_IO_PPI_MEM_WRITE8   MemWrite8;\r

+  ///\r
+  /// 16-bit memory write service.\r
+  ///\r

   EFI_PEI_CPU_IO_PPI_MEM_WRITE16  MemWrite16;\r
   EFI_PEI_CPU_IO_PPI_MEM_WRITE16  MemWrite16;\r

+  ///\r
+  /// 32-bit memory write service.\r
+  ///\r

   EFI_PEI_CPU_IO_PPI_MEM_WRITE32  MemWrite32;\r
   EFI_PEI_CPU_IO_PPI_MEM_WRITE32  MemWrite32;\r

+  ///\r
+  /// 64-bit memory write service.\r
+  ///\r

   EFI_PEI_CPU_IO_PPI_MEM_WRITE64  MemWrite64;\r
 };\r
 \r
   EFI_PEI_CPU_IO_PPI_MEM_WRITE64  MemWrite64;\r
 };\r
 \r

diff --git a/MdePkg/Include/Ppi/Decompress.h b/MdePkg/Include/Ppi/Decompress.h
index 5cbfd8be4ea39def7e4cb98919ee516c9789103a..074b057928a1934cc2420dd82533280bd876b925 100644 (file)
--- a/MdePkg/Include/Ppi/Decompress.h
+++ b/MdePkg/Include/Ppi/Decompress.h
@@ -30,48 +30,44 @@ typedef struct _EFI_PEI_DECOMPRESS_PPI  EFI_PEI_DECOMPRESS_PPI;
   as a series of standard PI Firmware File Sections. The\r
   required memory is allocated from permanent memory.\r
 \r
   as a series of standard PI Firmware File Sections. The\r
   required memory is allocated from permanent memory.\r
 \r

-  @param This         Points to this instance of the\r
-                      EFI_PEI_DECOMPRESS_PEI PPI. InputSection Points to\r
-                      the compressed section.\r
-\r
-  @param OutputBuffer Holds the returned pointer to the\r
-                      decompressed sections.\r
-\r
-  @param OutputSize   Holds the returned size of the decompress\r
-                      section streams.\r
+  @param This                   Points to this instance of the\r
+                                EFI_PEI_DECOMPRESS_PEI PPI.\r
+  @param InputSection           Points to the compressed section.\r
+  @param OutputBuffer           Holds the returned pointer to the\r
+                                decompressed sections.\r
+  @param OutputSize             Holds the returned size of the decompress\r
+                                section streams.\r

 \r
   @retval EFI_SUCCESS           The section was decompressed\r
                                 successfully. OutputBuffer contains the\r
                                 resulting data and OutputSize contains\r
                                 the resulting size.\r
 \r
   @retval EFI_SUCCESS           The section was decompressed\r
                                 successfully. OutputBuffer contains the\r
                                 resulting data and OutputSize contains\r
                                 the resulting size.\r

-\r

   @retval EFI_OUT_OF_RESOURCES  Unable to allocate sufficient\r
                                 memory to hold the decompressed data.\r
   @retval EFI_OUT_OF_RESOURCES  Unable to allocate sufficient\r
                                 memory to hold the decompressed data.\r

-\r

   @retval EFI_UNSUPPORTED       The compression type specified\r
                                 in the compression header is unsupported.\r
   @retval EFI_UNSUPPORTED       The compression type specified\r
                                 in the compression header is unsupported.\r

+\r

 **/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_PEI_DECOMPRESS_DECOMPRESS)(\r
 **/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_PEI_DECOMPRESS_DECOMPRESS)(\r

-  IN CONST  EFI_PEI_DECOMPRESS_PPI  *This,\r
-  IN CONST  EFI_COMPRESSION_SECTION *InputSection,\r
-  OUT       VOID                    **OutputBuffer,\r
-  OUT       UINTN                   *OutputSize\r
+  IN  CONST EFI_PEI_DECOMPRESS_PPI  *This,\r
+  IN  CONST EFI_COMPRESSION_SECTION *InputSection,\r
+  OUT VOID                           **OutputBuffer,\r
+  OUT UINTN                          *OutputSize\r

 );\r
 \r
 \r
 );\r
 \r
 \r

-/**\r
-  @par Ppi Description:                                                              \r
-  This PPI's single member function decompresses a compression\r
-  encapsulated section. It is used by the PEI Foundation to\r
-  process sectioned files. Prior to the installation of this PPI,\r
-  compression sections will be ignored.\r
-\r
-  @param  Decompress  Decompress a single compression section in\r
-                      a firmware file.\r
-**/\r
+///\r
+/// This PPI's single member function decompresses a compression\r
+/// encapsulated section. It is used by the PEI Foundation to\r
+/// process sectioned files. Prior to the installation of this PPI,\r
+/// compression sections will be ignored.\r
+///\r

 struct _EFI_PEI_DECOMPRESS_PPI {\r
 struct _EFI_PEI_DECOMPRESS_PPI {\r

+  ///\r
+  /// Decompress a single compression section in a firmware file.\r
+  ///\r

   EFI_PEI_DECOMPRESS_DECOMPRESS Decompress;\r
 };\r
 \r
   EFI_PEI_DECOMPRESS_DECOMPRESS Decompress;\r
 };\r
 \r

diff --git a/MdePkg/Include/Ppi/DxeIpl.h b/MdePkg/Include/Ppi/DxeIpl.h
index 29c4df51b9d829d7dda5b6c8d706819d4b9c5541..1ea629a0119eadacb1be3d41cb73b6d0a33355ea 100644 (file)
--- a/MdePkg/Include/Ppi/DxeIpl.h
+++ b/MdePkg/Include/Ppi/DxeIpl.h
@@ -31,6 +31,17 @@ typedef struct _EFI_DXE_IPL_PPI EFI_DXE_IPL_PPI;
   The architectural PPI that the PEI Foundation invokes when \r
   there are no additional PEIMs to invoke.\r
 \r
   The architectural PPI that the PEI Foundation invokes when \r
   there are no additional PEIMs to invoke.\r
 \r

+  This function is invoked by the PEI Foundation.\r
+  The PEI Foundation will invoke this service when there are\r
+  no additional PEIMs to invoke in the system.\r
+  If this PPI does not exist, it is an error condition and\r
+  an ill-formed firmware set. The DXE IPL PPI should never\r
+  return after having been invoked by the PEI Foundation.\r
+  The DXE IPL PPI can do many things internally, including the following:\r
+    - Invoke the DXE entry point from a firmware volume\r
+    - Invoke the recovery processing modules\r
+    - Invoke the S3 resume modules\r
+\r

   @param  This           Pointer to the DXE IPL PPI instance\r
   @param  PeiServices    Pointer to the PEI Services Table.\r
   @param  HobList        Pointer to the list of Hand-Off Block (HOB) entries.\r
   @param  This           Pointer to the DXE IPL PPI instance\r
   @param  PeiServices    Pointer to the PEI Services Table.\r
   @param  HobList        Pointer to the list of Hand-Off Block (HOB) entries.\r


@@ -43,22 +54,20 @@ typedef struct _EFI_DXE_IPL_PPI EFI_DXE_IPL_PPI;
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_DXE_IPL_ENTRY)(\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_DXE_IPL_ENTRY)(\r

-  IN EFI_DXE_IPL_PPI              *This,\r
+  IN CONST EFI_DXE_IPL_PPI        *This,\r

   IN EFI_PEI_SERVICES             **PeiServices,\r
   IN EFI_PEI_HOB_POINTERS         HobList\r
   );\r
 \r
   IN EFI_PEI_SERVICES             **PeiServices,\r
   IN EFI_PEI_HOB_POINTERS         HobList\r
   );\r
 \r

-/**\r
-  @par Ppi Description:\r
-  Final service to be invoked by the PEI Foundation.\r
-  The DXE IPL PPI is responsible for locating and loading the DXE Foundation.\r
-  The DXE IPL PPI may use PEI services to locate and load the DXE Foundation.\r
-\r
-  @param Entry\r
-  The entry point to the DXE IPL PPI.\r
-\r
-**/\r
+///\r
+/// Final service to be invoked by the PEI Foundation.\r
+/// The DXE IPL PPI is responsible for locating and loading the DXE Foundation.\r
+/// The DXE IPL PPI may use PEI services to locate and load the DXE Foundation.\r
+///\r

 struct _EFI_DXE_IPL_PPI {\r
 struct _EFI_DXE_IPL_PPI {\r

+  ///\r
+  /// The entry point to the DXE IPL PPI.\r
+  ///\r

   EFI_DXE_IPL_ENTRY Entry;\r
 };\r
 \r
   EFI_DXE_IPL_ENTRY Entry;\r
 };\r
 \r

diff --git a/MdePkg/Include/Ppi/EndOfPeiPhase.h b/MdePkg/Include/Ppi/EndOfPeiPhase.h
index a5a89b4bb41d8a509c14dd695d6e474ae3ad89e9..e12e5c4a48e9849cbca5e63b97c2a24eac9c056a 100644 (file)
--- a/MdePkg/Include/Ppi/EndOfPeiPhase.h
+++ b/MdePkg/Include/Ppi/EndOfPeiPhase.h
@@ -19,8 +19,8 @@
 \r
 **/\r
 \r
 \r
 **/\r
 \r

-#ifndef __END_OF_PEI_SIGNAL_PPI_H__\r
-#define __END_OF_PEI_SIGNAL_PPI_H__\r
+#ifndef __END_OF_PEI_PHASE_PPI_H__\r
+#define __END_OF_PEI_PHASE_PPI_H__\r

 \r
 #define EFI_PEI_END_OF_PEI_PHASE_PPI_GUID \\r
   { \\r
 \r
 #define EFI_PEI_END_OF_PEI_PHASE_PPI_GUID \\r
   { \\r

diff --git a/MdePkg/Include/Ppi/FirmwareVolume.h b/MdePkg/Include/Ppi/FirmwareVolume.h
index 1bc96796abef01eb8c83ee8ffef844aabd0790a1..4cb22649d28436a9f9cd8946d5552ccaae4268e9 100644 (file)
--- a/MdePkg/Include/Ppi/FirmwareVolume.h
+++ b/MdePkg/Include/Ppi/FirmwareVolume.h
@@ -21,10 +21,9 @@
 \r
 ///\r
 /// The GUID for this PPI is the same as the firmware volume format GUID.\r
 \r
 ///\r
 /// The GUID for this PPI is the same as the firmware volume format GUID.\r

-/// can be EFI_FIRMWARE_FILE_SYSTEM2_GUID or the GUID for a user-defined format. The\r
-/// EFI_FIRMWARE_FILE_SYSTEM2_GUID is the PI Firmware Volume format.\r
+/// The FV format can be EFI_FIRMWARE_FILE_SYSTEM2_GUID or the GUID for a user-defined\r
+/// format. The EFI_FIRMWARE_FILE_SYSTEM2_GUID is the PI Firmware Volume format.\r

 /// \r
 /// \r

-\r

 typedef struct _EFI_PEI_FIRMWARE_VOLUME_PPI   EFI_PEI_FIRMWARE_VOLUME_PPI;\r
 \r
 \r
 typedef struct _EFI_PEI_FIRMWARE_VOLUME_PPI   EFI_PEI_FIRMWARE_VOLUME_PPI;\r
 \r
 \r


@@ -40,26 +39,25 @@ typedef struct _EFI_PEI_FIRMWARE_VOLUME_PPI   EFI_PEI_FIRMWARE_VOLUME_PPI;
   from the EFI_FIRMWARE_VOLUME_INFO_PPI.\r
   \r
   \r
   from the EFI_FIRMWARE_VOLUME_INFO_PPI.\r
   \r
   \r

-  @param This         Points to this instance of the\r
-                      EFI_PEI_FIRMWARE_VOLUME_PPI\r
-  @param Buffer       Points to the start of the buffer.\r
-  @param BufferSize   Size of the buffer.\r
-  @param FvHandle     Points to the returned firmware volume\r
-                      handle. The firmware volume handle must\r
-                      be unique within the system. \r
-\r
+  @param This                   Points to this instance of the\r
+                                EFI_PEI_FIRMWARE_VOLUME_PPI.\r
+  @param Buffer                 Points to the start of the buffer.\r
+  @param BufferSize             Size of the buffer.\r
+  @param FvHandle               Points to the returned firmware volume\r
+                                handle. The firmware volume handle must\r
+                                be unique within the system. \r

 \r
 \r

-  @retval EFI_SUCCESS           Firmware volume handle.\r
+  @retval EFI_SUCCESS           Firmware volume handle created.\r

   @retval EFI_VOLUME_CORRUPTED  Volume was corrupt.\r
 \r
 **/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_PEI_FV_PROCESS_FV)(\r
   @retval EFI_VOLUME_CORRUPTED  Volume was corrupt.\r
 \r
 **/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_PEI_FV_PROCESS_FV)(\r

-  IN CONST  EFI_PEI_FIRMWARE_VOLUME_PPI *This,\r
-  IN CONST  VOID                        *Buffer,\r
-  IN CONST  UINTN                       BufferSize,\r
-  OUT       EFI_PEI_FV_HANDLE           *FvHandle\r
+  IN  CONST  EFI_PEI_FIRMWARE_VOLUME_PPI *This,\r
+  IN  VOID                               *Buffer,\r
+  IN  UINTN                              BufferSize,\r
+  OUT EFI_PEI_FV_HANDLE                  *FvHandle\r

 );\r
 \r
 /**\r
 );\r
 \r
 /**\r


@@ -68,29 +66,29 @@ EFI_STATUS
   This service enables PEI modules to discover additional firmware files. \r
   The FileHandle must be unique within the system.\r
 \r
   This service enables PEI modules to discover additional firmware files. \r
   The FileHandle must be unique within the system.\r
 \r

-  @param This       Points to this instance of the\r
-                    EFI_PEI_FIRMWARE_VOLUME_PPI. SearchType A filter\r
-                    to find only files of this type. Type\r
-                    EFI_FV_FILETYPE_ALL causes no filtering to be\r
-                    done.\r
-  @param FvHandle   Handle of firmware volume in which to\r
-                    search.\r
-\r
-  @param FileHandle Points to the current handle from which to\r
-                    begin searching or NULL to start at the\r
-                    beginning of the firmware volume. Updated\r
-                    upon return to reflect the file found.\r
-\r
+  @param This           Points to this instance of the\r
+                        EFI_PEI_FIRMWARE_VOLUME_PPI.\r
+  @param SearchType     A filter to find only files of this type. Type\r
+                        EFI_FV_FILETYPE_ALL causes no filtering to be\r
+                        done.\r
+  @param FvHandle       Handle of firmware volume in which to\r
+                        search.\r
+  @param FileHandle     Points to the current handle from which to\r
+                        begin searching or NULL to start at the\r
+                        beginning of the firmware volume. Updated\r
+                        upon return to reflect the file found.\r

 \r
   @retval EFI_SUCCESS   The file was found.\r
   @retval EFI_NOT_FOUND The file was not found. FileHandle contains NULL.\r
 \r
   @retval EFI_SUCCESS   The file was found.\r
   @retval EFI_NOT_FOUND The file was not found. FileHandle contains NULL.\r

+\r

 **/ \r
 **/ \r

-typedef EFI_STATUS\r
+typedef\r
+EFI_STATUS\r

 (EFIAPI *EFI_PEI_FV_FIND_FILE_TYPE)( \r
 (EFIAPI *EFI_PEI_FV_FIND_FILE_TYPE)( \r

-  IN CONST  EFI_PEI_FIRMWARE_VOLUME_PPI   *This, \r
-  IN CONST  EFI_FV_FILETYPE               SearchType, \r
-  IN CONST  EFI_PEI_FV_HANDLE             FvHandle,\r
-  IN OUT EFI_PEI_FILE_HANDLE              *FileHandle \r
+  IN     CONST EFI_PEI_FIRMWARE_VOLUME_PPI   *This, \r
+  IN     EFI_FV_FILETYPE                     SearchType, \r
+  IN     EFI_PEI_FV_HANDLE                   FvHandle,\r
+  IN OUT EFI_PEI_FILE_HANDLE                 *FileHandle \r

 );\r
 \r
 \r
 );\r
 \r
 \r


@@ -100,26 +98,21 @@ typedef EFI_STATUS
   This service searches for files with a specific name, within\r
   either the specified firmware volume or all firmware volumes.\r
 \r
   This service searches for files with a specific name, within\r
   either the specified firmware volume or all firmware volumes.\r
 \r

-  @param This   Points to this instance of the\r
-                EFI_PEI_FIRMWARE_VOLUME_PPI.\r
-\r
-  @param FileName   A pointer to the name of the file to find\r
-                    within the firmware volume.\r
-\r
-  @param FvHandle   Upon entry, the pointer to the firmware\r
-                    volume to search or NULL if all firmware\r
-                    volumes should be searched. Upon exit, the\r
-                    actual firmware volume in which the file was\r
-                    found.\r
-\r
-  @param FileHandle   Upon exit, points to the found file's\r
-                      handle or NULL if it could not be found.\r
-\r
-  @retval EFI_SUCCESS   File was found.\r
-\r
-  @param EFI_NOT_FOUND  File was not found.\r
-\r
-  @param EFI_INVALID_PARAMETER  FvHandle or FileHandle or\r
+  @param This                   Points to this instance of the\r
+                                EFI_PEI_FIRMWARE_VOLUME_PPI.\r
+  @param FileName               A pointer to the name of the file to find\r
+                                within the firmware volume.\r
+  @param FvHandle               Upon entry, the pointer to the firmware\r
+                                volume to search or NULL if all firmware\r
+                                volumes should be searched. Upon exit, the\r
+                                actual firmware volume in which the file was\r
+                                found.\r
+  @param FileHandle             Upon exit, points to the found file's\r
+                                handle or NULL if it could not be found.\r
+\r
+  @retval EFI_SUCCESS           File was found.\r
+  @retval EFI_NOT_FOUND         File was not found.\r
+  @retval EFI_INVALID_PARAMETER FvHandle or FileHandle or\r

                                 FileName was NULL.\r
 \r
 \r
                                 FileName was NULL.\r
 \r
 \r


@@ -127,10 +120,10 @@ typedef EFI_STATUS
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_PEI_FV_FIND_FILE_NAME)(\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_PEI_FV_FIND_FILE_NAME)(\r

-  IN CONST  EFI_PEI_FIRMWARE_VOLUME_PPI *This,\r
-  IN CONST  EFI_GUID                    *FileName,\r
-  IN CONST  EFI_PEI_FV_HANDLE           FvHandle,\r
-  OUT       EFI_PEI_FILE_HANDLE         *FileHandle\r
+  IN  CONST  EFI_PEI_FIRMWARE_VOLUME_PPI *This,\r
+  IN  CONST  EFI_GUID                    *FileName,\r
+  IN  EFI_PEI_FV_HANDLE                  FvHandle,\r
+  OUT EFI_PEI_FILE_HANDLE                *FileHandle\r

 );\r
 \r
 \r
 );\r
 \r
 \r


@@ -141,109 +134,105 @@ EFI_STATUS
   file, including its file name, type, attributes, starting\r
   address and size. \r
    \r
   file, including its file name, type, attributes, starting\r
   address and size. \r
    \r

-  @param This       Points to this instance of the\r
-                    EFI_PEI_FIRMWARE_VOLUME_PPI.\r
-\r
-  @param FileHandle Handle of the file.\r
-\r
-  @param FileInfo   Upon exit, points to the file????s\r
-                    information.\r
+  @param This                     Points to this instance of the\r
+                                  EFI_PEI_FIRMWARE_VOLUME_PPI.\r
+  @param FileHandle               Handle of the file.\r
+  @param FileInfo                 Upon exit, points to the file's\r
+                                  information.\r

 \r
   @retval EFI_SUCCESS             File information returned.\r
 \r
   @retval EFI_SUCCESS             File information returned.\r

-  \r

   @retval EFI_INVALID_PARAMETER   If FileHandle does not\r
                                   represent a valid file.\r
   @retval EFI_INVALID_PARAMETER   If FileHandle does not\r
                                   represent a valid file.\r

-                                  EFI_INVALID_PARAMETER If\r
-                                  FileInfo is NULL\r
+  @retval EFI_INVALID_PARAMETER   If FileInfo is NULL.\r

   \r
 **/ \r
   \r
 **/ \r

-\r

 typedef\r
 typedef\r

-EFI_STATUS (EFIAPI *EFI_PEI_FV_GET_FILE_INFO)(\r
+EFI_STATUS\r
+(EFIAPI *EFI_PEI_FV_GET_FILE_INFO)(\r

   IN  CONST EFI_PEI_FIRMWARE_VOLUME_PPI   *This, \r
   IN  CONST EFI_PEI_FIRMWARE_VOLUME_PPI   *This, \r

-  IN  CONST EFI_PEI_FILE_HANDLE           FileHandle, \r
-  OUT       EFI_FV_FILE_INFO              *FileInfo\r
+  IN  EFI_PEI_FILE_HANDLE                 FileHandle, \r
+  OUT EFI_FV_FILE_INFO                    *FileInfo\r

 );\r
 \r
 /**\r
 );\r
 \r
 /**\r

-  This function returns information about the firmware\r
-  volume.\r
-  \r
-  @param This       Points to this instance of the\r
-                    EFI_PEI_FIRMWARE_VOLUME_PPI.\r
+  This function returns information about the firmware volume.\r

   \r
   \r

-  @param FvHandle   Handle to the firmware handle.\r
-  \r
-  @param VolumeInfo Points to the returned firmware volume\r
-                    information.\r
-  \r
-  \r
-  @retval EFI_SUCCESS             Information returned\r
-                                  successfully.\r
-  \r
-  @retval EFI_INVALID_PARAMETER   FvHandle does not indicate a\r
-                                  valid firmware volume or VolumeInfo is NULL\r
+  @param This                     Points to this instance of the\r
+                                  EFI_PEI_FIRMWARE_VOLUME_PPI.\r
+  @param FvHandle                 Handle to the firmware handle.\r
+  @param VolumeInfo               Points to the returned firmware volume\r
+                                  information.\r
+\r
+  @retval EFI_SUCCESS             Information returned successfully.\r
+  @retval EFI_INVALID_PARAMETER   FvHandle does not indicate a valid\r
+                                  firmware volume or VolumeInfo is NULL.\r
+\r

 **/ \r
 typedef\r
 **/ \r
 typedef\r

-EFI_STATUS (EFIAPI *EFI_PEI_FV_GET_INFO)(\r
-  IN CONST  EFI_PEI_FIRMWARE_VOLUME_PPI   *This, \r
-  IN CONST  EFI_PEI_FV_HANDLE             FvHandle, \r
-  OUT       EFI_FV_INFO                   *VolumeInfo\r
+EFI_STATUS\r
+(EFIAPI *EFI_PEI_FV_GET_INFO)(\r
+  IN  CONST  EFI_PEI_FIRMWARE_VOLUME_PPI   *This, \r
+  IN  EFI_PEI_FV_HANDLE                    FvHandle, \r
+  OUT EFI_FV_INFO                          *VolumeInfo\r

 );\r
 \r
 /**\r
   Find the next matching section in the firmware file.\r
   \r
 );\r
 \r
 /**\r
   Find the next matching section in the firmware file.\r
   \r

-  This service enables PEI modules to discover sections of a given type within a valid file.\r
-  \r
-  @param This   Points to this instance of the\r
-                EFI_PEI_FIRMWARE_VOLUME_PPI.\r
-  \r
-  @param SearchType   A filter to find only sections of this\r
-                      type.\r
+  This service enables PEI modules to discover sections\r
+  of a given type within a valid file.\r

   \r
   \r

-  @param FileHandle   Handle of firmware file in which to\r
-                      search.\r
-  \r
-  @param SectionData  Updated upon  return to point to the\r
-                      section found.\r
+  @param This             Points to this instance of the\r
+                          EFI_PEI_FIRMWARE_VOLUME_PPI.\r
+  @param SearchType       A filter to find only sections of this\r
+                          type.\r
+  @param FileHandle       Handle of firmware file in which to\r
+                          search.\r
+  @param SectionData      Updated upon  return to point to the\r
+                          section found.\r

   \r
   @retval EFI_SUCCESS     Section was found.\r
   \r
   @retval EFI_SUCCESS     Section was found.\r

-  \r

   @retval EFI_NOT_FOUND   Section of the specified type was not\r
                           found. SectionData contains NULL.\r
 **/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_PEI_FV_FIND_SECTION)(\r
   @retval EFI_NOT_FOUND   Section of the specified type was not\r
                           found. SectionData contains NULL.\r
 **/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_PEI_FV_FIND_SECTION)(\r

-  IN CONST  EFI_PEI_FIRMWARE_VOLUME_PPI   *This,\r
-  IN CONST  EFI_SECTION_TYPE              SearchType,\r
-  IN CONST  EFI_PEI_FILE_HANDLE           FileHandle,\r
-  OUT       VOID                          **SectionData\r
+  IN  CONST EFI_PEI_FIRMWARE_VOLUME_PPI    *This,\r
+  IN  EFI_SECTION_TYPE                     SearchType,\r
+  IN  EFI_PEI_FILE_HANDLE                  FileHandle,\r
+  OUT VOID                                 **SectionData\r

 );\r
 \r
 );\r
 \r

-\r
-\r
-/*\r
-  @par Ppi Description:\r
-  This PPI provides functions for accessing a memory-mapped firmware volume of a specific format.\r
-\r
-  @param  ProcessVolume       Process a firmware volume and create a volume handle.\r
-  @param  FindFileByType      Find all files of a specific type.\r
-  @param  FindFileByName      Find the file with a specific name.\r
-  @param  GetFileInfo         Return the information about a specific file\r
-  @param  GetVolumeInfo       Return the firmware volume attributes.\r
-  @param  FindSectionByType   Find all sections of a specific type.\r
-\r
-**/\r
+///\r
+/// This PPI provides functions for accessing a memory-mapped firmware volume of a specific format.\r
+///\r

 struct _EFI_PEI_FIRMWARE_VOLUME_PPI {\r
 struct _EFI_PEI_FIRMWARE_VOLUME_PPI {\r

+  ///\r
+  /// Process a firmware volume and create a volume handle.\r
+  ///\r

   EFI_PEI_FV_PROCESS_FV       ProcessVolume;\r
   EFI_PEI_FV_PROCESS_FV       ProcessVolume;\r

+  ///\r
+  /// Find all files of a specific type.\r
+  ///\r

   EFI_PEI_FV_FIND_FILE_TYPE   FindFileByType;\r
   EFI_PEI_FV_FIND_FILE_TYPE   FindFileByType;\r

+  ///\r
+  /// Find the file with a specific name.\r
+  ///\r

   EFI_PEI_FV_FIND_FILE_NAME   FindFileByName;\r
   EFI_PEI_FV_FIND_FILE_NAME   FindFileByName;\r

+  ///\r
+  /// Return the information about a specific file.\r
+  ///\r

   EFI_PEI_FV_GET_FILE_INFO    GetFileInfo;\r
   EFI_PEI_FV_GET_FILE_INFO    GetFileInfo;\r

+  ///\r
+  /// Return the firmware volume attributes.\r
+  ///\r

   EFI_PEI_FV_GET_INFO         GetVolumeInfo;\r
   EFI_PEI_FV_GET_INFO         GetVolumeInfo;\r

+  ///\r
+  /// Find all sections of a specific type.\r
+  ///\r

   EFI_PEI_FV_FIND_SECTION     FindSectionByType;\r
   EFI_PEI_FV_FIND_SECTION     FindSectionByType;\r

-} ;\r
+};\r

 \r
 extern EFI_GUID gEfiPeiFirmwareVolumePpiGuid;\r
 \r
 \r
 extern EFI_GUID gEfiPeiFirmwareVolumePpiGuid;\r
 \r

diff --git a/MdePkg/Include/Ppi/FirmwareVolumeInfo.h b/MdePkg/Include/Ppi/FirmwareVolumeInfo.h
index 1a7487bce06007ec2172bc66e0ff4bc69217c089..338b60ace1b351b6cf387b2ac7cbe368f609e1b7 100644 (file)
--- a/MdePkg/Include/Ppi/FirmwareVolumeInfo.h
+++ b/MdePkg/Include/Ppi/FirmwareVolumeInfo.h
@@ -26,39 +26,40 @@
 \r
 typedef struct _EFI_PEI_FIRMWARE_VOLUME_INFO_PPI  EFI_PEI_FIRMWARE_VOLUME_INFO_PPI;\r
 \r
 \r
 typedef struct _EFI_PEI_FIRMWARE_VOLUME_INFO_PPI  EFI_PEI_FIRMWARE_VOLUME_INFO_PPI;\r
 \r

-/**\r
-  @par Ppi Description:\r
-  This PPI describes the location and format of a firmware volume. \r
-  The FvFormat can be EFI_FIRMWARE_FILE_SYSTEM2_GUID or the GUID for \r
-  a user-defined format. The  EFI_FIRMWARE_FILE_SYSTEM2_GUID is \r
-  the PI Firmware Volume format.\r
-\r
-  @param  FvFormat      Unique identifier of the format of the memory-mapped firmware volume.\r
-\r
-  @param  FvInfo        Points to a buffer which allows the EFI_PEI_FIRMWARE_VOLUME_PPI to\r
-                        process the volume. The format of this buffer is \r
-                        specific to the FvFormat. For memory-mapped firmware volumes, \r
-                        this typically points to the first byte of the firmware volume.\r
-\r
-  @param  FvInfoSize    Size of the data provided by FvInfo. For memory-mapped firmware volumes,\r
-                        this is typically the size of the firmware volume.\r
-\r
-  @param  ParentFvName  If the firmware volume originally came from a firmware file, \r
-                        then these point to the parent firmware volume\r
-                        name and firmware volume file. If it did not originally come\r
-                        from a firmware file, these should be NULL.\r
-\r
-  @param  ParentFileName  If the firmware volume originally came from a firmware file, \r
-                        then these point to the parent firmware volume\r
-                        name and firmware volume file. If it did not originally come\r
-                        from a firmware file, these should be NULL.\r
-\r
-**/\r
+///\r
+///  This PPI describes the location and format of a firmware volume. \r
+///  The FvFormat can be EFI_FIRMWARE_FILE_SYSTEM2_GUID or the GUID for \r
+///  a user-defined format. The  EFI_FIRMWARE_FILE_SYSTEM2_GUID is \r
+///  the PI Firmware Volume format.\r
+///\r

 struct _EFI_PEI_FIRMWARE_VOLUME_INFO_PPI {\r
 struct _EFI_PEI_FIRMWARE_VOLUME_INFO_PPI {\r

+  ///\r
+  /// Unique identifier of the format of the memory-mapped firmware volume.\r
+  ///\r

   EFI_GUID  FvFormat;\r
   EFI_GUID  FvFormat;\r

+  ///\r
+  /// Points to a buffer which allows the EFI_PEI_FIRMWARE_VOLUME_PPI to process\r
+  /// the volume. The format of this buffer is specific to the FvFormat.\r
+  /// For memory-mapped firmware volumes, this typically points to the first byte\r
+  /// of the firmware volume.\r
+  ///\r

   VOID      *FvInfo;\r
   VOID      *FvInfo;\r

+  ///\r
+  /// Size of the data provided by FvInfo. For memory-mapped firmware volumes,\r
+  /// this is typically the size of the firmware volume.\r
+  ///\r

   UINT32    FvInfoSize;\r
   UINT32    FvInfoSize;\r

+  ///\r
+  /// If the firmware volume originally came from a firmware file, then these\r
+  /// point to the parent firmware volume name and firmware volume file.\r
+  /// If it did not originally come from a firmware file, these should be NULL.\r
+  ///\r

   EFI_GUID  *ParentFvName;\r
   EFI_GUID  *ParentFvName;\r

+  ///\r
+  /// If the firmware volume originally came from a firmware file, then these\r
+  /// point to the parent firmware volume name and firmware volume file.\r
+  /// If it did not originally come from a firmware file, these should be NULL.\r
+  ///\r

   EFI_GUID  *ParentFileName;\r
 };\r
 \r
   EFI_GUID  *ParentFileName;\r
 };\r
 \r

diff --git a/MdePkg/Include/Ppi/GuidedSectionExtraction.h b/MdePkg/Include/Ppi/GuidedSectionExtraction.h
index 27f3e180738808ee15dd913b1dac9f8c44d4ec5f..b25bbf32535adf3f80d153f40f0bdfe6c25f58b1 100644 (file)
--- a/MdePkg/Include/Ppi/GuidedSectionExtraction.h
+++ b/MdePkg/Include/Ppi/GuidedSectionExtraction.h
@@ -51,75 +51,54 @@ typedef struct _EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI   EFI_PEI_GUIDED_SECTION_E
   section's contents. Otherwise, *Buffer must be allocated\r
   from PEI permanent memory.\r
 \r
   section's contents. Otherwise, *Buffer must be allocated\r
   from PEI permanent memory.\r
 \r

-  @param This                   Indicates the\r
-                                EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI instance.\r
-                                Buffer containing the input GUIDed section to be\r
-                                processed. OutputBuffer OutputBuffer is\r
-                                allocated from PEI permanent memory and contains\r
-                                the new section stream.\r
+  @param This                   Indicates the EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI\r
+                                instance.\r
+  @param InputSection           Buffer containing the input GUIDed section to be\r
+                                processed.\r
+  @param OutputBuffer           *OutputBuffer is allocated from PEI permanent memory\r
+                                and contains the new section stream.\r
+  @param OutputSize             A pointer to a caller-allocated UINTN in which\r
+                                the size of *OutputBuffer allocation is stored.\r
+                                If the function returns anything other than\r
+                                EFI_SUCCESS, the value of *OutputSize is undefined.\r
+  @param AuthenticationStatus   A pointer to a caller-allocated UINT32 that indicates\r
+                                the authentication status of the output buffer.\r
+                                If the input section's\r
+                                GuidedSectionHeader.Attributes field has the\r
+                                EFI_GUIDED_SECTION_AUTH_STATUS_VALID bit as clear,\r
+                                *AuthenticationStatus must return zero. These bits\r
+                                reflect the status of the extraction operation.\r
+                                If the function returns anything other than EFI_SUCCESS,\r
+                                the value of *AuthenticationStatus is undefined.\r

   \r
   \r

-  @param OutputSize             A pointer to a caller-allocated\r
-                                UINTN in which the size of *OutputBuffer\r
-                                allocation is stored. If the function\r
-                                returns anything other than EFI_SUCCESS,\r
-                                the value of OutputSize is undefined.\r
-  \r
-  @param AuthenticationStatus   A pointer to a caller-allocated\r
-                                UINT32 that indicates the\r
-                                authentication status of the\r
-                                output buffer. If the input\r
-                                section's GuidedSectionHeader.\r
-                                Attributes field has the\r
-                                EFI_GUIDED_SECTION_AUTH_STATUS_VALID \r
-                                bit as clear,\r
-                                AuthenticationStatus must return\r
-                                zero. These bits reflect the\r
-                                status of the extraction\r
-                                operation. If the function\r
-                                returns anything other than\r
-                                EFI_SUCCESS, the value of\r
-                                AuthenticationStatus is\r
-                                undefined.\r
-  \r
-  @retval EFI_SUCCESS           The InputSection was\r
-                                successfully processed and the\r
+  @retval EFI_SUCCESS           The InputSection was successfully processed and the\r

                                 section contents were returned.\r
                                 section contents were returned.\r

-  \r
-  @retval EFI_OUT_OF_RESOURCES  The system has insufficient\r
-                                resources to process the request.\r
-  \r
-  @retval EFI_INVALID_PARAMETER The GUID in InputSection does\r
-                                not match this instance of the\r
+  @retval EFI_OUT_OF_RESOURCES  The system has insufficient resources to process the request.\r
+  @retval EFI_INVALID_PARAMETER The GUID in InputSection does not match this instance of the\r

                                 GUIDed Section Extraction PPI.\r
 **/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_PEI_EXTRACT_GUIDED_SECTION)(\r
                                 GUIDed Section Extraction PPI.\r
 **/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_PEI_EXTRACT_GUIDED_SECTION)(\r

-  IN CONST  EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI *This,\r
-  IN CONST  VOID                                  *InputSection,\r
-  OUT       VOID                                  **OutputBuffer,\r
-  OUT       UINTN                                 *OutputSize,\r
-  OUT       UINT32                                *AuthenticationStatus\r
+  IN  CONST  EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI *This,\r
+  IN  CONST  VOID                                  *InputSection,\r
+  OUT VOID                                         **OutputBuffer,\r
+  OUT UINTN                                        *OutputSize,\r
+  OUT UINT32                                       *AuthenticationStatus\r

 );\r
 \r
 );\r
 \r

-\r
-\r
-/**\r
-  @par Ppi Description:\r
-  If a GUID-defined section is encountered when doing section extraction,\r
-  the PEI Foundation or the EFI_PEI_FILE_LOADER_PPI instance\r
-  calls the appropriate instance of the GUIDed Section\r
-  Extraction PPI to extract the section stream contained\r
-  therein.\r
-  \r
-  \r
-  @param ExtractSection   Takes the GUIDed section as input and\r
-                          produces the section stream data. See\r
-                          the ExtractSection() function\r
-                          description.\r
-  \r
-**/\r
+///\r
+/// If a GUID-defined section is encountered when doing section extraction,\r
+/// the PEI Foundation or the EFI_PEI_FILE_LOADER_PPI instance\r
+/// calls the appropriate instance of the GUIDed Section\r
+/// Extraction PPI to extract the section stream contained\r
+/// therein.\r
+///  \r

 struct _EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI {\r
 struct _EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI {\r

+  ///  \r
+  /// Takes the GUIDed section as input and\r
+  /// produces the section stream data.\r
+  ///\r

   EFI_PEI_EXTRACT_GUIDED_SECTION ExtractSection;\r
 };\r
 \r
   EFI_PEI_EXTRACT_GUIDED_SECTION ExtractSection;\r
 };\r
 \r

diff --git a/MdePkg/Include/Ppi/LoadFile.h b/MdePkg/Include/Ppi/LoadFile.h
index 96955f764a9019988fa83db2b06764e7372e8a56..79cf0cd2998a93155109a916e73cda16fd5470d5 100644 (file)
--- a/MdePkg/Include/Ppi/LoadFile.h
+++ b/MdePkg/Include/Ppi/LoadFile.h
@@ -27,70 +27,48 @@ typedef struct _EFI_PEI_LOAD_FILE_PPI EFI_PEI_LOAD_FILE_PPI;
 /**\r
   Loads a PEIM into memory for subsequent execution.\r
 \r
 /**\r
   Loads a PEIM into memory for subsequent execution.\r
 \r

-  This service is the single member function of EFI_LOAD_FILE_PPI. This service separates\r
-  image loading and relocating from the PEI Foundation.\r
+  This service is the single member function of EFI_LOAD_FILE_PPI.\r
+  This service separates image loading and relocating from the PEI Foundation.\r

   \r
   \r

-  @param This                 Interface pointer that implements\r
-                              the Load File PPI instance.\r
-\r
-  @param FileHandle           File handle of the file to load.\r
-                              Type EFI_PEI_FILE_HANDLE is defined in\r
-                              FfsFindNextFile().\r
-\r
-  @param ImageAddress         Pointer to the address of the\r
-                              loaded image.\r
-\r
-  @param ImageSize            Pointer to the size of the loaded\r
-                              image.\r
-\r
-  @param EntryPoint           Pointer to the entry point of the\r
-                              image.\r
-\r
-  @param AuthenticationState  On exit, points to the attestation\r
-                              authentication state of the image\r
-                              or 0 if no attestation was\r
-                              performed. The format of\r
-                              AuthenticationState is defined in\r
-                              EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI.ExtractSection()\r
-\r
-\r
-  @retval EFI_SUCCESS         The image was loaded successfully.\r
-\r
+  @param This                   Interface pointer that implements\r
+                                the Load File PPI instance.\r
+  @param FileHandle             File handle of the file to load.\r
+  @param ImageAddress           Pointer to the address of the loaded image.\r
+  @param ImageSize              Pointer to the size of the loaded image.\r
+  @param EntryPoint             Pointer to the entry point of the image.\r
+  @param AuthenticationState    On exit, points to the attestation\r
+                                authentication state of the image\r
+                                or 0 if no attestation was performed.\r
+\r
+  @retval EFI_SUCCESS           The image was loaded successfully.\r

   @retval EFI_OUT_OF_RESOURCES  There was not enough memory.\r
   @retval EFI_OUT_OF_RESOURCES  There was not enough memory.\r

-\r
-  @retval EFI_LOAD_ERROR      There was no supported image in\r
-                              the file.\r
-  @retval EFI_INVALID_PARAMETER   EntryPoint was NULL.\r
-                              Or FileHandle was not a valid firmware file handle.\r
-  @retval EFI_NOT_SUPPORTED   An image requires relocations or\r
-                              is not memory mapped.\r
+  @retval EFI_LOAD_ERROR        There was no supported image in the file.\r
+  @retval EFI_INVALID_PARAMETER FileHandle was not a valid firmware file handle.\r
+  @retval EFI_INVALID_PARAMETER EntryPoint was NULL.\r
+  @retval EFI_NOT_SUPPORTED     An image requires relocations or is not\r
+                                memory mapped.\r

    \r
 **/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_PEI_LOAD_FILE)(\r
    \r
 **/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_PEI_LOAD_FILE)(\r

-  IN CONST  EFI_PEI_LOAD_FILE_PPI   *This,\r
-  IN CONST  EFI_PEI_FILE_HANDLE     FileHandle,\r
-  OUT       EFI_PHYSICAL_ADDRESS    *ImageAddress,\r
-  OUT       UINT64                  *ImageSize,\r
-  OUT       EFI_PHYSICAL_ADDRESS    *EntryPoint,\r
-  OUT       UINT32                  *AuthenticationState\r
+  IN  CONST  EFI_PEI_LOAD_FILE_PPI   *This,\r
+  IN  EFI_PEI_FILE_HANDLE            FileHandle,\r
+  OUT EFI_PHYSICAL_ADDRESS           *ImageAddress,\r
+  OUT UINT64                         *ImageSize,\r
+  OUT EFI_PHYSICAL_ADDRESS           *EntryPoint,\r
+  OUT UINT32                         *AuthenticationState\r

 );\r
 \r
 );\r
 \r

-\r
-/**\r
-  @par Ppi Description:\r
-  This PPI is a pointer to the Load File service.\r
-  This service will be published by a PEIM. The PEI Foundation\r
-  will use this service to launch the known PEI module images.\r
-  \r
-  \r
-  @param LoadFile  Loads a PEIM into memory for subsequent\r
-                   execution. See the LoadFile() function\r
-                   description.\r
-  \r
-**/\r
+///\r
+/// This PPI is a pointer to the Load File service.\r
+/// This service will be published by a PEIM. The PEI Foundation\r
+/// will use this service to launch the known PEI module images.\r
+///\r

 struct _EFI_PEI_LOAD_FILE_PPI {\r
 struct _EFI_PEI_LOAD_FILE_PPI {\r

+  ///\r
+  /// Loads a PEIM into memory for subsequent execution.\r
+  ///\r

   EFI_PEI_LOAD_FILE LoadFile;\r
 };\r
 \r
   EFI_PEI_LOAD_FILE LoadFile;\r
 };\r
 \r

diff --git a/MdePkg/Include/Ppi/LoadImage.h b/MdePkg/Include/Ppi/LoadImage.h
index 5d07fd96b8e6eccbe56b230ded405d836701d52b..8bd3e576ac132ce67ac01fa72c1807de7a253c3b 100644 (file)
--- a/MdePkg/Include/Ppi/LoadImage.h
+++ b/MdePkg/Include/Ppi/LoadImage.h
@@ -1,5 +1,5 @@
 /** @file\r
 /** @file\r

-  The file descript the PPI which notifies other drivers \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 - 2008, Intel Corporation                                                         \r
   of the PEIM being initialized by the PEI Dispatcher.\r
 \r
   Copyright (c) 2006 - 2008, Intel Corporation                                                         \r


@@ -26,23 +26,24 @@
 \r
 typedef struct _EFI_PEI_LOADED_IMAGE_PPI  EFI_PEI_LOADED_IMAGE_PPI;\r
 \r
 \r
 typedef struct _EFI_PEI_LOADED_IMAGE_PPI  EFI_PEI_LOADED_IMAGE_PPI;\r
 \r

-/**\r
-  @par Ppi Description:\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
-\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
 struct _EFI_PEI_LOADED_IMAGE_PPI {\r

+  ///\r
+  /// Address of the image at the address where it will be executed.\r
+  ///\r

   EFI_PHYSICAL_ADDRESS  ImageAddress;\r
   EFI_PHYSICAL_ADDRESS  ImageAddress;\r

+  ///\r
+  /// Size of the image as it will be executed.\r
+  ///\r

   UINT64                ImageSize;\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
   EFI_PEI_FILE_HANDLE   FileHandle;\r
 };\r
 \r