iPXE
Data Structures | Defines | Enumerations | Functions
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...

Defines

#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_AUTHENTICATED_WRITE_ACCESS   0x00000010
 Attributes of Authenticated Variable.
#define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS   0x00000020
#define EFI_VARIABLE_APPEND_WRITE   0x00000040

Enumerations

enum  EFI_MEMORY_TYPE {
  EfiReservedMemoryType, EfiLoaderCode, EfiLoaderData, EfiBootServicesCode,
  EfiBootServicesData, EfiRuntimeServicesCode, EfiRuntimeServicesData, EfiConventionalMemory,
  EfiUnusableMemory, EfiACPIReclaimMemory, EfiACPIMemoryNVS, EfiMemoryMappedIO,
  EfiMemoryMappedIOPortSpace, EfiPalCode, EfiPersistentMemory, EfiMaxMemoryType
}
 Enumeration of memory types introduced in UEFI. More...
enum  EFI_RESET_TYPE { EfiResetCold, EfiResetWarm, EfiResetShutdown, EfiResetPlatformSpecific }
 Enumeration of reset types. More...

Functions

 FILE_LICENCE (BSD3)

Detailed Description

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

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.

Definition in file UefiMultiPhase.h.


Define Documentation

#define EFI_VARIABLE_NON_VOLATILE   0x00000001

Attributes of variable.

Definition at line 163 of file UefiMultiPhase.h.

#define EFI_VARIABLE_BOOTSERVICE_ACCESS   0x00000002

Definition at line 164 of file UefiMultiPhase.h.

#define EFI_VARIABLE_RUNTIME_ACCESS   0x00000004

Definition at line 165 of file UefiMultiPhase.h.

#define EFI_VARIABLE_HARDWARE_ERROR_RECORD   0x00000008

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

Definition at line 170 of file UefiMultiPhase.h.

#define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS   0x00000010

Attributes of Authenticated Variable.

Definition at line 174 of file UefiMultiPhase.h.

Definition at line 175 of file UefiMultiPhase.h.

#define EFI_VARIABLE_APPEND_WRITE   0x00000040

Definition at line 176 of file UefiMultiPhase.h.


Enumeration Type Documentation

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 

Definition at line 24 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,
  EfiMaxMemoryType
} EFI_MEMORY_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 98 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 ( BSD3  )