MdePkg[all]  1.08
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Data Structures | Macros | Typedefs | Enumerations
PiMultiPhase.h File Reference

Data Structures

struct  EFI_MMRAM_DESCRIPTOR
 
struct  _EFI_MM_RESERVED_MMRAM_REGION
 
struct  EFI_PCD_INFO
 

Macros

#define DXE_ERROR(StatusCode)   (MAX_BIT | (MAX_BIT >> 2) | StatusCode)
 
#define EFI_REQUEST_UNLOAD_IMAGE   DXE_ERROR (1)
 
#define EFI_NOT_AVAILABLE_YET   DXE_ERROR (2)
 
#define PI_ENCODE_WARNING(a)   ((MAX_BIT >> 2) | (a))
 
#define PI_ENCODE_ERROR(a)   (MAX_BIT | (MAX_BIT >> 2) | (a))
 
#define EFI_INTERRUPT_PENDING   PI_ENCODE_ERROR (0)
 
#define EFI_WARN_INTERRUPT_SOURCE_PENDING   PI_ENCODE_WARNING (0)
 
#define EFI_WARN_INTERRUPT_SOURCE_QUIESCED   PI_ENCODE_WARNING (1)
 
#define EFI_MMRAM_OPEN   0x00000001
 
#define EFI_MMRAM_CLOSED   0x00000002
 
#define EFI_MMRAM_LOCKED   0x00000004
 
#define EFI_CACHEABLE   0x00000008
 
#define EFI_ALLOCATED   0x00000010
 
#define EFI_NEEDS_TESTING   0x00000020
 
#define EFI_NEEDS_ECC_INITIALIZATION   0x00000040
 
#define EFI_SMRAM_OPEN   EFI_MMRAM_OPEN
 
#define EFI_SMRAM_CLOSED   EFI_MMRAM_CLOSED
 
#define EFI_SMRAM_LOCKED   EFI_MMRAM_LOCKED
 
#define EFI_AUTH_STATUS_PLATFORM_OVERRIDE   0x01
 
#define EFI_AUTH_STATUS_IMAGE_SIGNED   0x02
 
#define EFI_AUTH_STATUS_NOT_TESTED   0x04
 
#define EFI_AUTH_STATUS_TEST_FAILED   0x08
 
#define EFI_AUTH_STATUS_ALL   0x0f
 

Typedefs

typedef EFI_MMRAM_DESCRIPTOR EFI_SMRAM_DESCRIPTOR
 
typedef struct
_EFI_MM_RESERVED_MMRAM_REGION 		EFI_MM_RESERVED_MMRAM_REGION
 
typedef VOID(EFIAPI * EFI_AP_PROCEDURE )(IN OUT VOID *Buffer)
 
typedef EFI_STATUS(EFIAPI * EFI_AP_PROCEDURE2 )(IN VOID *ProcedureArgument)
 

Enumerations

enum  EFI_PCD_TYPE {
  EFI_PCD_TYPE_8, EFI_PCD_TYPE_16, EFI_PCD_TYPE_32, EFI_PCD_TYPE_64,
  EFI_PCD_TYPE_BOOL, EFI_PCD_TYPE_PTR
}
 

Detailed Description

Include file matches things in PI for multiple module types.

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

Revision Reference:
These elements are defined in UEFI Platform Initialization Specification 1.2.

Macro Definition Documentation

#define DXE_ERROR (   StatusCode)    (MAX_BIT | (MAX_BIT >> 2) | StatusCode)

Produces an error code in the range reserved for use by the Platform Initialization Architecture Specification.

The supported 32-bit range is 0xA0000000-0xBFFFFFFF The supported 64-bit range is 0xA000000000000000-0xBFFFFFFFFFFFFFFF

Parameters
StatusCodeThe status code value to convert into a warning code. StatusCode must be in the range 0x00000000..0x1FFFFFFF.
Returns
The value specified by StatusCode in the PI reserved range.
#define EFI_ALLOCATED   0x00000010
#define EFI_AUTH_STATUS_ALL   0x0f

Bitmask of values for Authentication Status. Authentication Status is returned from EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL and the EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI

xx00 Image was not signed. xxx1 Platform security policy override. Assumes the same meaning as 0010 (the image was signed, the signature was tested, and the signature passed authentication test). 0010 Image was signed, the signature was tested, and the signature passed authentication test. 0110 Image was signed and the signature was not tested. 1010 Image was signed, the signature was tested, and the signature failed the authentication test.

#define EFI_AUTH_STATUS_IMAGE_SIGNED   0x02

Bitmask of values for Authentication Status. Authentication Status is returned from EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL and the EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI

xx00 Image was not signed. xxx1 Platform security policy override. Assumes the same meaning as 0010 (the image was signed, the signature was tested, and the signature passed authentication test). 0010 Image was signed, the signature was tested, and the signature passed authentication test. 0110 Image was signed and the signature was not tested. 1010 Image was signed, the signature was tested, and the signature failed the authentication test.

