EDK2 doxygen online documents - Firmware Encoding Index 1
EDK2 doxygen online documents - Firmware Encoding Index
Data Structures | Defines | Typedefs | Enumerations

MdePkg/Include/Uefi/UefiSpec.h File Reference

#include <Uefi/UefiMultiPhase.h>
#include <Protocol/DevicePath.h>
#include <Protocol/SimpleTextIn.h>
#include <Protocol/SimpleTextInEx.h>
#include <Protocol/SimpleTextOut.h>
#include <Uefi/UefiPxe.h>
#include <Uefi/UefiGpt.h>
#include <Uefi/UefiInternalFormRepresentation.h>

Go to the source code of this file.

Data Structures

struct  EFI_MEMORY_DESCRIPTOR
struct  EFI_TIME_CAPABILITIES
struct  EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
struct  EFI_CAPSULE_BLOCK_DESCRIPTOR
struct  EFI_CAPSULE_HEADER
struct  EFI_CAPSULE_TABLE
struct  EFI_RUNTIME_SERVICES
struct  EFI_BOOT_SERVICES
struct  EFI_CONFIGURATION_TABLE
struct  EFI_SYSTEM_TABLE
union  EFI_BOOT_KEY_DATA
struct  EFI_KEY_OPTION

Defines

#define EFI_TIME_ADJUST_DAYLIGHT   0x01
#define EFI_TIME_IN_DAYLIGHT   0x02
#define EFI_UNSPECIFIED_TIMEZONE   0x07FF
#define EFI_MEMORY_UC   0x0000000000000001ULL
#define EFI_MEMORY_WC   0x0000000000000002ULL
#define EFI_MEMORY_WT   0x0000000000000004ULL
#define EFI_MEMORY_WB   0x0000000000000008ULL
#define EFI_MEMORY_UCE   0x0000000000000010ULL
#define EFI_MEMORY_WP   0x0000000000001000ULL
#define EFI_MEMORY_RP   0x0000000000002000ULL
#define EFI_MEMORY_XP   0x0000000000004000ULL
#define EFI_MEMORY_RUNTIME   0x8000000000000000ULL
#define EFI_MEMORY_DESCRIPTOR_VERSION   1
#define EFI_OPTIONAL_PTR   0x00000001
#define EVT_TIMER   0x80000000
#define EVT_RUNTIME   0x40000000
#define EVT_NOTIFY_WAIT   0x00000100
#define EVT_NOTIFY_SIGNAL   0x00000200
#define EVT_SIGNAL_EXIT_BOOT_SERVICES   0x00000201
#define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE   0x60000202
#define EVT_RUNTIME_CONTEXT   0x20000000
#define TPL_APPLICATION   4
#define TPL_CALLBACK   8
#define TPL_NOTIFY   16
#define TPL_HIGH_LEVEL   31
#define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL   0x00000001
#define EFI_OPEN_PROTOCOL_GET_PROTOCOL   0x00000002
#define EFI_OPEN_PROTOCOL_TEST_PROTOCOL   0x00000004
#define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER   0x00000008
#define EFI_OPEN_PROTOCOL_BY_DRIVER   0x00000010
#define EFI_OPEN_PROTOCOL_EXCLUSIVE   0x00000020
#define CAPSULE_FLAGS_PERSIST_ACROSS_RESET   0x00010000
#define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE   0x00020000
#define CAPSULE_FLAGS_INITIATE_RESET   0x00040000
#define EFI_SYSTEM_TABLE_SIGNATURE   SIGNATURE_64 ('I','B','I',' ','S','Y','S','T')
#define EFI_2_31_SYSTEM_TABLE_REVISION   ((2 << 16) | (31))
#define EFI_2_30_SYSTEM_TABLE_REVISION   ((2 << 16) | (30))
#define EFI_2_20_SYSTEM_TABLE_REVISION   ((2 << 16) | (20))
#define EFI_2_10_SYSTEM_TABLE_REVISION   ((2 << 16) | (10))
#define EFI_2_00_SYSTEM_TABLE_REVISION   ((2 << 16) | (00))
#define EFI_1_10_SYSTEM_TABLE_REVISION   ((1 << 16) | (10))
#define EFI_1_02_SYSTEM_TABLE_REVISION   ((1 << 16) | (02))
#define EFI_SYSTEM_TABLE_REVISION   EFI_2_31_SYSTEM_TABLE_REVISION
#define EFI_RUNTIME_SERVICES_SIGNATURE   SIGNATURE_64 ('R','U','N','T','S','E','R','V')
#define EFI_RUNTIME_SERVICES_REVISION   EFI_2_31_SYSTEM_TABLE_REVISION
#define EFI_BOOT_SERVICES_SIGNATURE   SIGNATURE_64 ('B','O','O','T','S','E','R','V')
#define EFI_BOOT_SERVICES_REVISION   EFI_2_31_SYSTEM_TABLE_REVISION
#define LOAD_OPTION_ACTIVE   0x00000001
#define LOAD_OPTION_FORCE_RECONNECT   0x00000002
#define LOAD_OPTION_HIDDEN   0x00000008
#define LOAD_OPTION_CATEGORY   0x00001F00
#define LOAD_OPTION_CATEGORY_BOOT   0x00000000
#define LOAD_OPTION_CATEGORY_APP   0x00000100
#define EFI_BOOT_OPTION_SUPPORT_KEY   0x00000001
#define EFI_BOOT_OPTION_SUPPORT_APP   0x00000002
#define EFI_BOOT_OPTION_SUPPORT_COUNT   0x00000300
#define EFI_REMOVABLE_MEDIA_FILE_NAME_IA32   L"\\EFI\\BOOT\\BOOTIA32.EFI"
#define EFI_REMOVABLE_MEDIA_FILE_NAME_IA64   L"\\EFI\\BOOT\\BOOTIA64.EFI"
#define EFI_REMOVABLE_MEDIA_FILE_NAME_X64   L"\\EFI\\BOOT\\BOOTX64.EFI"
#define EFI_REMOVABLE_MEDIA_FILE_NAME_ARM   L"\\EFI\\BOOT\\BOOTARM.EFI"

Typedefs

