X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=IntelFrameworkPkg%2FInclude%2FFramework%2FPeiCis.h;h=d823339eee9db16d4b9235a0706360fbebb7adc3;hp=5dc2f9c529abc7db54da7c7df27d1675f2e64d56;hb=2b3687dbb512ccd3cfbb75fa8966c3c93b3c067d;hpb=b59768ca63b215552c2af7261fd57be5d884bbb8
diff --git a/IntelFrameworkPkg/Include/Framework/PeiCis.h b/IntelFrameworkPkg/Include/Framework/PeiCis.h
index 5dc2f9c529..d823339eee 100644
--- a/IntelFrameworkPkg/Include/Framework/PeiCis.h
+++ b/IntelFrameworkPkg/Include/Framework/PeiCis.h
@@ -1,22 +1,21 @@
/** @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.
+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.
**/
#ifndef __PEICIS_H__
#define __PEICIS_H__
-#include
#include
//
// Framework PEI Specification Revision information
@@ -39,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
@@ -53,14 +52,14 @@ EFI_STATUS
);
/**
- The purpose of the service is to abstract the capability of the PEI
+ This service abstracts the capability of the PEI
Foundation to discover instances of firmware volumes in the system.
Given the input file pointer, this service searches for the next
matching file in the Firmware File System (FFS) volume.
@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.
@@ -76,17 +75,17 @@ EFI_STATUS
);
/**
- The purpose of the service is to abstract the capability of the PEI
+ This service abstracts the capability of the PEI
Foundation to discover instances of firmware files in the system.
Given the input file pointer, this service searches for the next matching
file in the Firmware File System (FFS) volume.
@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.
@@ -126,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;
@@ -180,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.
///
//
@@ -190,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 {
///