Clean the public header files to remove the unnecessary include files.

[mirror_edk2.git] / IntelFrameworkPkg / Include / Framework / PeiCis.h

diff --git a/IntelFrameworkPkg/Include/Framework/PeiCis.h b/IntelFrameworkPkg/Include/Framework/PeiCis.h
index bcaf54e9e9066266d256afff856fc28c11b1cb96..db0b185a1faabaa989dc97d7218108894243b165 100644 (file)
--- a/IntelFrameworkPkg/Include/Framework/PeiCis.h
+++ b/IntelFrameworkPkg/Include/Framework/PeiCis.h
@@ -1,7 +1,8 @@
 /** @file\r
-  PI PEI master include file. This file should match the PI spec.\r
+  Include file for definitions in the Intel Platform Innovation Framework for EFI\r
+  Pre-EFI Initialization Core Interface Specification (PEI CIS) Version 0.91.\r
 \r
-  Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2009, 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
@@ -10,16 +11,26 @@
   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
-  @par Revision Reference:\r
-  Version 1.0.\r
-\r
 **/\r
 \r
 #ifndef __PEICIS_H__\r
 #define __PEICIS_H__\r
 \r
-#include <PiPei.h>\r
 #include <Ppi/PciCfg.h>\r
+//\r
+// Framework PEI Specification Revision information\r
+//\r
+#define FRAMEWORK_PEI_SPECIFICATION_MAJOR_REVISION    0\r
+#define FRAMEWORK_PEI_SPECIFICATION_MINOR_REVISION    91\r
+\r
+\r
+//\r
+// PEI services signature and Revision defined in Framework PEI spec\r
+//\r
+#define FRAMEWORK_PEI_SERVICES_SIGNATURE               0x5652455320494550ULL\r
+#define FRAMEWORK_PEI_SERVICES_REVISION               ((FRAMEWORK_PEI_SPECIFICATION_MAJOR_REVISION<<16) | (FRAMEWORK_PEI_SPECIFICATION_MINOR_REVISION))\r
+\r
+\r
 \r
 typedef struct _FRAMEWORK_EFI_PEI_SERVICES FRAMEWORK_EFI_PEI_SERVICES;\r
 \r
@@ -111,7 +122,19 @@ EFI_STATUS
   IN EFI_FFS_FILE_HEADER            *FfsFileHeader,\r
   IN OUT VOID                       **SectionData\r
   );\r
-        \r
+\r
+///\r
+///  FRAMEWORK_EFI_PEI_SERVICES is a collection of functions whose implementation is provided by the PEI\r
+///  Foundation. The table is located in the temporary or permanent memory, depending upon the capabilities \r
+///  and phase of execution of PEI.\r
+///  \r
+///  These services fall into various classes, including the following:\r
+///  - Managing the boot mode\r
+///  - Allocating both early and permanent memory\r
+///  - Supporting the Firmware File System (FFS)\r
+///  - Abstracting the PPI database abstraction\r
+///  - Creating Hand-Off Blocks (HOBs)\r
+///        \r
 struct _FRAMEWORK_EFI_PEI_SERVICES {\r
   EFI_TABLE_HEADER                  Hdr;\r
   //\r
@@ -146,6 +169,7 @@ struct _FRAMEWORK_EFI_PEI_SERVICES {
   EFI_PEI_COPY_MEM                  CopyMem;\r
   EFI_PEI_SET_MEM                   SetMem;\r
   //\r
+  // (the following interfaces are installed by publishing PEIM)\r
   // Status Code\r
   //\r
   EFI_PEI_REPORT_STATUS_CODE        ReportStatusCode;\r
@@ -153,20 +177,35 @@ struct _FRAMEWORK_EFI_PEI_SERVICES {
   // Reset\r
   //\r
   EFI_PEI_RESET_SYSTEM              ResetSystem;\r
-  //\r
-  // (the following interfaces are installed by publishing PEIM)\r
+  ///\r
+  /// Inconsistent with specification here: \r
+  /// In Framework Spec, PeiCis0.91, CpuIo and PciCfg is NOT pointers. \r
+  ///\r
+  \r
   //\r
   // I/O Abstractions\r
   //\r
   EFI_PEI_CPU_IO_PPI                *CpuIo;\r
   EFI_PEI_PCI_CFG_PPI               *PciCfg;\r
 };\r
-\r
-typedef struct {\r
-  UINTN                             BootFirmwareVolume;\r
-  UINTN                             SizeOfCacheAsRam;\r
-  EFI_PEI_PPI_DESCRIPTOR            *DispatchTable;\r
-} EFI_PEI_STARTUP_DESCRIPTOR;\r
+///\r
+/// Enumeration of reset types defined in Framework Spec PeiCis\r
+///\r
+typedef enum {\r
+  ///\r
+  /// Used to induce a system-wide reset. This sets all circuitry within the \r
+  /// system to its initial state.  This type of reset is asynchronous to system\r
+  /// operation and operates withgout regard to cycle boundaries.  EfiColdReset \r
+  /// is tantamount to a system power cycle.\r
+  ///\r
+  EfiPeiResetCold,\r
+  ///\r
+  /// Used to induce a system-wide initialization. The processors are set to their\r
+  /// initial state, and pending cycles are not corrupted.  If the system does \r
+  /// not support this reset type, then an EfiResetCold must be performed.\r
+  ///\r
+  EfiPeiResetWarm,\r
+} EFI_PEI_RESET_TYPE;\r
 \r
 #endif  \r
 \r