typedef EFI_STATUS(EFIAPI * EFI_ALLOCATE_PAGES )(IN EFI_ALLOCATE_TYPE Type, IN EFI_MEMORY_TYPE MemoryType, IN UINTN Pages, IN OUT EFI_PHYSICAL_ADDRESS *Memory)
typedef EFI_STATUS(EFIAPI * EFI_FREE_PAGES )(IN EFI_PHYSICAL_ADDRESS Memory, IN UINTN Pages)
typedef EFI_STATUS(EFIAPI * EFI_GET_MEMORY_MAP )(IN OUT UINTN *MemoryMapSize, IN OUT EFI_MEMORY_DESCRIPTOR *MemoryMap, OUT UINTN *MapKey, OUT UINTN *DescriptorSize, OUT UINT32 *DescriptorVersion)
typedef EFI_STATUS(EFIAPI * EFI_ALLOCATE_POOL )(IN EFI_MEMORY_TYPE PoolType, IN UINTN Size, OUT VOID **Buffer)
typedef EFI_STATUS(EFIAPI * EFI_FREE_POOL )(IN VOID *Buffer)
typedef EFI_STATUS(EFIAPI * EFI_SET_VIRTUAL_ADDRESS_MAP )(IN UINTN MemoryMapSize, IN UINTN DescriptorSize, IN UINT32 DescriptorVersion, IN EFI_MEMORY_DESCRIPTOR *VirtualMap)
typedef EFI_STATUS(EFIAPI * EFI_CONNECT_CONTROLLER )(IN EFI_HANDLE ControllerHandle, IN EFI_HANDLE *DriverImageHandle, OPTIONAL IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath, OPTIONAL IN BOOLEAN Recursive)
typedef EFI_STATUS(EFIAPI * EFI_DISCONNECT_CONTROLLER )(IN EFI_HANDLE ControllerHandle, IN EFI_HANDLE DriverImageHandle, OPTIONAL IN EFI_HANDLE ChildHandle OPTIONAL)
typedef EFI_STATUS(EFIAPI * EFI_CONVERT_POINTER )(IN UINTN DebugDisposition, IN OUT VOID **Address)
typedef VOID(EFIAPI * EFI_EVENT_NOTIFY )(IN EFI_EVENT Event, IN VOID *Context)
typedef EFI_STATUS(EFIAPI * EFI_CREATE_EVENT )(IN UINT32 Type, IN EFI_TPL NotifyTpl, IN EFI_EVENT_NOTIFY NotifyFunction, IN VOID *NotifyContext, OUT EFI_EVENT *Event)
typedef EFI_STATUS(EFIAPI * EFI_CREATE_EVENT_EX )(IN UINT32 Type, IN EFI_TPL NotifyTpl, IN EFI_EVENT_NOTIFY NotifyFunction OPTIONAL, IN CONST VOID *NotifyContext OPTIONAL, IN CONST EFI_GUID *EventGroup OPTIONAL, OUT EFI_EVENT *Event)
typedef EFI_STATUS(EFIAPI * EFI_SET_TIMER )(IN EFI_EVENT Event, IN EFI_TIMER_DELAY Type, IN UINT64 TriggerTime)
typedef EFI_STATUS(EFIAPI * EFI_SIGNAL_EVENT )(IN EFI_EVENT Event)
typedef EFI_STATUS(EFIAPI * EFI_WAIT_FOR_EVENT )(IN UINTN NumberOfEvents, IN EFI_EVENT *Event, OUT UINTN *Index)
typedef EFI_STATUS(EFIAPI * EFI_CLOSE_EVENT )(IN EFI_EVENT Event)
typedef EFI_STATUS(EFIAPI * EFI_CHECK_EVENT )(IN EFI_EVENT Event)
typedef EFI_TPL(EFIAPI * EFI_RAISE_TPL )(IN EFI_TPL NewTpl)
typedef VOID(EFIAPI * EFI_RESTORE_TPL )(IN EFI_TPL OldTpl)
typedef EFI_STATUS(EFIAPI * EFI_GET_VARIABLE )(IN CHAR16 *VariableName, IN EFI_GUID *VendorGuid, OUT UINT32 *Attributes, OPTIONAL IN OUT UINTN *DataSize, OUT VOID *Data)
typedef EFI_STATUS(EFIAPI * EFI_GET_NEXT_VARIABLE_NAME )(IN OUT UINTN *VariableNameSize, IN OUT CHAR16 *VariableName, IN OUT EFI_GUID *VendorGuid)
typedef EFI_STATUS(EFIAPI * EFI_SET_VARIABLE )(IN CHAR16 *VariableName, IN EFI_GUID *VendorGuid, IN UINT32 Attributes, IN UINTN DataSize, IN VOID *Data)
typedef EFI_STATUS(EFIAPI * EFI_GET_TIME )(OUT EFI_TIME *Time, OUT EFI_TIME_CAPABILITIES *Capabilities OPTIONAL)
typedef EFI_STATUS(EFIAPI * EFI_SET_TIME )(IN EFI_TIME *Time)
typedef EFI_STATUS(EFIAPI * EFI_GET_WAKEUP_TIME )(OUT BOOLEAN *Enabled, OUT BOOLEAN *Pending, OUT EFI_TIME *Time)
typedef EFI_STATUS(EFIAPI * EFI_SET_WAKEUP_TIME )(IN BOOLEAN Enable, IN EFI_TIME *Time OPTIONAL)
typedef EFI_STATUS(EFIAPI * EFI_IMAGE_LOAD )(IN BOOLEAN BootPolicy, IN EFI_HANDLE ParentImageHandle, IN EFI_DEVICE_PATH_PROTOCOL *DevicePath, IN VOID *SourceBuffer OPTIONAL, IN UINTN SourceSize, OUT EFI_HANDLE *ImageHandle)
typedef EFI_STATUS(EFIAPI * EFI_IMAGE_START )(IN EFI_HANDLE ImageHandle, OUT UINTN *ExitDataSize, OUT CHAR16 **ExitData OPTIONAL)
typedef EFI_STATUS(EFIAPI * EFI_EXIT )(IN EFI_HANDLE ImageHandle, IN EFI_STATUS ExitStatus, IN UINTN ExitDataSize, IN CHAR16 *ExitData OPTIONAL)
typedef EFI_STATUS(EFIAPI * EFI_IMAGE_UNLOAD )(IN EFI_HANDLE ImageHandle)
typedef EFI_STATUS(EFIAPI * EFI_EXIT_BOOT_SERVICES )(IN EFI_HANDLE ImageHandle, IN UINTN MapKey)
typedef EFI_STATUS(EFIAPI * EFI_STALL )(IN UINTN Microseconds)
typedef EFI_STATUS(EFIAPI * EFI_SET_WATCHDOG_TIMER )(IN UINTN Timeout, IN UINT64 WatchdogCode, IN UINTN DataSize, IN CHAR16 *WatchdogData OPTIONAL)
typedef VOID(EFIAPI * EFI_RESET_SYSTEM )(IN EFI_RESET_TYPE ResetType, IN EFI_STATUS ResetStatus, IN UINTN DataSize, IN VOID *ResetData OPTIONAL)
typedef EFI_STATUS(EFIAPI * EFI_GET_NEXT_MONOTONIC_COUNT )(OUT UINT64 *Count)
typedef EFI_STATUS(EFIAPI * EFI_GET_NEXT_HIGH_MONO_COUNT )(OUT UINT32 *HighCount)
typedef EFI_STATUS(EFIAPI * EFI_CALCULATE_CRC32 )(IN VOID *Data, IN UINTN DataSize, OUT UINT32 *Crc32)
typedef VOID(EFIAPI * EFI_COPY_MEM )(IN VOID *Destination, IN VOID *Source, IN UINTN Length)
typedef VOID(EFIAPI * EFI_SET_MEM )(IN VOID *Buffer, IN UINTN Size, IN UINT8 Value)
typedef EFI_STATUS(EFIAPI * EFI_INSTALL_PROTOCOL_INTERFACE )(IN OUT EFI_HANDLE *Handle, IN EFI_GUID *Protocol, IN EFI_INTERFACE_TYPE InterfaceType, IN VOID *Interface)
typedef EFI_STATUS(EFIAPI * EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES )(IN OUT EFI_HANDLE *Handle,...)
typedef EFI_STATUS(EFIAPI * EFI_REINSTALL_PROTOCOL_INTERFACE )(IN EFI_HANDLE Handle, IN EFI_GUID *Protocol, IN VOID *OldInterface, IN VOID *NewInterface)
typedef EFI_STATUS(EFIAPI * EFI_UNINSTALL_PROTOCOL_INTERFACE )(IN EFI_HANDLE Handle, IN EFI_GUID *Protocol, IN VOID *Interface)
typedef EFI_STATUS(EFIAPI * EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES )(IN EFI_HANDLE Handle,...)
typedef EFI_STATUS(EFIAPI * EFI_HANDLE_PROTOCOL )(IN EFI_HANDLE Handle, IN EFI_GUID *Protocol, OUT VOID **Interface)
typedef EFI_STATUS(EFIAPI * EFI_OPEN_PROTOCOL )(IN EFI_HANDLE Handle, IN EFI_GUID *Protocol, OUT VOID **Interface, OPTIONAL IN EFI_HANDLE AgentHandle, IN EFI_HANDLE ControllerHandle, IN UINT32 Attributes)
typedef EFI_STATUS(EFIAPI * EFI_CLOSE_PROTOCOL )(IN EFI_HANDLE Handle, IN EFI_GUID *Protocol, IN EFI_HANDLE AgentHandle, IN EFI_HANDLE ControllerHandle)
typedef EFI_STATUS(EFIAPI * EFI_OPEN_PROTOCOL_INFORMATION )(IN EFI_HANDLE Handle, IN EFI_GUID *Protocol, OUT EFI_OPEN_PROTOCOL_INFORMATION_ENTRY **EntryBuffer, OUT UINTN *EntryCount)
typedef EFI_STATUS(EFIAPI * EFI_PROTOCOLS_PER_HANDLE )(IN EFI_HANDLE Handle, OUT EFI_GUID ***ProtocolBuffer, OUT UINTN *ProtocolBufferCount)
typedef EFI_STATUS(EFIAPI * EFI_REGISTER_PROTOCOL_NOTIFY )(IN EFI_GUID *Protocol, IN EFI_EVENT Event, OUT VOID **Registration)
typedef EFI_STATUS(EFIAPI * EFI_LOCATE_HANDLE )(IN EFI_LOCATE_SEARCH_TYPE SearchType, IN EFI_GUID *Protocol, OPTIONAL IN VOID *SearchKey, OPTIONAL IN OUT UINTN *BufferSize, OUT EFI_HANDLE *Buffer)
typedef EFI_STATUS(EFIAPI * EFI_LOCATE_DEVICE_PATH )(IN EFI_GUID *Protocol, IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath, OUT EFI_HANDLE *Device)
typedef EFI_STATUS(EFIAPI * EFI_INSTALL_CONFIGURATION_TABLE )(IN EFI_GUID *Guid, IN VOID *Table)
typedef EFI_STATUS(EFIAPI * EFI_LOCATE_HANDLE_BUFFER )(IN EFI_LOCATE_SEARCH_TYPE SearchType, IN EFI_GUID *Protocol, OPTIONAL IN VOID *SearchKey, OPTIONAL IN OUT UINTN *NoHandles, OUT EFI_HANDLE **Buffer)
typedef EFI_STATUS(EFIAPI * EFI_LOCATE_PROTOCOL )(IN EFI_GUID *Protocol, IN VOID *Registration, OPTIONAL OUT VOID **Interface)
typedef EFI_STATUS(EFIAPI * EFI_UPDATE_CAPSULE )(IN EFI_CAPSULE_HEADER **CapsuleHeaderArray, IN UINTN CapsuleCount, IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL)
typedef EFI_STATUS(EFIAPI * EFI_QUERY_CAPSULE_CAPABILITIES )(IN EFI_CAPSULE_HEADER **CapsuleHeaderArray, IN UINTN CapsuleCount, OUT UINT64 *MaximumCapsuleSize, OUT EFI_RESET_TYPE *ResetType)
typedef EFI_STATUS(EFIAPI * EFI_QUERY_VARIABLE_INFO )(IN UINT32 Attributes, OUT UINT64 *MaximumVariableStorageSize, OUT UINT64 *RemainingVariableStorageSize, OUT UINT64 *MaximumVariableSize)
typedef EFI_STATUS(EFIAPI * EFI_IMAGE_ENTRY_POINT )(IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Enumerations

enum  EFI_ALLOCATE_TYPE {
  AllocateAnyPages, AllocateMaxAddress, AllocateAddress, MaxAllocateType,
  AllocateAnyPages, AllocateMaxAddress, AllocateAddress, MaxAllocateType
}
enum  EFI_TIMER_DELAY {
  TimerCancel, TimerPeriodic, TimerRelative, TimerTypeMax,
  TimerCancel, TimerPeriodic, TimerRelative
}
enum  EFI_RESET_TYPE {
  EfiResetCold, EfiResetWarm, EfiResetShutdown, EfiResetCold,
  EfiResetWarm, EfiResetShutdown
}
enum  EFI_INTERFACE_TYPE { EFI_NATIVE_INTERFACE, EFI_NATIVE_INTERFACE }
enum  EFI_LOCATE_SEARCH_TYPE {
  AllHandles, ByRegisterNotify, ByProtocol, AllHandles,
  ByRegisterNotify, ByProtocol
}

Detailed Description

Include file that supports UEFI.

This include file must contain things defined in the UEFI 2.3 specification. If a code construct is defined in the UEFI 2.3 specification it must be included by this include file.

Copyright (c) 2006 - 2011, 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 UefiSpec.h.


Define Documentation

#define CAPSULE_FLAGS_INITIATE_RESET   0x00040000

Definition at line 1627 of file UefiSpec.h.

#define CAPSULE_FLAGS_PERSIST_ACROSS_RESET   0x00010000

Definition at line 1625 of file UefiSpec.h.

#define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE   0x00020000

Definition at line 1626 of file UefiSpec.h.

#define EFI_1_02_SYSTEM_TABLE_REVISION   ((1 << 16) | (02))

Definition at line 1733 of file UefiSpec.h.

#define EFI_1_10_SYSTEM_TABLE_REVISION   ((1 << 16) | (10))

Definition at line 1732 of file UefiSpec.h.

#define EFI_2_00_SYSTEM_TABLE_REVISION   ((2 << 16) | (00))

Definition at line 1731 of file UefiSpec.h.

#define EFI_2_10_SYSTEM_TABLE_REVISION   ((2 << 16) | (10))

Definition at line 1730 of file UefiSpec.h.

#define EFI_2_20_SYSTEM_TABLE_REVISION   ((2 << 16) | (20))

Definition at line 1729 of file UefiSpec.h.

#define EFI_2_30_SYSTEM_TABLE_REVISION   ((2 << 16) | (30))

Definition at line 1728 of file UefiSpec.h.

#define EFI_2_31_SYSTEM_TABLE_REVISION   ((2 << 16) | (31))

Definition at line 1727 of file UefiSpec.h.

#define EFI_BOOT_OPTION_SUPPORT_APP   0x00000002

Definition at line 2000 of file UefiSpec.h.

#define EFI_BOOT_OPTION_SUPPORT_COUNT   0x00000300

Definition at line 2001 of file UefiSpec.h.

#define EFI_BOOT_OPTION_SUPPORT_KEY   0x00000001

Definition at line 1999 of file UefiSpec.h.

#define EFI_BOOT_SERVICES_REVISION   EFI_2_31_SYSTEM_TABLE_REVISION

Definition at line 1789 of file UefiSpec.h.

#define EFI_BOOT_SERVICES_SIGNATURE   SIGNATURE_64 ('B','O','O','T','S','E','R','V')

Definition at line 1788 of file UefiSpec.h.

#define EFI_MEMORY_DESCRIPTOR_VERSION   1

Memory descriptor version number.

Definition at line 85 of file UefiSpec.h.

#define EFI_MEMORY_RP   0x0000000000002000ULL

Definition at line 75 of file UefiSpec.h.

#define EFI_MEMORY_RUNTIME   0x8000000000000000ULL

Definition at line 80 of file UefiSpec.h.

#define EFI_MEMORY_UC   0x0000000000000001ULL

Definition at line 66 of file UefiSpec.h.

#define EFI_MEMORY_UCE   0x0000000000000010ULL

Definition at line 70 of file UefiSpec.h.

#define EFI_MEMORY_WB   0x0000000000000008ULL

Definition at line 69 of file UefiSpec.h.

#define EFI_MEMORY_WC   0x0000000000000002ULL

Definition at line 67 of file UefiSpec.h.

#define EFI_MEMORY_WP   0x0000000000001000ULL

Definition at line 74 of file UefiSpec.h.

#define EFI_MEMORY_WT   0x0000000000000004ULL

Definition at line 68 of file UefiSpec.h.

#define EFI_MEMORY_XP   0x0000000000004000ULL

Definition at line 76 of file UefiSpec.h.

#define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER   0x00000008

Definition at line 1252 of file UefiSpec.h.

#define EFI_OPEN_PROTOCOL_BY_DRIVER   0x00000010

Definition at line 1253 of file UefiSpec.h.

#define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL   0x00000001

Definition at line 1249 of file UefiSpec.h.

#define EFI_OPEN_PROTOCOL_EXCLUSIVE   0x00000020

Definition at line 1254 of file UefiSpec.h.

#define EFI_OPEN_PROTOCOL_GET_PROTOCOL   0x00000002

Definition at line 1250 of file UefiSpec.h.

#define EFI_OPEN_PROTOCOL_TEST_PROTOCOL   0x00000004

Definition at line 1251 of file UefiSpec.h.

#define EFI_OPTIONAL_PTR   0x00000001

Definition at line 331 of file UefiSpec.h.

#define EFI_REMOVABLE_MEDIA_FILE_NAME_ARM   L"\\EFI\\BOOT\\BOOTARM.EFI"

Definition at line 2080 of file UefiSpec.h.

#define EFI_REMOVABLE_MEDIA_FILE_NAME_IA32   L"\\EFI\\BOOT\\BOOTIA32.EFI"

Definition at line 2077 of file UefiSpec.h.

#define EFI_REMOVABLE_MEDIA_FILE_NAME_IA64   L"\\EFI\\BOOT\\BOOTIA64.EFI"

Definition at line 2078 of file UefiSpec.h.

#define EFI_REMOVABLE_MEDIA_FILE_NAME_X64   L"\\EFI\\BOOT\\BOOTX64.EFI"

Definition at line 2079 of file UefiSpec.h.

#define EFI_RUNTIME_SERVICES_REVISION   EFI_2_31_SYSTEM_TABLE_REVISION

Definition at line 1737 of file UefiSpec.h.

#define EFI_RUNTIME_SERVICES_SIGNATURE   SIGNATURE_64 ('R','U','N','T','S','E','R','V')

Definition at line 1736 of file UefiSpec.h.

#define EFI_SYSTEM_TABLE_REVISION   EFI_2_31_SYSTEM_TABLE_REVISION

Definition at line 1734 of file UefiSpec.h.

#define EFI_SYSTEM_TABLE_SIGNATURE   SIGNATURE_64 ('I','B','I',' ','S','Y','S','T')

Definition at line 1726 of file UefiSpec.h.

#define EFI_TIME_ADJUST_DAYLIGHT   0x01

Definition at line 55 of file UefiSpec.h.

#define EFI_TIME_IN_DAYLIGHT   0x02

Definition at line 56 of file UefiSpec.h.

#define EFI_UNSPECIFIED_TIMEZONE   0x07FF

Value definition for EFI_TIME.TimeZone.

Definition at line 61 of file UefiSpec.h.

#define EVT_NOTIFY_SIGNAL   0x00000200

Definition at line 364 of file UefiSpec.h.

#define EVT_NOTIFY_WAIT   0x00000100

Definition at line 363 of file UefiSpec.h.

#define EVT_RUNTIME   0x40000000

Definition at line 362 of file UefiSpec.h.

#define EVT_RUNTIME_CONTEXT   0x20000000

Definition at line 374 of file UefiSpec.h.

#define EVT_SIGNAL_EXIT_BOOT_SERVICES   0x00000201

Definition at line 366 of file UefiSpec.h.

#define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE   0x60000202

Definition at line 367 of file UefiSpec.h.

#define EVT_TIMER   0x80000000

Definition at line 361 of file UefiSpec.h.

#define LOAD_OPTION_ACTIVE   0x00000001

Definition at line 1991 of file UefiSpec.h.

#define LOAD_OPTION_CATEGORY   0x00001F00

Definition at line 1994 of file UefiSpec.h.

#define LOAD_OPTION_CATEGORY_APP   0x00000100

Definition at line 1997 of file UefiSpec.h.

#define LOAD_OPTION_CATEGORY_BOOT   0x00000000

Definition at line 1996 of file UefiSpec.h.

#define LOAD_OPTION_FORCE_RECONNECT   0x00000002

Definition at line 1992 of file UefiSpec.h.

#define LOAD_OPTION_HIDDEN   0x00000008

Definition at line 1993 of file UefiSpec.h.

#define TPL_APPLICATION   4

Definition at line 560 of file UefiSpec.h.

#define TPL_CALLBACK   8

Definition at line 561 of file UefiSpec.h.

#define TPL_HIGH_LEVEL   31

Definition at line 563 of file UefiSpec.h.

#define TPL_NOTIFY   16

Definition at line 562 of file UefiSpec.h.


Typedef Documentation

Allocates memory pages from the system.

Parameters:
TypeThe type of allocation to perform.
MemoryTypeThe type of memory to allocate.
PagesThe number of contiguous 4 KB pages to allocate.
MemoryThe pointer to a physical address. On input, the way in which the address is used depends on the value of Type.
Return values:
EFI_SUCCESSThe requested pages were allocated.
EFI_INVALID_PARAMETER1) Type is not AllocateAnyPages or AllocateMaxAddress or AllocateAddress. 2) MemoryType is in the range EfiMaxMemoryType..0x7FFFFFFF.
EFI_OUT_OF_RESOURCESThe pages could not be allocated.
EFI_NOT_FOUNDThe requested pages could not be found.

