PeiCis.h clean up.

1. Add Doxygen comments for FRAMEWORK_EFI_PEI_SERVICES;
2. Remove definition of EFI_PEI_STARTUP_DESCRIPTOR. It is not defined in the PEI CIS spec and is implementation specific.

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

diff --git a/IntelFrameworkPkg/Include/Framework/PeiCis.h b/IntelFrameworkPkg/Include/Framework/PeiCis.h
index ad03c04165b92d768280664458a010c50a36e6a7..90a1a91f434fffe23464c72e4487c94eca639f04 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,9 +11,6 @@
   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
-  PeiCis Version 0.91.\r
-\r
 **/\r
 \r
 #ifndef __PEICIS_H__\r
@@ -111,7 +109,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
@@ -162,11 +172,5 @@ struct _FRAMEWORK_EFI_PEI_SERVICES {
   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
 #endif  \r
 \r