#define EFI_AUTH_STATUS_NOT_TESTED   0x04

Bitmask of values for Authentication Status. Authentication Status is returned from EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL and the EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI

xx00 Image was not signed. xxx1 Platform security policy override. Assumes the same meaning as 0010 (the image was signed, the signature was tested, and the signature passed authentication test). 0010 Image was signed, the signature was tested, and the signature passed authentication test. 0110 Image was signed and the signature was not tested. 1010 Image was signed, the signature was tested, and the signature failed the authentication test.

#define EFI_AUTH_STATUS_PLATFORM_OVERRIDE   0x01

Bitmask of values for Authentication Status. Authentication Status is returned from EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL and the EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI

xx00 Image was not signed. xxx1 Platform security policy override. Assumes the same meaning as 0010 (the image was signed, the signature was tested, and the signature passed authentication test). 0010 Image was signed, the signature was tested, and the signature passed authentication test. 0110 Image was signed and the signature was not tested. 1010 Image was signed, the signature was tested, and the signature failed the authentication test.

#define EFI_AUTH_STATUS_TEST_FAILED   0x08

Bitmask of values for Authentication Status. Authentication Status is returned from EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL and the EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI

xx00 Image was not signed. xxx1 Platform security policy override. Assumes the same meaning as 0010 (the image was signed, the signature was tested, and the signature passed authentication test). 0010 Image was signed, the signature was tested, and the signature passed authentication test. 0110 Image was signed and the signature was not tested. 1010 Image was signed, the signature was tested, and the signature failed the authentication test.

#define EFI_CACHEABLE   0x00000008
#define EFI_INTERRUPT_PENDING   PI_ENCODE_ERROR (0)

Return status codes defined in SMM CIS.

#define EFI_MMRAM_CLOSED   0x00000002
#define EFI_MMRAM_LOCKED   0x00000004
#define EFI_MMRAM_OPEN   0x00000001

MMRAM states and capabilities

#define EFI_NEEDS_ECC_INITIALIZATION   0x00000040
#define EFI_NEEDS_TESTING   0x00000020
#define EFI_NOT_AVAILABLE_YET   DXE_ERROR (2)

If this value is returned by an API, it means the capability is not yet installed/available/ready to use.

#define EFI_REQUEST_UNLOAD_IMAGE   DXE_ERROR (1)

If this value is returned by an EFI image, then the image should be unloaded.

#define EFI_SMRAM_CLOSED   EFI_MMRAM_CLOSED
#define EFI_SMRAM_LOCKED   EFI_MMRAM_LOCKED
#define EFI_SMRAM_OPEN   EFI_MMRAM_OPEN
#define EFI_WARN_INTERRUPT_SOURCE_PENDING   PI_ENCODE_WARNING (0)
#define EFI_WARN_INTERRUPT_SOURCE_QUIESCED   PI_ENCODE_WARNING (1)
#define PI_ENCODE_ERROR (   a)    (MAX_BIT | (MAX_BIT >> 2) | (a))

Error codes reserved for use by PI. Supported 32-bit range is 0xa0000000-0xbfffffff. Supported 64-bit range is 0xa000000000000000-0xbfffffffffffffff.

#define PI_ENCODE_WARNING (   a)    ((MAX_BIT >> 2) | (a))

Success and warning codes reserved for use by PI. Supported 32-bit range is 0x20000000-0x3fffffff. Supported 64-bit range is 0x2000000000000000-0x3fffffffffffffff.

Typedef Documentation

typedef VOID(EFIAPI * EFI_AP_PROCEDURE)(IN OUT VOID *Buffer)

The function prototype for invoking a function on an Application Processor.

This definition is used by the UEFI MP Serices Protocol, and the PI SMM System Table.

Parameters
[in,out]BufferThe pointer to private data buffer.
typedef EFI_STATUS(EFIAPI * EFI_AP_PROCEDURE2)(IN VOID *ProcedureArgument)

The function prototype for invoking a function on an Application Processor.

This definition is used by the UEFI MM MP Serices Protocol.

Parameters
[in]ProcedureArgumentThe pointer to private data buffer.
Return values
EFI_SUCCESSExcutive the procedure successfully
typedef struct _EFI_MM_RESERVED_MMRAM_REGION EFI_MM_RESERVED_MMRAM_REGION

Structure describing a MMRAM region which cannot be used for the MMRAM heap.

typedef EFI_MMRAM_DESCRIPTOR EFI_SMRAM_DESCRIPTOR

Enumeration Type Documentation

enum EFI_PCD_TYPE
Enumerator
EFI_PCD_TYPE_8 
EFI_PCD_TYPE_16 
EFI_PCD_TYPE_32 
EFI_PCD_TYPE_64 
EFI_PCD_TYPE_BOOL 
EFI_PCD_TYPE_PTR