Definition at line 137 of file UefiSpec.h.

typedef EFI_STATUS(EFIAPI * EFI_ALLOCATE_POOL)(IN EFI_MEMORY_TYPE PoolType, IN UINTN Size, OUT VOID **Buffer)

Allocates pool memory.

Parameters:
PoolTypeThe type of pool to allocate.
SizeThe number of bytes to allocate from the pool.
BufferA pointer to a pointer to the allocated buffer if the call succeeds; undefined otherwise.
Return values:
EFI_SUCCESSThe requested number of bytes was allocated.
EFI_OUT_OF_RESOURCESThe pool requested could not be allocated.
EFI_INVALID_PARAMETERPoolType was invalid.

Definition at line 213 of file UefiSpec.h.

typedef EFI_STATUS(EFIAPI * EFI_CALCULATE_CRC32)(IN VOID *Data, IN UINTN DataSize, OUT UINT32 *Crc32)

Computes and returns a 32-bit CRC for a data buffer.

Parameters:
DataA pointer to the buffer on which the 32-bit CRC is to be computed.
DataSizeThe number of bytes in the buffer Data.
Crc32The 32-bit CRC that was computed for the data buffer specified by Data and DataSize.
Return values:
EFI_SUCCESSThe 32-bit CRC was computed for the data buffer and returned in Crc32.
EFI_INVALID_PARAMETERData is NULL.
EFI_INVALID_PARAMETERCrc32 is NULL.
EFI_INVALID_PARAMETERDataSize is 0.

