]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Pi/PiPeiCis.h
Refine version info in MDE file header.
[mirror_edk2.git] / MdePkg / Include / Pi / PiPeiCis.h
index 8b39917be919545dc16a77e74f886b4598abe2ad..e2d2d75748e8e6d045d4d958e5357ffcc02cf03b 100644 (file)
@@ -11,7 +11,7 @@
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
   @par Revision Reference:\r
-  Version 1.0.\r
+  PI Version 1.0\r
 \r
 **/\r
 \r
@@ -715,109 +715,68 @@ struct _EFI_PEI_SERVICES {
   ///\r
   /// The table header for the PEI Services Table.\r
   ///\r
-  EFI_TABLE_HEADER            Hdr;\r
-  ///\r
-  /// Installs an interface in the PEI PEIM-to-PEIM\r
-  /// Interface (PPI) database by GUID.\r
-  ///\r
-  EFI_PEI_INSTALL_PPI         InstallPpi;\r
-  ///\r
-  /// Reinstalls an interface in the PEI PPI database by GUID.\r
-  ///\r
-  EFI_PEI_REINSTALL_PPI       ReInstallPpi;\r
-  ///\r
-  /// Locates an interface in the PEI PPI database by GUID.\r
-  ///\r
-  EFI_PEI_LOCATE_PPI          LocatePpi;\r
-  ///\r
-  /// Installs the notification service to be called back\r
-  /// upon the installation or reinstallation of a given interface.\r
-  ///\r
-  EFI_PEI_NOTIFY_PPI          NotifyPpi;\r
-  ///\r
-  /// Returns the present value of the boot mode.\r
-  ///\r
-  EFI_PEI_GET_BOOT_MODE       GetBootMode;\r
-  ///\r
-  /// Sets the value of the boot mode.\r
-  ///\r
-  EFI_PEI_SET_BOOT_MODE       SetBootMode;\r
-  ///\r
-  /// Returns the pointer to the list of Hand-Off Blocks (HOBs) in memory.\r
-  ///\r
-  EFI_PEI_GET_HOB_LIST        GetHobList;\r
-  ///\r
-  /// Abstracts the creation of HOB headers.\r
-  ///\r
-  EFI_PEI_CREATE_HOB          CreateHob;\r
-  ///\r
-  /// Discovers instances of firmware volumes in the system.\r
-  ///\r
+  EFI_TABLE_HEADER                Hdr;\r
+\r
+  //\r
+  // PPI Functions\r
+  //\r
+  EFI_PEI_INSTALL_PPI             InstallPpi;\r
+  EFI_PEI_REINSTALL_PPI           ReInstallPpi;\r
+  EFI_PEI_LOCATE_PPI              LocatePpi;\r
+  EFI_PEI_NOTIFY_PPI              NotifyPpi;\r
+\r
+  //\r
+  // Boot Mode Functions\r
+  //\r
+  EFI_PEI_GET_BOOT_MODE           GetBootMode;\r
+  EFI_PEI_SET_BOOT_MODE           SetBootMode;\r
+\r
+  //\r
+  // HOB Functions\r
+  //\r
+  EFI_PEI_GET_HOB_LIST            GetHobList;\r
+  EFI_PEI_CREATE_HOB              CreateHob;\r
+\r
+  //\r
+  // Firmware Volume Functions\r
+  //\r
   EFI_PEI_FFS_FIND_NEXT_VOLUME2   FfsFindNextVolume;\r
-  ///\r
-  /// Discovers instances of firmware files in the system.\r
-  ///\r
   EFI_PEI_FFS_FIND_NEXT_FILE2     FfsFindNextFile;\r
-  ///\r
-  /// Searches for a section in a firmware file.\r
-  ///\r
   EFI_PEI_FFS_FIND_SECTION_DATA2  FfsFindSectionData;\r
-  ///\r
-  /// Registers the found memory configuration with the PEI Foundation.\r
-  ///\r
-  EFI_PEI_INSTALL_PEI_MEMORY  InstallPeiMemory;\r
-  ///\r
-  /// Allocates memory ranges that are managed by the PEI Foundation.\r
-  ///\r
-  EFI_PEI_ALLOCATE_PAGES      AllocatePages;\r
-  ///\r
-  /// Allocate memory ranges that are managed by the PEI Foundation.\r
-  ///\r
-  EFI_PEI_ALLOCATE_POOL       AllocatePool;\r
-  ///\r
-  /// Copies the contents of one buffer to another buffer.\r
-  ///\r
-  EFI_PEI_COPY_MEM            CopyMem;\r
-  ///\r
-  /// Fills a buffer with a specified value.\r
-  ///\r
-  EFI_PEI_SET_MEM             SetMem;\r
-  ///\r
-  /// Provides an interface that a PEIM can call to report a status code.\r
-  ///\r
-  EFI_PEI_REPORT_STATUS_CODE  ReportStatusCode;\r
-  ///\r
-  /// Resets the entire platform.\r
-  ///\r
-  EFI_PEI_RESET_SYSTEM        ResetSystem;\r
-  ///\r
-  /// Provides an interface that a PEIM can call to execute\r
-  /// an I/O transaction. This interface is installed by provider\r
-  /// PEIM by copying the interface into the PEI Service table.\r
-  ///\r
-  EFI_PEI_CPU_IO_PPI          *CpuIo;\r
-  ///\r
-  /// Provides an interface that a PEIM can call to execute PCI\r
-  /// Configuration transactions. This interface is installed by\r
-  /// provider PEIM by copying the interface into the EFI_PEI_SERVICES table.\r
-  ///\r
-  EFI_PEI_PCI_CFG2_PPI        *PciCfg;\r
-  ///\r
-  /// Discovers firmware files within a volume by name.\r
-  ///\r
-  EFI_PEI_FFS_FIND_BY_NAME    FfsFindFileByName;\r
-  ///\r
-  /// Return information about a particular file.\r
-  ///\r
-  EFI_PEI_FFS_GET_FILE_INFO   FfsGetFileInfo;\r
-  ///\r
-  /// Return information about a particular volume.\r
-  ///\r
-  EFI_PEI_FFS_GET_VOLUME_INFO FfsGetVolumeInfo;\r
-  ///\r
-  /// Register a driver to be re-loaded when memory is available.\r
-  ///\r
-  EFI_PEI_REGISTER_FOR_SHADOW RegisterForShadow;\r
+\r
+  //\r
+  // PEI Memory Functions\r
+  //\r
+  EFI_PEI_INSTALL_PEI_MEMORY      InstallPeiMemory;\r
+  EFI_PEI_ALLOCATE_PAGES          AllocatePages;\r
+  EFI_PEI_ALLOCATE_POOL           AllocatePool;\r
+  EFI_PEI_COPY_MEM                CopyMem;\r
+  EFI_PEI_SET_MEM                 SetMem;\r
+\r
+  //\r
+  // Status Code\r
+  //\r
+  EFI_PEI_REPORT_STATUS_CODE      ReportStatusCode;\r
+\r
+  //\r
+  // Reset\r
+  //\r
+  EFI_PEI_RESET_SYSTEM            ResetSystem;\r
+\r
+  //\r
+  // (the following interfaces are installed by publishing PEIM)\r
+  // I/O Abstractions\r
+  //\r
+  EFI_PEI_CPU_IO_PPI              *CpuIo;\r
+  EFI_PEI_PCI_CFG2_PPI            *PciCfg;\r
+\r
+  //\r
+  // Future Installed Services\r
+  //\r
+  EFI_PEI_FFS_FIND_BY_NAME        FfsFindFileByName;\r
+  EFI_PEI_FFS_GET_FILE_INFO       FfsGetFileInfo;\r
+  EFI_PEI_FFS_GET_VOLUME_INFO     FfsGetVolumeInfo;\r
+  EFI_PEI_REGISTER_FOR_SHADOW     RegisterForShadow;\r
 };\r
 \r
 \r