iPXE
Data Structures | Defines | Typedefs | Enumerations | Functions
PiMultiPhase.h File Reference

Include file matches things in PI for multiple module types. More...

#include <ipxe/efi/Pi/PiFirmwareVolume.h>
#include <ipxe/efi/Pi/PiFirmwareFile.h>
#include <ipxe/efi/Pi/PiBootMode.h>
#include <ipxe/efi/Pi/PiHob.h>
#include <ipxe/efi/Pi/PiDependency.h>
#include <ipxe/efi/Pi/PiStatusCode.h>
#include <ipxe/efi/Pi/PiS3BootScript.h>

Go to the source code of this file.

Data Structures

struct  EFI_SMRAM_DESCRIPTOR
 Structure describing a SMRAM region and its accessibility attributes. More...
struct  EFI_PCD_INFO

Defines

#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.
#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_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 PI_ENCODE_WARNING(a)   ((MAX_BIT >> 2) | (a))
 Success and warning codes reserved for use by PI.
#define PI_ENCODE_ERROR(a)   (MAX_BIT | (MAX_BIT >> 2) | (a))
 Error codes reserved for use by PI.
#define EFI_INTERRUPT_PENDING   PI_ENCODE_ERROR (0)
 Return status codes defined in SMM CIS.
#define EFI_WARN_INTERRUPT_SOURCE_PENDING   PI_ENCODE_WARNING (0)
#define EFI_WARN_INTERRUPT_SOURCE_QUIESCED   PI_ENCODE_WARNING (1)
#define EFI_SMRAM_OPEN   0x00000001
 SMRAM states and capabilities.
#define EFI_SMRAM_CLOSED   0x00000002
#define EFI_SMRAM_LOCKED   0x00000004
#define EFI_CACHEABLE   0x00000008
#define EFI_ALLOCATED   0x00000010
#define EFI_NEEDS_TESTING   0x00000020
#define EFI_NEEDS_ECC_INITIALIZATION   0x00000040
#define EFI_AUTH_STATUS_PLATFORM_OVERRIDE   0x01
 Bitmask of values for Authentication Status.
#define EFI_AUTH_STATUS_IMAGE_SIGNED   0x02
 Bitmask of values for Authentication Status.
#define EFI_AUTH_STATUS_NOT_TESTED   0x04
 Bitmask of values for Authentication Status.
#define EFI_AUTH_STATUS_TEST_FAILED   0x08
 Bitmask of values for Authentication Status.
#define EFI_AUTH_STATUS_ALL   0x0f
 Bitmask of values for Authentication Status.

Typedefs

typedef VOID(EFIAPIEFI_AP_PROCEDURE )(IN OUT VOID *Buffer)
 The function prototype for invoking a function on an Application Processor.

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
}

Functions

 FILE_LICENCE (BSD3)

Detailed Description

Include file matches things in PI for multiple module types.

Copyright (c) 2006 - 2015, 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.

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

Definition in file PiMultiPhase.h.


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

Definition at line 44 of file PiMultiPhase.h.

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

Definition at line 49 of file PiMultiPhase.h.

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

Definition at line 55 of file PiMultiPhase.h.

Referenced by efi_init().

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

Definition at line 62 of file PiMultiPhase.h.

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

Definition at line 69 of file PiMultiPhase.h.

Return status codes defined in SMM CIS.

Definition at line 74 of file PiMultiPhase.h.

Definition at line 76 of file PiMultiPhase.h.

Definition at line 77 of file PiMultiPhase.h.

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.

Definition at line 92 of file PiMultiPhase.h.

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

Definition at line 93 of file PiMultiPhase.h.

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

Definition at line 94 of file PiMultiPhase.h.

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

Definition at line 95 of file PiMultiPhase.h.

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

Definition at line 96 of file PiMultiPhase.h.

#define EFI_SMRAM_OPEN   0x00000001

SMRAM states and capabilities.

Definition at line 102 of file PiMultiPhase.h.

#define EFI_SMRAM_CLOSED   0x00000002

Definition at line 103 of file PiMultiPhase.h.

#define EFI_SMRAM_LOCKED   0x00000004

Definition at line 104 of file PiMultiPhase.h.

#define EFI_CACHEABLE   0x00000008

Definition at line 105 of file PiMultiPhase.h.

#define EFI_ALLOCATED   0x00000010

Definition at line 106 of file PiMultiPhase.h.

#define EFI_NEEDS_TESTING   0x00000020

Definition at line 107 of file PiMultiPhase.h.

#define EFI_NEEDS_ECC_INITIALIZATION   0x00000040

Definition at line 108 of file PiMultiPhase.h.


Typedef Documentation

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.

Definition at line 177 of file PiMultiPhase.h.


Enumeration Type Documentation

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 

Definition at line 138 of file PiMultiPhase.h.


Function Documentation

FILE_LICENCE ( BSD3  )