Definition at line 1058 of file UefiSpec.h.

typedef EFI_STATUS(EFIAPI * EFI_CHECK_EVENT)(IN EFI_EVENT Event)

Checks whether an event is in the signaled state.

Parameters:
EventThe event to check.
Return values:
EFI_SUCCESSThe event is in the signaled state.
EFI_NOT_READYThe event is not in the signaled state.
EFI_INVALID_PARAMETEREvent is of type EVT_NOTIFY_SIGNAL.

Definition at line 552 of file UefiSpec.h.

typedef EFI_STATUS(EFIAPI * EFI_CLOSE_EVENT)(IN EFI_EVENT Event)

Closes an event.

Parameters:
EventThe event to close.
Return values:
EFI_SUCCESSThe event has been closed.

Definition at line 536 of file UefiSpec.h.

Closes a protocol on a handle that was opened using OpenProtocol().

Parameters:
HandleThe handle for the protocol interface that was previously opened with OpenProtocol(), and is now being closed.
ProtocolThe published unique identifier of the protocol.
AgentHandleThe handle of the agent that is closing the protocol interface.
ControllerHandleIf the agent that opened a protocol is a driver that follows the UEFI Driver Model, then this parameter is the controller handle that required the protocol interface.
Return values:
EFI_SUCCESSThe protocol instance was closed.
EFI_INVALID_PARAMETER1) Handle is NULL. 2) AgentHandle is NULL. 3) ControllerHandle is not NULL and ControllerHandle is not a valid EFI_HANDLE. 4) Protocol is NULL.
EFI_NOT_FOUND1) Handle does not support the protocol specified by Protocol. 2) The protocol interface specified by Handle and Protocol is not currently open by AgentHandle and ControllerHandle.

Definition at line 1318 of file UefiSpec.h.

Connects one or more drivers to a controller.

Parameters:
ControllerHandleThe handle of the controller to which driver(s) are to be connected.
DriverImageHandleA pointer to an ordered list handles that support the EFI_DRIVER_BINDING_PROTOCOL.
RemainingDevicePathA pointer to the device path that specifies a child of the controller specified by ControllerHandle.
RecursiveIf TRUE, then ConnectController() is called recursively until the entire tree of controllers below the controller specified by ControllerHandle have been created. If FALSE, then the tree of controllers is only expanded one level.
Return values:
EFI_SUCCESS1) One or more drivers were connected to ControllerHandle. 2) No drivers were connected to ControllerHandle, but RemainingDevicePath is not NULL, and it is an End Device Path Node.
EFI_INVALID_PARAMETERControllerHandle is NULL.
EFI_NOT_FOUND1) There are no EFI_DRIVER_BINDING_PROTOCOL instances present in the system. 2) No drivers were connected to ControllerHandle.

Definition at line 287 of file UefiSpec.h.

typedef EFI_STATUS(EFIAPI * EFI_CONVERT_POINTER)(IN UINTN DebugDisposition, IN OUT VOID **Address)

Determines the new virtual address that is to be used on subsequent memory accesses.

Parameters:
DebugDispositionSupplies type information for the pointer being converted.
AddressA pointer to a pointer that is to be fixed to be the value needed for the new virtual address mappings being applied.
Return values:
EFI_SUCCESSThe pointer pointed to by Address was modified.
EFI_INVALID_PARAMETER1) Address is NULL. 2) *Address is NULL and DebugDisposition does not have the EFI_OPTIONAL_PTR bit set.
EFI_NOT_FOUNDThe pointer pointed to by Address was not found to be part of the current memory map. This is normally fatal.

Definition at line 350 of file UefiSpec.h.

typedef VOID(EFIAPI * EFI_COPY_MEM)(IN VOID *Destination, IN VOID *Source, IN UINTN Length)

Copies the contents of one buffer to another buffer.

Parameters:
DestinationThe pointer to the destination buffer of the memory copy.
SourceThe pointer to the source buffer of the memory copy.
LengthNumber of bytes to copy from Source to Destination.

Definition at line 1074 of file UefiSpec.h.

Creates an event.

Parameters:
TypeThe type of event to create and its mode and attributes.
NotifyTplThe task priority level of event notifications, if needed.
NotifyFunctionThe pointer to the event's notification function, if any.
NotifyContextThe pointer to the notification function's context; corresponds to parameter Context in the notification function.
EventThe pointer to the newly created event if the call succeeds; undefined otherwise.
Return values:
EFI_SUCCESSThe event structure was created.
EFI_INVALID_PARAMETEROne or more parameters are invalid.
EFI_OUT_OF_RESOURCESThe event could not be allocated.

Definition at line 410 of file UefiSpec.h.

Creates an event in a group.

Parameters:
TypeThe type of event to create and its mode and attributes.
NotifyTplThe task priority level of event notifications,if needed.
NotifyFunctionThe pointer to the event's notification function, if any.
NotifyContextThe pointer to the notification function's context; corresponds to parameter Context in the notification function.
EventGroupThe pointer to the unique identifier of the group to which this event belongs. If this is NULL, then the function behaves as if the parameters were passed to CreateEvent.
EventThe pointer to the newly created event if the call succeeds; undefined otherwise.
Return values:
EFI_SUCCESSThe event structure was created.
EFI_INVALID_PARAMETEROne or more parameters are invalid.
EFI_OUT_OF_RESOURCESThe event could not be allocated.

Definition at line 439 of file UefiSpec.h.

Disconnects one or more drivers from a controller.

Parameters:
ControllerHandleThe handle of the controller from which driver(s) are to be disconnected.
DriverImageHandleThe driver to disconnect from ControllerHandle. If DriverImageHandle is NULL, then all the drivers currently managing ControllerHandle are disconnected from ControllerHandle.
ChildHandleThe handle of the child to destroy. If ChildHandle is NULL, then all the children of ControllerHandle are destroyed before the drivers are disconnected from ControllerHandle.
Return values:
EFI_SUCCESS1) One or more drivers were disconnected from the controller. 2) On entry, no drivers are managing ControllerHandle. 3) DriverImageHandle is not NULL, and on entry DriverImageHandle is not managing ControllerHandle.
EFI_INVALID_PARAMETER1) ControllerHandle is NULL. 2) DriverImageHandle is not NULL, and it is not a valid EFI_HANDLE. 3) ChildHandle is not NULL, and it is not a valid EFI_HANDLE. 4) DriverImageHandle does not support the EFI_DRIVER_BINDING_PROTOCOL.
EFI_OUT_OF_RESOURCESThere are not enough resources available to disconnect any drivers from ControllerHandle.
EFI_DEVICE_ERRORThe controller could not be disconnected because of a device error.

