IntelFrameworkPkg/Include/Framework/PeiCis.h File Reference


Data Structures

struct  _FRAMEWORK_EFI_PEI_SERVICES

Defines

#define FRAMEWORK_PEI_SPECIFICATION_MAJOR_REVISION   0
#define FRAMEWORK_PEI_SPECIFICATION_MINOR_REVISION   91
#define FRAMEWORK_PEI_SERVICES_SIGNATURE   0x5652455320494550ULL
#define FRAMEWORK_PEI_SERVICES_REVISION   ((FRAMEWORK_PEI_SPECIFICATION_MAJOR_REVISION<<16) | (FRAMEWORK_PEI_SPECIFICATION_MINOR_REVISION))

Typedefs

typedef struct
_FRAMEWORK_EFI_PEI_SERVICES 
FRAMEWORK_EFI_PEI_SERVICES
typedef EFI_STATUS(EFIAPI * EFI_PEIM_ENTRY_POINT )(IN EFI_FFS_FILE_HEADER *FfsHeader, IN EFI_PEI_SERVICES **PeiServices)
typedef EFI_STATUS(EFIAPI * EFI_PEI_FFS_FIND_NEXT_VOLUME )(IN FRAMEWORK_EFI_PEI_SERVICES **PeiServices, IN UINTN Instance, IN OUT EFI_FIRMWARE_VOLUME_HEADER **FwVolHeader)
typedef EFI_STATUS(EFIAPI * EFI_PEI_FFS_FIND_NEXT_FILE )(IN FRAMEWORK_EFI_PEI_SERVICES **PeiServices, IN EFI_FV_FILETYPE SearchType, IN EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader, IN OUT EFI_FFS_FILE_HEADER **FileHeader)
typedef EFI_STATUS(EFIAPI * EFI_PEI_FFS_FIND_SECTION_DATA )(IN FRAMEWORK_EFI_PEI_SERVICES **PeiServices, IN EFI_SECTION_TYPE SectionType, IN EFI_FFS_FILE_HEADER *FfsFileHeader, IN OUT VOID **SectionData)

Enumerations

enum  EFI_PEI_RESET_TYPE { EfiPeiResetCold, EfiPeiResetWarm }

Detailed Description

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 - 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.


Define Documentation

#define FRAMEWORK_PEI_SERVICES_REVISION   ((FRAMEWORK_PEI_SPECIFICATION_MAJOR_REVISION<<16) | (FRAMEWORK_PEI_SPECIFICATION_MINOR_REVISION))

#define FRAMEWORK_PEI_SERVICES_SIGNATURE   0x5652455320494550ULL

#define FRAMEWORK_PEI_SPECIFICATION_MAJOR_REVISION   0

#define FRAMEWORK_PEI_SPECIFICATION_MINOR_REVISION   91


Typedef Documentation

typedef EFI_STATUS(EFIAPI * EFI_PEI_FFS_FIND_NEXT_FILE)(IN FRAMEWORK_EFI_PEI_SERVICES **PeiServices, IN EFI_FV_FILETYPE SearchType, IN EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader, IN OUT EFI_FFS_FILE_HEADER **FileHeader)

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.

Parameters:
PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
SearchType A filter to find files only of this type.
FwVolHeader The pointer to the firmware volume header of the volume to search. This parameter must point to a valid FFS volume.
FileHeader The pointer to the current file from which to begin searching. Upon return this pointer will be updated to reflect the file found.
Return values:
EFI_SUCCESS The file was found.
EFI_NOT_FOUND The file was not found.
EFI_NOT_FOUND The header checksum was not zero.

typedef EFI_STATUS(EFIAPI * EFI_PEI_FFS_FIND_NEXT_VOLUME)(IN FRAMEWORK_EFI_PEI_SERVICES **PeiServices, IN UINTN Instance, IN OUT EFI_FIRMWARE_VOLUME_HEADER **FwVolHeader)

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.

Parameters:
PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
Instance This instance of the firmware volume to find. The value 0 is the Boot Firmware Volume (BFV).
FwVolHeader The pointer to the firmware volume header of the volume to return.
Return values:
EFI_SUCCESS The volume was found.
EFI_NOT_FOUND The volume was not found.
EFI_INVALID_PARAMETER FwVolHeader is NULL

typedef EFI_STATUS(EFIAPI * EFI_PEI_FFS_FIND_SECTION_DATA)(IN FRAMEWORK_EFI_PEI_SERVICES **PeiServices, IN EFI_SECTION_TYPE SectionType, IN EFI_FFS_FILE_HEADER *FfsFileHeader, IN OUT VOID **SectionData)

Given the input file pointer, this service searches for the next matching file in the Firmware File System (FFS) volume.

Parameters:
PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
SectionType The value of the section type to find.
FfsFileHeader A pointer to the file header that contains the set of sections to be searched.
SectionData A pointer to the discovered section, if successful.
Return values:
EFI_SUCCESS The section was found.
EFI_NOT_FOUND The section was not found.

typedef EFI_STATUS(EFIAPI * EFI_PEIM_ENTRY_POINT)(IN EFI_FFS_FILE_HEADER *FfsHeader, IN EFI_PEI_SERVICES **PeiServices)

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.

Parameters:
FfsHeader The pointer to the FFS file header.
PeiServices Describes the list of possible PEI Services.
Returns:
Status code


Enumeration Type Documentation

Enumeration of reset types defined in the Framework Specification PeiCis.

Enumerator:
EfiPeiResetCold  Used to induce a system-wide reset. This sets all circuitry within the system to its initial state. This type of reset is asynchronous to system operation and operates withgout regard to cycle boundaries. EfiColdReset is tantamount to a system power cycle.
EfiPeiResetWarm  Used to induce a system-wide initialization. The processors are set to their initial state, and pending cycles are not corrupted. If the system does not support this reset type, then an EfiResetCold must be performed.


Generated on Wed Sep 2 13:08:33 2015 for IntelFrameworkPkg[ALL] by  doxygen 1.5.7.1