UefiMultiPhase.h File Reference

Data Structures
struct	EFI_TABLE_HEADER
struct	EFI_VARIABLE_AUTHENTICATION
struct	EFI_VARIABLE_AUTHENTICATION_2

Macros
#define	EFI_VARIABLE_NON_VOLATILE   0x00000001
#define	EFI_VARIABLE_BOOTSERVICE_ACCESS   0x00000002
#define	EFI_VARIABLE_RUNTIME_ACCESS   0x00000004
#define	EFI_VARIABLE_HARDWARE_ERROR_RECORD   0x00000008
#define	EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS   0x00000020
#define	EFI_VARIABLE_APPEND_WRITE   0x00000040
#define	EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS   0x00000010

Enumerations
enum	EFI_MEMORY_TYPE {   EfiReservedMemoryType, EfiLoaderCode, EfiLoaderData, EfiBootServicesCode,   EfiBootServicesData, EfiRuntimeServicesCode, EfiRuntimeServicesData, EfiConventionalMemory,   EfiUnusableMemory, EfiACPIReclaimMemory, EfiACPIMemoryNVS, EfiMemoryMappedIO,   EfiMemoryMappedIOPortSpace, EfiPalCode, EfiPersistentMemory, EfiMaxMemoryType }
enum	EFI_RESET_TYPE { EfiResetCold, EfiResetWarm, EfiResetShutdown, EfiResetPlatformSpecific }

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

Macro Definition Documentation

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

#define EFI_VARIABLE_BOOTSERVICE_ACCESS   0x00000002

#define EFI_VARIABLE_HARDWARE_ERROR_RECORD   0x00000008

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

#define EFI_VARIABLE_NON_VOLATILE   0x00000001

Attributes of variable.

#define EFI_VARIABLE_RUNTIME_ACCESS   0x00000004

#define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS   0x00000020

Attributes of Authenticated Variable

Enumeration Type Documentation

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

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.