Definition at line 320 of file UefiSpec.h.

typedef VOID(EFIAPI * EFI_EVENT_NOTIFY)(IN EFI_EVENT Event, IN VOID *Context)

Invoke a notification event

Parameters:
EventEvent whose notification function is being invoked.
ContextThe pointer to the notification function's context, which is implementation-dependent.

Definition at line 387 of file UefiSpec.h.

Terminates a loaded EFI image and returns control to boot services.

Parameters:
ImageHandleHandle that identifies the image. This parameter is passed to the image on entry.
ExitStatusThe image's exit code.
ExitDataSizeThe size, in bytes, of ExitData. Ignored if ExitStatus is EFI_SUCCESS.
ExitDataThe pointer to a data buffer that includes a Null-terminated string, optionally followed by additional binary data. The string is a description that the caller may use to further indicate the reason for the image's exit. ExitData is only valid if ExitStatus is something other than EFI_SUCCESS. The ExitData buffer must be allocated by calling AllocatePool().
Return values:
EFI_SUCCESSThe image specified by ImageHandle was unloaded.
EFI_INVALID_PARAMETERThe image specified by ImageHandle has been loaded and started with LoadImage() and StartImage(), but the image is not the currently executing image.

Definition at line 885 of file UefiSpec.h.

Terminates all boot services.

Parameters:
ImageHandleHandle that identifies the exiting image.
MapKeyKey to the latest memory map.
Return values:
EFI_SUCCESSBoot services have been terminated.
EFI_INVALID_PARAMETERMapKey is incorrect.

Definition at line 919 of file UefiSpec.h.

Frees memory pages.

Parameters:
MemoryThe base physical address of the pages to be freed.
PagesThe number of contiguous 4 KB pages to free.
Return values:
EFI_SUCCESSThe requested pages were freed.
EFI_INVALID_PARAMETERMemory is not a page-aligned address or Pages is invalid.
EFI_NOT_FOUNDThe requested memory pages were not allocated with AllocatePages().

Definition at line 158 of file UefiSpec.h.

typedef EFI_STATUS(EFIAPI * EFI_FREE_POOL)(IN VOID *Buffer)

Returns pool memory to the system.

Parameters:
BufferThe pointer to the buffer to free.
Return values:
EFI_SUCCESSThe memory was returned to the system.
EFI_INVALID_PARAMETERBuffer was invalid.

Definition at line 230 of file UefiSpec.h.

typedef EFI_STATUS(EFIAPI * EFI_GET_MEMORY_MAP)(IN OUT UINTN *MemoryMapSize, IN OUT EFI_MEMORY_DESCRIPTOR *MemoryMap, OUT UINTN *MapKey, OUT UINTN *DescriptorSize, OUT UINT32 *DescriptorVersion)

Returns the current memory map.

Parameters:
MemoryMapSizeA pointer to the size, in bytes, of the MemoryMap buffer. On input, this is the size of the buffer allocated by the caller. On output, it is the size of the buffer returned by the firmware if the buffer was large enough, or the size of the buffer needed to contain the map if the buffer was too small.
MemoryMapA pointer to the buffer in which firmware places the current memory map.
MapKeyA pointer to the location in which firmware returns the key for the current memory map.
DescriptorSizeA pointer to the location in which firmware returns the size, in bytes, of an individual EFI_MEMORY_DESCRIPTOR.
DescriptorVersionA pointer to the location in which firmware returns the version number associated with the EFI_MEMORY_DESCRIPTOR.
Return values:
EFI_SUCCESSThe memory map was returned in the MemoryMap buffer.
EFI_BUFFER_TOO_SMALLThe MemoryMap buffer was too small. The current buffer size needed to hold the memory map is returned in MemoryMapSize.
EFI_INVALID_PARAMETER1) MemoryMapSize is NULL. 2) The MemoryMap buffer is not too small and MemoryMap is NULL.

Definition at line 190 of file UefiSpec.h.

typedef EFI_STATUS(EFIAPI * EFI_GET_NEXT_HIGH_MONO_COUNT)(OUT UINT32 *HighCount)

Returns the next high 32 bits of the platform's monotonic counter.

Parameters:
HighCountThe pointer to returned value.
Return values:
EFI_SUCCESSThe next high monotonic count was returned.
EFI_INVALID_PARAMETERHighCount is NULL.
EFI_DEVICE_ERRORThe device is not functioning properly.

Definition at line 1037 of file UefiSpec.h.

Returns a monotonically increasing count for the platform.

Parameters:
CountThe pointer to returned value.
Return values:
EFI_SUCCESSThe next monotonic count was returned.
EFI_INVALID_PARAMETERCount is NULL.
EFI_DEVICE_ERRORThe device is not functioning properly.

Definition at line 1021 of file UefiSpec.h.

Enumerates the current variable names.

Parameters:
VariableNameSizeThe size of the VariableName buffer.
VariableNameOn input, supplies the last VariableName that was returned by GetNextVariableName(). On output, returns the Nullterminated string of the current variable.
VendorGuidOn input, supplies the last VendorGuid that was returned by GetNextVariableName(). On output, returns the VendorGuid of the current variable.
Return values:
EFI_SUCCESSThe function completed successfully.
EFI_NOT_FOUNDThe next variable was not found.
EFI_BUFFER_TOO_SMALLThe VariableNameSize is too small for the result.
EFI_INVALID_PARAMETERVariableNameSize is NULL.
EFI_INVALID_PARAMETERVariableName is NULL.
EFI_INVALID_PARAMETERVendorGuid is NULL.
EFI_DEVICE_ERRORThe variable could not be retrieved due to a hardware error.

Definition at line 647 of file UefiSpec.h.

Returns the current time and date information, and the time-keeping capabilities of the hardware platform.

Parameters:
TimeA pointer to storage to receive a snapshot of the current time.
CapabilitiesAn optional pointer to a buffer to receive the real time clock device's capabilities.
Return values:
EFI_SUCCESSThe operation completed successfully.
EFI_INVALID_PARAMETERTime is NULL.
EFI_DEVICE_ERRORThe time could not be retrieved due to hardware error.

Definition at line 736 of file UefiSpec.h.

Returns the value of a variable.

Parameters:
VariableNameA Null-terminated string that is the name of the vendor's variable.
VendorGuidA unique identifier for the vendor.
AttributesIf not NULL, a pointer to the memory location to return the attributes bitmask for the variable.
DataSizeOn input, the size in bytes of the return Data buffer. On output the size of data returned in Data.
DataThe buffer to return the contents of the variable.
Return values:
EFI_SUCCESSThe function completed successfully.
EFI_NOT_FOUNDThe variable was not found.
EFI_BUFFER_TOO_SMALLThe DataSize is too small for the result.
EFI_INVALID_PARAMETERVariableName is NULL.
EFI_INVALID_PARAMETERVendorGuid is NULL.
EFI_INVALID_PARAMETERDataSize is NULL.
EFI_INVALID_PARAMETERThe DataSize is not too small and Data is NULL.
EFI_DEVICE_ERRORThe variable could not be retrieved due to a hardware error.
EFI_SECURITY_VIOLATIONThe variable could not be retrieved due to an authentication failure.

Definition at line 617 of file UefiSpec.h.

Returns the current wakeup alarm clock setting.

Parameters:
EnabledIndicates if the alarm is currently enabled or disabled.
PendingIndicates if the alarm signal is pending and requires acknowledgement.
TimeThe current alarm setting.
Return values:
EFI_SUCCESSThe alarm settings were returned.
EFI_INVALID_PARAMETEREnabled is NULL.
EFI_INVALID_PARAMETERPending is NULL.
EFI_INVALID_PARAMETERTime is NULL.
EFI_DEVICE_ERRORThe wakeup time could not be retrieved due to a hardware error.
EFI_UNSUPPORTEDA wakeup timer is not supported on this platform.

Definition at line 774 of file UefiSpec.h.

typedef EFI_STATUS(EFIAPI * EFI_HANDLE_PROTOCOL)(IN EFI_HANDLE Handle, IN EFI_GUID *Protocol, OUT VOID **Interface)

Queries a handle to determine if it supports a specified protocol.

Parameters:
HandleThe handle being queried.
ProtocolThe published unique identifier of the protocol.
InterfaceSupplies the address where a pointer to the corresponding Protocol Interface is returned.
Return values:
EFI_SUCCESSThe interface information for the specified protocol was returned.
EFI_UNSUPPORTEDThe device does not support the specified protocol.
EFI_INVALID_PARAMETERHandle is NULL.
EFI_INVALID_PARAMETERProtocol is NULL.
EFI_INVALID_PARAMETERInterface is NULL.

Definition at line 1243 of file UefiSpec.h.

This is the declaration of an EFI image entry point. This entry point is the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including both device drivers and bus drivers.

Parameters:
ImageHandleThe firmware allocated handle for the UEFI image.
SystemTableA pointer to the EFI System Table.
Return values:
EFI_SUCCESSThe operation completed successfully.
OthersAn unexpected error occurred.

