UefiMultiPhase.h File Reference

This includes some definitions introduced in UEFI that will be used in both PEI and DXE phases. More...

#include <ipxe/efi/Guid/WinCertificate.h>

Go to the source code of this file.

Data Structures
struct	EFI_TABLE_HEADER
	Data structure that precedes all of the standard EFI table types. More...
struct	EFI_VARIABLE_AUTHENTICATION
	AuthInfo is a WIN_CERTIFICATE using the wCertificateType WIN_CERTIFICATE_UEFI_GUID and the CertType EFI_CERT_TYPE_RSA2048_SHA256_GUID. More...
struct	EFI_VARIABLE_AUTHENTICATION_2
	When the attribute EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS is set, then the Data buffer shall begin with an instance of a complete (and serialized) EFI_VARIABLE_AUTHENTICATION_2 descriptor. More...

Macros
#define	EFI_VARIABLE_NON_VOLATILE   0x00000001
	Attributes of variable.
#define	EFI_VARIABLE_BOOTSERVICE_ACCESS   0x00000002
#define	EFI_VARIABLE_RUNTIME_ACCESS   0x00000004
#define	EFI_VARIABLE_HARDWARE_ERROR_RECORD   0x00000008
	This attribute is identified by the mnemonic 'HR' elsewhere in this specification.
#define	EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS   0x00000020
	Attributes of Authenticated Variable.
#define	EFI_VARIABLE_APPEND_WRITE   0x00000040
#define	EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS   0x00000010
	NOTE: EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS is deprecated and should be considered reserved.

Enumerations
enum	EFI_MEMORY_TYPE {   EfiReservedMemoryType , EfiLoaderCode , EfiLoaderData , EfiBootServicesCode ,   EfiBootServicesData , EfiRuntimeServicesCode , EfiRuntimeServicesData , EfiConventionalMemory ,   EfiUnusableMemory , EfiACPIReclaimMemory , EfiACPIMemoryNVS , EfiMemoryMappedIO ,   EfiMemoryMappedIOPortSpace , EfiPalCode , EfiPersistentMemory , EfiUnacceptedMemoryType ,   EfiMaxMemoryType , MEMORY_TYPE_OEM_RESERVED_MIN = 0x70000000 , MEMORY_TYPE_OEM_RESERVED_MAX = 0x7FFFFFFF , MEMORY_TYPE_OS_RESERVED_MIN = 0x80000000 ,   MEMORY_TYPE_OS_RESERVED_MAX = 0xFFFFFFFF }
	Enumeration of memory types introduced in UEFI. More...
enum	EFI_RESET_TYPE { EfiResetCold , EfiResetWarm , EfiResetShutdown , EfiResetPlatformSpecific }
	Enumeration of reset types. More...

Functions
	FILE_LICENCE (BSD2_PATENT)
	FILE_SECBOOT (PERMITTED)

Detailed Description

This includes some definitions introduced in UEFI that will be used in both PEI and DXE phases.

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

Definition in file UefiMultiPhase.h.

Macro Definition Documentation

EFI_VARIABLE_NON_VOLATILE

#define EFI_VARIABLE_NON_VOLATILE   0x00000001

Attributes of variable.

Definition at line 18 of file UefiMultiPhase.h.

Referenced by efi_reboot().

EFI_VARIABLE_BOOTSERVICE_ACCESS

#define EFI_VARIABLE_BOOTSERVICE_ACCESS   0x00000002

Definition at line 19 of file UefiMultiPhase.h.

Referenced by efi_reboot().

EFI_VARIABLE_RUNTIME_ACCESS

#define EFI_VARIABLE_RUNTIME_ACCESS   0x00000004

Definition at line 20 of file UefiMultiPhase.h.

Referenced by efi_reboot().

EFI_VARIABLE_HARDWARE_ERROR_RECORD

#define EFI_VARIABLE_HARDWARE_ERROR_RECORD   0x00000008

This attribute is identified by the mnemonic 'HR' elsewhere in this specification.

Definition at line 25 of file UefiMultiPhase.h.

EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS

#define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS   0x00000020

Attributes of Authenticated Variable.

Definition at line 29 of file UefiMultiPhase.h.

EFI_VARIABLE_APPEND_WRITE

#define EFI_VARIABLE_APPEND_WRITE   0x00000040

Definition at line 30 of file UefiMultiPhase.h.

EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS

#define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS   0x00000010

NOTE: EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS is deprecated and should be considered reserved.

Definition at line 34 of file UefiMultiPhase.h.

Enumeration Type Documentation

EFI_MEMORY_TYPE

enum EFI_MEMORY_TYPE

Enumeration of memory types introduced in UEFI.

Enumerator
EfiReservedMemoryType	Not used.
EfiLoaderCode	The code portions of a loaded application. (Note that UEFI OS loaders are UEFI applications.)
EfiLoaderData	The data portions of a loaded application and the default data allocation type used by an application to allocate pool memory.
EfiBootServicesCode	The code portions of a loaded Boot Services Driver.
EfiBootServicesData	The data portions of a loaded Boot Serves Driver, and the default data allocation type used by a Boot Services Driver to allocate pool memory.
EfiRuntimeServicesCode	The code portions of a loaded Runtime Services Driver.
EfiRuntimeServicesData	The data portions of a loaded Runtime Services Driver and the default data allocation type used by a Runtime Services Driver to allocate pool memory.
EfiConventionalMemory	Free (unallocated) memory.
EfiUnusableMemory	Memory in which errors have been detected.
EfiACPIReclaimMemory	Memory that holds the ACPI tables.
EfiACPIMemoryNVS	Address space reserved for use by the firmware.
EfiMemoryMappedIO	Used by system firmware to request that a memory-mapped IO region be mapped by the OS to a virtual address so it can be accessed by EFI runtime services.
EfiMemoryMappedIOPortSpace	System memory-mapped IO region that is used to translate memory cycles to IO cycles by the processor.
EfiPalCode	Address space reserved by the firmware for code that is part of the processor.
EfiPersistentMemory	A memory region that operates as EfiConventionalMemory, however it happens to also support byte-addressable non-volatility.
EfiUnacceptedMemoryType	A memory region that describes system memory that has not been accepted by a corresponding call to the underlying isolation architecture.
EfiMaxMemoryType
MEMORY_TYPE_OEM_RESERVED_MIN
MEMORY_TYPE_OEM_RESERVED_MAX
MEMORY_TYPE_OS_RESERVED_MIN
MEMORY_TYPE_OS_RESERVED_MAX

