summaryrefslogtreecommitdiff
path: root/IntelFrameworkPkg/Include/Framework/PeiCis.h
diff options
context:
space:
mode:
Diffstat (limited to 'IntelFrameworkPkg/Include/Framework/PeiCis.h')
-rw-r--r--IntelFrameworkPkg/Include/Framework/PeiCis.h44
1 files changed, 22 insertions, 22 deletions
diff --git a/IntelFrameworkPkg/Include/Framework/PeiCis.h b/IntelFrameworkPkg/Include/Framework/PeiCis.h
index 042ec26..8aad13a 100644
--- a/IntelFrameworkPkg/Include/Framework/PeiCis.h
+++ b/IntelFrameworkPkg/Include/Framework/PeiCis.h
@@ -1,15 +1,15 @@
/** @file
- Include file for definitions in the Intel Platform Innovation Framework for EFI
+ The Include file for definitions in the Intel Platform Innovation Framework for EFI
Pre-EFI Initialization Core Interface Specification (PEI CIS) Version 0.91.
- Copyright (c) 2006 - 2009, Intel Corporation
- All rights reserved. This program and the accompanying materials
- are licensed and made available under the terms and conditions of the BSD License
- which accompanies this distribution. The full text of the license may be found at
- http://opensource.org/licenses/bsd-license.php
-
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
+This program and the accompanying materials are licensed and made available under
+the terms and conditions of the BSD License that accompanies this distribution.
+The full text of the license may be found at
+http://opensource.org/licenses/bsd-license.php.
+
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@@ -38,7 +38,7 @@ typedef struct _FRAMEWORK_EFI_PEI_SERVICES FRAMEWORK_EFI_PEI_SERVICES;
The PEI Dispatcher will invoke each PEIM one time. During this pass, the PEI
Dispatcher will pass control to the PEIM at the AddressOfEntryPoint in the PE Header.
- @param FfsHeader Pointer to the FFS file header.
+ @param FfsHeader The pointer to the FFS file header.
@param PeiServices Describes the list of possible PEI Services.
@return Status code
@@ -59,7 +59,7 @@ EFI_STATUS
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
@param Instance This instance of the firmware volume to find. The value 0 is the Boot Firmware Volume (BFV).
- @param FwVolHeader Pointer to the firmware volume header of the volume to return.
+ @param FwVolHeader The pointer to the firmware volume header of the volume to return.
@retval EFI_SUCCESS The volume was found.
@retval EFI_NOT_FOUND The volume was not found.
@@ -82,10 +82,10 @@ EFI_STATUS
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
@param SearchType A filter to find files only of this type.
- @param FwVolHeader Pointer to the firmware volume header of the volume to search. This parameter
+ @param FwVolHeader The pointer to the firmware volume header of the volume to search. This parameter
must point to a valid FFS volume.
- @param FileHeader Pointer to the current file from which to begin searching. This pointer will be
- updated upon return to reflect the file found.
+ @param FileHeader The pointer to the current file from which to begin searching. Upon return this pointer will be
+ updated to reflect the file found.
@retval EFI_SUCCESS The file was found.
@retval EFI_NOT_FOUND The file was not found.
@@ -125,15 +125,15 @@ EFI_STATUS
///
/// FRAMEWORK_EFI_PEI_SERVICES is a collection of functions whose implementation is provided by the PEI
-/// Foundation. The table is located in the temporary or permanent memory, depending upon the capabilities
+/// Foundation. The table may be located in the temporary or permanent memory, depending upon the capabilities
/// and phase of execution of PEI.
///
/// These services fall into various classes, including the following:
-/// - Managing the boot mode
-/// - Allocating both early and permanent memory
-/// - Supporting the Firmware File System (FFS)
-/// - Abstracting the PPI database abstraction
-/// - Creating Hand-Off Blocks (HOBs)
+/// - Managing the boot mode.
+/// - Allocating both early and permanent memory.
+/// - Supporting the Firmware File System (FFS).
+/// - Abstracting the PPI database abstraction.
+/// - Creating Hand-Off Blocks (HOBs).
///
struct _FRAMEWORK_EFI_PEI_SERVICES {
EFI_TABLE_HEADER Hdr;
@@ -179,7 +179,7 @@ struct _FRAMEWORK_EFI_PEI_SERVICES {
EFI_PEI_RESET_SYSTEM ResetSystem;
///
/// Inconsistent with specification here:
- /// In Framework Spec, PeiCis0.91, CpuIo and PciCfg is NOT pointers.
+ /// In Framework Spec, PeiCis0.91, CpuIo and PciCfg are NOT pointers.
///
//
@@ -189,7 +189,7 @@ struct _FRAMEWORK_EFI_PEI_SERVICES {
EFI_PEI_PCI_CFG_PPI *PciCfg;
};
///
-/// Enumeration of reset types defined in Framework Spec PeiCis
+/// Enumeration of reset types defined in the Framework Specification PeiCis.
///
typedef enum {
///