Definition at line 1983 of file UefiSpec.h.

Loads an EFI image into memory.

Parameters:
BootPolicyIf TRUE, indicates that the request originates from the boot manager, and that the boot manager is attempting to load FilePath as a boot selection. Ignored if SourceBuffer is not NULL.
ParentImageHandleThe caller's image handle.
DevicePathThe DeviceHandle specific file path from which the image is loaded.
SourceBufferIf not NULL, a pointer to the memory location containing a copy of the image to be loaded.
SourceSizeThe size in bytes of SourceBuffer. Ignored if SourceBuffer is NULL.
ImageHandleThe pointer to the returned image handle that is created when the image is successfully loaded.
Return values:
EFI_SUCCESSImage was loaded into memory correctly.
EFI_NOT_FOUNDBoth SourceBuffer and DevicePath are NULL.
EFI_INVALID_PARAMETEROne or more parametes are invalid.
EFI_UNSUPPORTEDThe image type is not supported.
EFI_OUT_OF_RESOURCESImage was not loaded due to insufficient resources.
EFI_LOAD_ERRORImage was not loaded because the image format was corrupt or not understood.
EFI_DEVICE_ERRORImage was not loaded because the device returned a read error.
EFI_ACCESS_DENIEDImage was not loaded because the platform policy prohibits the image from being loaded. NULL is returned in *ImageHandle.
EFI_SECURITY_VIOLATIONImage was loaded and an ImageHandle was created with a valid EFI_LOADED_IMAGE_PROTOCOL. However, the current platform policy specifies that the image should not be started.

Definition at line 833 of file UefiSpec.h.

typedef EFI_STATUS(EFIAPI * EFI_IMAGE_START)(IN EFI_HANDLE ImageHandle, OUT UINTN *ExitDataSize, OUT CHAR16 **ExitData OPTIONAL)

Transfers control to a loaded image's entry point.

Parameters:
ImageHandleHandle of image to be started.
ExitDataSizeThe pointer to the size, in bytes, of ExitData.
ExitDataThe pointer to a pointer to a data buffer that includes a Null-terminated string, optionally followed by additional binary data.
Return values:
EFI_INVALID_PARAMETERImageHandle is either an invalid image handle or the image has already been initialized with StartImage.
Returns:
Exit code from image

Definition at line 857 of file UefiSpec.h.

Unloads an image.

Parameters:
ImageHandleHandle that identifies the image to be unloaded.
Return values:
EFI_SUCCESSThe image has been unloaded.
EFI_INVALID_PARAMETERImageHandle is not a valid image handle.

Definition at line 903 of file UefiSpec.h.

typedef EFI_STATUS(EFIAPI * EFI_INSTALL_CONFIGURATION_TABLE)(IN EFI_GUID *Guid, IN VOID *Table)

Adds, updates, or removes a configuration table entry from the EFI System Table.

Parameters:
GuidA pointer to the GUID for the entry to add, update, or remove.
TableA pointer to the configuration table for the entry to add, update, or remove. May be NULL.
Return values:
EFI_SUCCESSThe (Guid, Table) pair was added, updated, or removed.
EFI_NOT_FOUNDAn attempt was made to delete a nonexistent entry.
EFI_INVALID_PARAMETERGuid is NULL.
EFI_OUT_OF_RESOURCESThere is not enough memory available to complete the operation.

Definition at line 1501 of file UefiSpec.h.

Installs one or more protocol interfaces into the boot services environment.

Parameters:
HandleThe handle to install the new protocol interfaces on, or NULL if a new handle is to be allocated.
...A variable argument list containing pairs of protocol GUIDs and protocol interfaces.
Return values:
EFI_SUCCESSAll the protocol interface was installed.
EFI_OUT_OF_RESOURCESThere was not enough memory in pool to install all the protocols.
EFI_ALREADY_STARTEDA Device Path Protocol instance was passed in that is already present in the handle database.

Definition at line 1151 of file UefiSpec.h.

Installs a protocol interface on a device handle. If the handle does not exist, it is created and added to the list of handles in the system. InstallMultipleProtocolInterfaces() performs more error checking than InstallProtocolInterface(), so it is recommended that InstallMultipleProtocolInterfaces() be used in place of InstallProtocolInterface()

Parameters:
HandleA pointer to the EFI_HANDLE on which the interface is to be installed.
ProtocolThe numeric ID of the protocol interface.
InterfaceTypeIndicates whether Interface is supplied in native form.
InterfaceA pointer to the protocol interface.
Return values:
EFI_SUCCESSThe protocol interface was installed.
EFI_OUT_OF_RESOURCESSpace for a new handle could not be allocated.
EFI_INVALID_PARAMETERHandle is NULL.
EFI_INVALID_PARAMETERProtocol is NULL.
EFI_INVALID_PARAMETERInterfaceType is not EFI_NATIVE_INTERFACE.
EFI_INVALID_PARAMETERProtocol is already installed on the handle specified by Handle.

Definition at line 1128 of file UefiSpec.h.

Locates the handle to a device on the device path that supports the specified protocol.

Parameters:
ProtocolSpecifies the protocol to search for.
DevicePathOn input, a pointer to a pointer to the device path. On output, the device path pointer is modified to point to the remaining part of the device path.
DeviceA pointer to the returned device handle.
Return values:
EFI_SUCCESSThe resulting handle was returned.
EFI_NOT_FOUNDNo handles match the search.
EFI_INVALID_PARAMETERProtocol is NULL.
EFI_INVALID_PARAMETERDevicePath is NULL.
EFI_INVALID_PARAMETERA handle matched the search and Device is NULL.

Definition at line 1480 of file UefiSpec.h.

Returns an array of handles that support a specified protocol.

Parameters:
SearchTypeSpecifies which handle(s) are to be returned.
ProtocolSpecifies the protocol to search by.
SearchKeySpecifies the search key.
BufferSizeOn input, the size in bytes of Buffer. On output, the size in bytes of the array returned in Buffer (if the buffer was large enough) or the size, in bytes, of the buffer needed to obtain the array (if the buffer was not large enough).
BufferThe buffer in which the array is returned.
Return values:
EFI_SUCCESSThe array of handles was returned.
EFI_NOT_FOUNDNo handles match the search.
EFI_BUFFER_TOO_SMALLThe BufferSize is too small for the result.
EFI_INVALID_PARAMETERSearchType is not a member of EFI_LOCATE_SEARCH_TYPE.
EFI_INVALID_PARAMETERSearchType is ByRegisterNotify and SearchKey is NULL.
EFI_INVALID_PARAMETERSearchType is ByProtocol and Protocol is NULL.
EFI_INVALID_PARAMETEROne or more matches are found and BufferSize is NULL.
EFI_INVALID_PARAMETERBufferSize is large enough for the result and Buffer is NULL.

Definition at line 1454 of file UefiSpec.h.

typedef EFI_STATUS(EFIAPI * EFI_LOCATE_HANDLE_BUFFER)(IN EFI_LOCATE_SEARCH_TYPE SearchType, IN EFI_GUID *Protocol, OPTIONAL IN VOID *SearchKey, OPTIONAL IN OUT UINTN *NoHandles, OUT EFI_HANDLE **Buffer)

Returns an array of handles that support the requested protocol in a buffer allocated from pool.

Parameters:
SearchTypeSpecifies which handle(s) are to be returned.
ProtocolProvides the protocol to search by. This parameter is only valid for a SearchType of ByProtocol.
SearchKeySupplies the search key depending on the SearchType.
NoHandlesThe number of handles returned in Buffer.
BufferA pointer to the buffer to return the requested array of handles that support Protocol.
Return values:
EFI_SUCCESSThe array of handles was returned in Buffer, and the number of handles in Buffer was returned in NoHandles.
EFI_NOT_FOUNDNo handles match the search.
EFI_OUT_OF_RESOURCESThere is not enough pool memory to store the matching results.
EFI_INVALID_PARAMETERNoHandles is NULL.
EFI_INVALID_PARAMETERBuffer is NULL.

Definition at line 1527 of file UefiSpec.h.

typedef EFI_STATUS(EFIAPI * EFI_LOCATE_PROTOCOL)(IN EFI_GUID *Protocol, IN VOID *Registration, OPTIONAL OUT VOID **Interface)

Returns the first protocol instance that matches the given protocol.

Parameters:
ProtocolProvides the protocol to search for.
RegistrationOptional registration key returned from RegisterProtocolNotify().
InterfaceOn return, a pointer to the first interface that matches Protocol and Registration.
Return values:
EFI_SUCCESSA protocol instance matching Protocol was found and returned in Interface.
EFI_NOT_FOUNDNo protocol instances were found that match Protocol and Registration.
EFI_INVALID_PARAMETERInterface is NULL.

Definition at line 1553 of file UefiSpec.h.

Queries a handle to determine if it supports a specified protocol. If the protocol is supported by the handle, it opens the protocol on behalf of the calling agent.

