TianoCore EDK2 master
SecPlatformInformation.h File Reference
#include <Pi/PiPeiCis.h>

Go to the source code of this file.

Data Structures

union  EFI_HEALTH_FLAGS
 
struct  ITANIUM_HANDOFF_STATUS
 
union  EFI_SEC_PLATFORM_INFORMATION_RECORD
 
struct  _EFI_SEC_PLATFORM_INFORMATION_PPI
 

Macros

#define EFI_SEC_PLATFORM_INFORMATION_GUID
 
#define NORMAL_BOOT_CALL   0x0
 
#define RECOVERY_CHECK_CALL   0x3
 

Typedefs

typedef struct _EFI_SEC_PLATFORM_INFORMATION_PPI EFI_SEC_PLATFORM_INFORMATION_PPI
 
typedef EFI_HEALTH_FLAGS X64_HANDOFF_STATUS
 
typedef EFI_HEALTH_FLAGS IA32_HANDOFF_STATUS
 
typedef EFI_STATUS(EFIAPIEFI_SEC_PLATFORM_INFORMATION) (IN CONST EFI_PEI_SERVICES **PeiServices, IN OUT UINT64 *StructureSize, OUT EFI_SEC_PLATFORM_INFORMATION_RECORD *PlatformInformationRecord)
 

Variables

EFI_GUID gEfiSecPlatformInformationPpiGuid
 

Detailed Description

This file declares Sec Platform Information PPI.

This service is the primary handoff state into the PEI Foundation. The Security (SEC) component creates the early, transitory memory environment and also encapsulates knowledge of at least the location of the Boot Firmware Volume (BFV).

Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Revision Reference:
This PPI is introduced in PI Version 1.0.

Definition in file SecPlatformInformation.h.

Macro Definition Documentation

◆ EFI_SEC_PLATFORM_INFORMATION_GUID

#define EFI_SEC_PLATFORM_INFORMATION_GUID
Value:
{ \
0x6f8c2b35, 0xfef4, 0x448d, {0x82, 0x56, 0xe1, 0x1b, 0x19, 0xd6, 0x10, 0x77 } \
}

Definition at line 22 of file SecPlatformInformation.h.

◆ NORMAL_BOOT_CALL

#define NORMAL_BOOT_CALL   0x0

Definition at line 82 of file SecPlatformInformation.h.

◆ RECOVERY_CHECK_CALL

#define RECOVERY_CHECK_CALL   0x3

Definition at line 83 of file SecPlatformInformation.h.

Typedef Documentation

◆ EFI_SEC_PLATFORM_INFORMATION

typedef EFI_STATUS(EFIAPI * EFI_SEC_PLATFORM_INFORMATION) (IN CONST EFI_PEI_SERVICES **PeiServices, IN OUT UINT64 *StructureSize, OUT EFI_SEC_PLATFORM_INFORMATION_RECORD *PlatformInformationRecord)

This interface conveys state information out of the Security (SEC) phase into PEI.

This service is published by the SEC phase. The SEC phase handoff has an optional EFI_PEI_PPI_DESCRIPTOR list as its final argument when control is passed from SEC into the PEI Foundation. As such, if the platform supports the built-in self test (BIST) on IA-32 Intel architecture or the PAL-A handoff state for Itanium architecture, this information is encapsulated into the data structure abstracted by this service. This information is collected for the boot-strap processor (BSP) on IA-32. For Itanium architecture, it is available on all processors that execute the PEI Foundation.

Parameters
PeiServicesThe pointer to the PEI Services Table.
StructureSizeThe pointer to the variable describing size of the input buffer.
PlatformInformationRecordThe pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD.
Return values
EFI_SUCCESSThe data was successfully returned.
EFI_BUFFER_TOO_SMALLThe buffer was too small. The current buffer size needed to hold the record is returned in StructureSize.

Definition at line 161 of file SecPlatformInformation.h.

◆ EFI_SEC_PLATFORM_INFORMATION_PPI

◆ IA32_HANDOFF_STATUS

Definition at line 86 of file SecPlatformInformation.h.

◆ X64_HANDOFF_STATUS

Definition at line 85 of file SecPlatformInformation.h.