Definition at line 41 of file UefiMultiPhase.h.

             {
  ///
  /// Not used.
  ///
  EfiReservedMemoryType,
  ///
  /// The code portions of a loaded application.
  /// (Note that UEFI OS loaders are UEFI applications.)
  ///
  EfiLoaderCode,
  ///
  /// The data portions of a loaded application and the default data allocation
  /// type used by an application to allocate pool memory.
  ///
  EfiLoaderData,
  ///
  /// The code portions of a loaded Boot Services Driver.
  ///
  EfiBootServicesCode,
  ///
  /// The data portions of a loaded Boot Serves Driver, and the default data
  /// allocation type used by a Boot Services Driver to allocate pool memory.
  ///
  EfiBootServicesData,
  ///
  /// The code portions of a loaded Runtime Services Driver.
  ///
  EfiRuntimeServicesCode,
  ///
  /// The data portions of a loaded Runtime Services Driver and the default
  /// data allocation type used by a Runtime Services Driver to allocate pool memory.
  ///
  EfiRuntimeServicesData,
  ///
  /// Free (unallocated) memory.
  ///
  EfiConventionalMemory,
  ///
  /// Memory in which errors have been detected.
  ///
  EfiUnusableMemory,
  ///
  /// Memory that holds the ACPI tables.
  ///
  EfiACPIReclaimMemory,
  ///
  /// Address space reserved for use by the firmware.
  ///
  EfiACPIMemoryNVS,
  ///
  /// Used by system firmware to request that a memory-mapped IO region
  /// be mapped by the OS to a virtual address so it can be accessed by EFI runtime services.
  ///
  EfiMemoryMappedIO,
  ///
  /// System memory-mapped IO region that is used to translate memory
  /// cycles to IO cycles by the processor.
  ///
  EfiMemoryMappedIOPortSpace,
  ///
  /// Address space reserved by the firmware for code that is part of the processor.
  ///
  EfiPalCode,
  ///
  /// A memory region that operates as EfiConventionalMemory,
  /// however it happens to also support byte-addressable non-volatility.
  ///
  EfiPersistentMemory,
  ///
  /// A memory region that describes system memory that has not been accepted
  /// by a corresponding call to the underlying isolation architecture.
  ///
  EfiUnacceptedMemoryType,
  EfiMaxMemoryType,
  //
  // +---------------------------------------------------+
  // | 0..(EfiMaxMemoryType - 1)    - Normal memory type |
  // +---------------------------------------------------+
  // | EfiMaxMemoryType..0x6FFFFFFF - Invalid            |
  // +---------------------------------------------------+
  // | 0x70000000..0x7FFFFFFF       - OEM reserved       |
  // +---------------------------------------------------+
  // | 0x80000000..0xFFFFFFFF       - OS reserved        |
  // +---------------------------------------------------+
  //
  MEMORY_TYPE_OEM_RESERVED_MIN = 0x70000000,
  MEMORY_TYPE_OEM_RESERVED_MAX = 0x7FFFFFFF,
  MEMORY_TYPE_OS_RESERVED_MIN  = 0x80000000,
  MEMORY_TYPE_OS_RESERVED_MAX  = 0xFFFFFFFF
} EFI_MEMORY_TYPE;

EFI_RESET_TYPE

enum EFI_RESET_TYPE

Enumeration of reset types.

Enumerator
EfiResetCold	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.
EfiResetWarm	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.
EfiResetShutdown	Used to induce an entry into a power state equivalent to the ACPI G2/S5 or G3 state. If the system does not support this reset type, then when the system is rebooted, it should exhibit the EfiResetCold attributes.
EfiResetPlatformSpecific	Used to induce a system-wide reset. The exact type of the reset is defined by the EFI_GUID that follows the Null-terminated Unicode string passed into ResetData. If the platform does not recognize the EFI_GUID in ResetData the platform must pick a supported reset type to perform. The platform may optionally log the parameters from any non-normal reset that occurs.

Definition at line 135 of file UefiMultiPhase.h.

             {
  ///
  /// 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.
  ///
  EfiResetCold,
  ///
  /// 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.
  ///
  EfiResetWarm,
  ///
  /// Used to induce an entry into a power state equivalent to the ACPI G2/S5 or G3
  /// state.  If the system does not support this reset type, then when the system
  /// is rebooted, it should exhibit the EfiResetCold attributes.
  ///
  EfiResetShutdown,
  ///
  /// Used to induce a system-wide reset. The exact type of the reset is defined by
  /// the EFI_GUID that follows the Null-terminated Unicode string passed into
  /// ResetData. If the platform does not recognize the EFI_GUID in ResetData the
  /// platform must pick a supported reset type to perform. The platform may
  /// optionally log the parameters from any non-normal reset that occurs.
  ///
  EfiResetPlatformSpecific
} EFI_RESET_TYPE;

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

BSD2_PATENT

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)