Parameters:
HandleThe handle for the protocol interface that is being opened.
ProtocolThe published unique identifier of the protocol.
InterfaceSupplies the address where a pointer to the corresponding Protocol Interface is returned.
AgentHandleThe handle of the agent that is opening the protocol interface specified by Protocol and Interface.
ControllerHandleIf the agent that is opening a protocol is a driver that follows the UEFI Driver Model, then this parameter is the controller handle that requires the protocol interface. If the agent does not follow the UEFI Driver Model, then this parameter is optional and may be NULL.
AttributesThe open mode of the protocol interface specified by Handle and Protocol.
Return values:
EFI_SUCCESSAn item was added to the open list for the protocol interface, and the protocol interface was returned in Interface.
EFI_UNSUPPORTEDHandle does not support Protocol.
EFI_INVALID_PARAMETEROne or more parameters are invalid.
EFI_ACCESS_DENIEDRequired attributes can't be supported in current environment.
EFI_ALREADY_STARTEDItem on the open list already has requierd attributes whose agent handle is the same as AgentHandle.

Definition at line 1285 of file UefiSpec.h.

Retrieves the list of agents that currently have a protocol interface opened.

Parameters:
HandleThe handle for the protocol interface that is being queried.
ProtocolThe published unique identifier of the protocol.
EntryBufferA pointer to a buffer of open protocol information in the form of EFI_OPEN_PROTOCOL_INFORMATION_ENTRY structures.
EntryCountA pointer to the number of entries in EntryBuffer.
Return values:
EFI_SUCCESSThe open protocol information was returned in EntryBuffer, and the number of entries was returned EntryCount.
EFI_OUT_OF_RESOURCESThere are not enough resources available to allocate EntryBuffer.
EFI_NOT_FOUNDHandle does not support the protocol specified by Protocol.

Definition at line 1352 of file UefiSpec.h.

Retrieves the list of protocol interface GUIDs that are installed on a handle in a buffer allocated from pool.

Parameters:
HandleThe handle from which to retrieve the list of protocol interface GUIDs.
ProtocolBufferA pointer to the list of protocol interface GUID pointers that are installed on Handle.
ProtocolBufferCountA pointer to the number of GUID pointers present in ProtocolBuffer.
Return values:
EFI_SUCCESSThe list of protocol interface GUIDs installed on Handle was returned in ProtocolBuffer. The number of protocol interface GUIDs was returned in ProtocolBufferCount.
EFI_OUT_OF_RESOURCESThere is not enough pool memory to store the results.
EFI_INVALID_PARAMETERHandle is NULL.
EFI_INVALID_PARAMETERHandle is not a valid EFI_HANDLE.
EFI_INVALID_PARAMETERProtocolBuffer is NULL.
EFI_INVALID_PARAMETERProtocolBufferCount is NULL.

Definition at line 1382 of file UefiSpec.h.

typedef EFI_STATUS(EFIAPI * EFI_QUERY_CAPSULE_CAPABILITIES)(IN EFI_CAPSULE_HEADER **CapsuleHeaderArray, IN UINTN CapsuleCount, OUT UINT64 *MaximumCapsuleSize, OUT EFI_RESET_TYPE *ResetType)

Returns if the capsule can be supported via UpdateCapsule().

Parameters:
CapsuleHeaderArrayVirtual pointer to an array of virtual pointers to the capsules being passed into update capsule.
CapsuleCountNumber of pointers to EFI_CAPSULE_HEADER in CaspuleHeaderArray.
MaxiumCapsuleSizeOn output the maximum size that UpdateCapsule() can support as an argument to UpdateCapsule() via CapsuleHeaderArray and ScatterGatherList.
ResetTypeReturns the type of reset required for the capsule update.
Return values:
EFI_SUCCESSValid answer returned.
EFI_UNSUPPORTEDThe capsule type is not supported on this platform, and MaximumCapsuleSize and ResetType are undefined.
EFI_INVALID_PARAMETERMaximumCapsuleSize is NULL.
EFI_OUT_OF_RESOURCESThere were insufficient resources to process the query request.

Definition at line 1684 of file UefiSpec.h.

typedef EFI_STATUS(EFIAPI * EFI_QUERY_VARIABLE_INFO)(IN UINT32 Attributes, OUT UINT64 *MaximumVariableStorageSize, OUT UINT64 *RemainingVariableStorageSize, OUT UINT64 *MaximumVariableSize)

Returns information about the EFI variables.

Parameters:
AttributesAttributes bitmask to specify the type of variables on which to return information.
MaximumVariableStorageSizeOn output the maximum size of the storage space available for the EFI variables associated with the attributes specified.
RemainingVariableStorageSizeReturns the remaining size of the storage space available for the EFI variables associated with the attributes specified.
MaximumVariableSizeReturns the maximum size of the individual EFI variables associated with the attributes specified.
Return values:
EFI_SUCCESSValid answer returned.
EFI_INVALID_PARAMETERAn invalid combination of attribute bits was supplied
EFI_UNSUPPORTEDThe attribute is not supported on this platform, and the MaximumVariableStorageSize, RemainingVariableStorageSize, MaximumVariableSize are undefined.

Definition at line 1715 of file UefiSpec.h.

typedef EFI_TPL(EFIAPI * EFI_RAISE_TPL)(IN EFI_TPL NewTpl)

Raises a task's priority level and returns its previous level.

Parameters:
NewTplThe new task priority level.
Returns:
Previous task priority level

Definition at line 576 of file UefiSpec.h.

Creates an event that is to be signaled whenever an interface is installed for a specified protocol.

Parameters:
ProtocolThe numeric ID of the protocol for which the event is to be registered.
EventEvent that is to be signaled whenever a protocol interface is registered for Protocol.
RegistrationA pointer to a memory location to receive the registration value.
Return values:
EFI_SUCCESSThe notification event has been registered.
EFI_OUT_OF_RESOURCESSpace for the notification event could not be allocated.
EFI_INVALID_PARAMETERProtocol is NULL.
EFI_INVALID_PARAMETEREvent is NULL.
EFI_INVALID_PARAMETERRegistration is NULL.

Definition at line 1405 of file UefiSpec.h.

Reinstalls a protocol interface on a device handle.

Parameters:
HandleHandle on which the interface is to be reinstalled.
ProtocolThe numeric ID of the interface.
OldInterfaceA pointer to the old interface. NULL can be used if a structure is not associated with Protocol.
NewInterfaceA pointer to the new interface.
Return values:
EFI_SUCCESSThe protocol interface was reinstalled.
EFI_NOT_FOUNDThe OldInterface on the handle was not found.
EFI_ACCESS_DENIEDThe protocol interface could not be reinstalled, because OldInterface is still being used by a driver that will not release it.
EFI_INVALID_PARAMETERHandle is NULL.
EFI_INVALID_PARAMETERProtocol is NULL.

Definition at line 1176 of file UefiSpec.h.

typedef VOID(EFIAPI * EFI_RESET_SYSTEM)(IN EFI_RESET_TYPE ResetType, IN EFI_STATUS ResetStatus, IN UINTN DataSize, IN VOID *ResetData OPTIONAL)

Resets the entire platform.

Parameters:
ResetTypeThe type of reset to perform.
ResetStatusThe status code for the reset.
DataSizeThe size, in bytes, of WatchdogData.
ResetDataFor a ResetType of EfiResetCold, EfiResetWarm, or EfiResetShutdown the data buffer starts with a Null-terminated string, optionally followed by additional binary data.

Definition at line 1002 of file UefiSpec.h.

typedef VOID(EFIAPI * EFI_RESTORE_TPL)(IN EFI_TPL OldTpl)

Restores a task's priority level to its previous value.

Parameters:
OldTplThe previous task priority level to restore.

Definition at line 588 of file UefiSpec.h.

typedef VOID(EFIAPI * EFI_SET_MEM)(IN VOID *Buffer, IN UINTN Size, IN UINT8 Value)

The SetMem() function fills a buffer with a specified value.

Parameters:
BufferThe pointer to the buffer to fill.
SizeNumber of bytes in Buffer to fill.
ValueValue to fill Buffer with.

Definition at line 1090 of file UefiSpec.h.

typedef EFI_STATUS(EFIAPI * EFI_SET_TIME)(IN EFI_TIME *Time)

Sets the current local time and date information.

Parameters:
TimeA pointer to the current time.
Return values:
EFI_SUCCESSThe operation completed successfully.
EFI_INVALID_PARAMETERA time field is out of range.
EFI_DEVICE_ERRORThe time could not be set due due to hardware error.

Definition at line 753 of file UefiSpec.h.

Sets the type of timer and the trigger time for a timer event.

Parameters:
EventThe timer event that is to be signaled at the specified time.
TypeThe type of time that is specified in TriggerTime.
TriggerTimeThe number of 100ns units until the timer expires. A TriggerTime of 0 is legal. If Type is TimerRelative and TriggerTime is 0, then the timer event will be signaled on the next timer tick. If Type is TimerPeriodic and TriggerTime is 0, then the timer event will be signaled on every timer tick.
Return values:
EFI_SUCCESSThe event has been set to be signaled at the requested time.
EFI_INVALID_PARAMETEREvent or Type is not valid.

Definition at line 484 of file UefiSpec.h.

Sets the value of a variable.

Parameters:
VariableNameA Null-terminated string that is the name of the vendor's variable. Each VariableName is unique for each VendorGuid. VariableName must contain 1 or more characters. If VariableName is an empty string, then EFI_INVALID_PARAMETER is returned.
VendorGuidA unique identifier for the vendor.
AttributesAttributes bitmask to set for the variable.
DataSizeThe size in bytes of the Data buffer. A size of zero causes the variable to be deleted.
DataThe contents for the variable.
Return values:
EFI_SUCCESSThe firmware has successfully stored the variable and its data as defined by the Attributes.
EFI_INVALID_PARAMETERAn invalid combination of attribute bits was supplied, or the DataSize exceeds the maximum allowed.
EFI_INVALID_PARAMETERVariableName is an empty string.
EFI_OUT_OF_RESOURCESNot enough storage is available to hold the variable and its data.
EFI_DEVICE_ERRORThe variable could not be retrieved due to a hardware error.
EFI_WRITE_PROTECTEDThe variable in question is read-only.
EFI_WRITE_PROTECTEDThe variable in question cannot be deleted.
EFI_SECURITY_VIOLATIONThe variable could not be written due to EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS set but the AuthInfo does NOT pass the validation check carried out by the firmware.
EFI_NOT_FOUNDThe variable trying to be updated or deleted was not found.

Definition at line 683 of file UefiSpec.h.

Changes the runtime addressing mode of EFI firmware from physical to virtual.

Parameters:
MemoryMapSizeThe size in bytes of VirtualMap.
DescriptorSizeThe size in bytes of an entry in the VirtualMap.
DescriptorVersionThe version of the structure entries in VirtualMap.
VirtualMapAn array of memory descriptors which contain new virtual address mapping information for all runtime ranges.
Return values:
EFI_SUCCESSThe virtual address map has been applied.
EFI_UNSUPPORTEDEFI firmware is not at runtime, or the EFI firmware is already in virtual address mapped mode.
EFI_INVALID_PARAMETERDescriptorSize or DescriptorVersion is invalid.
EFI_NO_MAPPINGA virtual address was not supplied for a range in the memory map that requires a mapping.
EFI_NOT_FOUNDA virtual address was supplied for an address that is not found in the memory map.

Definition at line 255 of file UefiSpec.h.

Sets the system wakeup alarm clock time.

Parameters:
EnabledEnable or disable the wakeup alarm.
TimeIf Enable is TRUE, the time to set the wakeup alarm for. If Enable is FALSE, then this parameter is optional, and may be NULL.
Return values:
EFI_SUCCESSIf Enable is TRUE, then the wakeup alarm was enabled. If Enable is FALSE, then the wakeup alarm was disabled.
EFI_INVALID_PARAMETERA time field is out of range.
EFI_DEVICE_ERRORThe wakeup time could not be set due to a hardware error.
EFI_UNSUPPORTEDA wakeup timer is not supported on this platform.

Definition at line 796 of file UefiSpec.h.

Sets the system's watchdog timer.

Parameters:
TimeoutThe number of seconds to set the watchdog timer to.
WatchdogCodeThe numeric code to log on a watchdog timer timeout event.
DataSizeThe size, in bytes, of WatchdogData.
WatchdogDataA data buffer that includes a Null-terminated string, optionally followed by additional binary data.
Return values:
EFI_SUCCESSThe timeout has been set.
EFI_INVALID_PARAMETERThe supplied WatchdogCode is invalid.
EFI_UNSUPPORTEDThe system does not have a watchdog timer.
EFI_DEVICE_ERRORThe watchdog timer could not be programmed due to a hardware error.

Definition at line 957 of file UefiSpec.h.

typedef EFI_STATUS(EFIAPI * EFI_SIGNAL_EVENT)(IN EFI_EVENT Event)

Signals an event.

Parameters:
EventThe event to signal.
Return values:
EFI_SUCCESSThe event has been signaled.

Definition at line 500 of file UefiSpec.h.

typedef EFI_STATUS(EFIAPI * EFI_STALL)(IN UINTN Microseconds)

Induces a fine-grained stall.

Parameters:
MicrosecondsThe number of microseconds to stall execution.
Return values:
EFI_SUCCESSExecution was stalled at least the requested number of Microseconds.

Definition at line 935 of file UefiSpec.h.

Removes one or more protocol interfaces into the boot services environment.

Parameters:
HandleThe handle to remove the protocol interfaces from.
...A variable argument list containing pairs of protocol GUIDs and protocol interfaces.
Return values:
EFI_SUCCESSAll the protocol interfaces were removed.
EFI_INVALID_PARAMETEROne of the protocol interfaces was not previously installed on Handle.

Definition at line 1221 of file UefiSpec.h.

Removes a protocol interface from a device handle. It is recommended that UninstallMultipleProtocolInterfaces() be used in place of UninstallProtocolInterface().

Parameters:
HandleThe handle on which the interface was installed.
ProtocolThe numeric ID of the interface.
InterfaceA pointer to the interface.
Return values:
EFI_SUCCESSThe interface was removed.
EFI_NOT_FOUNDThe interface was not found.
EFI_ACCESS_DENIEDThe interface was not removed because the interface is still being used by a driver.
EFI_INVALID_PARAMETERHandle is NULL.
EFI_INVALID_PARAMETERProtocol is NULL.

Definition at line 1202 of file UefiSpec.h.

typedef EFI_STATUS(EFIAPI * EFI_UPDATE_CAPSULE)(IN EFI_CAPSULE_HEADER **CapsuleHeaderArray, IN UINTN CapsuleCount, IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL)

Passes capsules to the firmware with both virtual and physical mapping. Depending on the intended consumption, the firmware may process the capsule immediately. If the payload should persist across a system reset, the reset value returned from EFI_QueryCapsuleCapabilities must be passed into ResetSystem() and will cause the capsule to be processed by the firmware as part of the reset process.

Parameters:
CapsuleHeaderArrayVirtual pointer to an array of virtual pointers to the capsules being passed into update capsule.
CapsuleCountNumber of pointers to EFI_CAPSULE_HEADER in CaspuleHeaderArray.
ScatterGatherListPhysical pointer to a set of EFI_CAPSULE_BLOCK_DESCRIPTOR that describes the location in physical memory of a set of capsules.
Return values:
EFI_SUCCESSValid capsule was passed. If CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set, the capsule has been successfully processed by the firmware.
EFI_INVALID_PARAMETERCapsuleSize is NULL, or an incompatible set of flags were set in the capsule header.
EFI_INVALID_PARAMETERCapsuleCount is 0.
EFI_DEVICE_ERRORThe capsule update was started, but failed due to a device error.
EFI_UNSUPPORTEDThe capsule type is not supported on this platform.
EFI_OUT_OF_RESOURCESThere were insufficient resources to process the capsule.

Definition at line 1657 of file UefiSpec.h.

Stops execution until an event is signaled.

Parameters:
NumberOfEventsThe number of events in the Event array.
EventAn array of EFI_EVENT.
IndexThe pointer to the index of the event which satisfied the wait condition.
Return values:
EFI_SUCCESSThe event indicated by Index was signaled.
EFI_INVALID_PARAMETER1) NumberOfEvents is 0. 2) The event indicated by Index is of type EVT_NOTIFY_SIGNAL.
EFI_UNSUPPORTEDThe current TPL is not TPL_APPLICATION.

Definition at line 520 of file UefiSpec.h.


Enumeration Type Documentation

Enumeration of EFI memory allocation types.

Enumerator:
AllocateAnyPages 
AllocateMaxAddress 
AllocateAddress 
MaxAllocateType 
AllocateAnyPages 

Allocate any available range of pages that satisfies the request.

AllocateMaxAddress 

Allocate any available range of pages whose uppermost address is less than or equal to a specified maximum address.

AllocateAddress 

Allocate pages at a specified address.

MaxAllocateType 

Maximum enumeration value that may be used for bounds checking.

Definition at line 32 of file UefiSpec.h.

Enumeration of EFI Interface Types

Enumerator:
EFI_NATIVE_INTERFACE 
EFI_NATIVE_INTERFACE 

Indicates that the supplied protocol interface is supplied in native form.

Definition at line 1099 of file UefiSpec.h.

Enumeration of EFI Locate Search Types

Enumerator:
AllHandles 
ByRegisterNotify 
ByProtocol 
AllHandles 

Retrieve all the handles in the handle database.

ByRegisterNotify 

Retrieve the next handle fron a RegisterProtocolNotify() event.

ByProtocol 

Retrieve the set of handles from the handle database that support a specified protocol.

Definition at line 1414 of file UefiSpec.h.

Enumeration of reset types.

Enumerator:
EfiResetCold 
EfiResetWarm 
EfiResetShutdown 
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.

Definition at line 967 of file UefiSpec.h.

Timer delay types

Enumerator:
TimerCancel 
TimerPeriodic 
TimerRelative 
TimerTypeMax 
TimerCancel 

An event's timer settings is to be cancelled and not trigger time is to be set/

TimerPeriodic 

An event is to be signalled periodically at a specified interval from the current time.

TimerRelative 

An event is to be signalled once at a specified interval from the current time.

Definition at line 451 of file UefiSpec.h.

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines