|
iPXE
|
Include file that supports UEFI. More...
#include <ipxe/efi/Uefi/UefiMultiPhase.h>#include <ipxe/efi/Protocol/DevicePath.h>#include <ipxe/efi/Protocol/SimpleTextIn.h>#include <ipxe/efi/Protocol/SimpleTextInEx.h>#include <ipxe/efi/Protocol/SimpleTextOut.h>#include <ipxe/efi/Uefi/UefiPxe.h>#include <ipxe/efi/Uefi/UefiGpt.h>#include <ipxe/efi/Uefi/UefiInternalFormRepresentation.h>Go to the source code of this file.
Data Structures | |
| struct | EFI_MEMORY_DESCRIPTOR |
| Definition of an EFI memory descriptor. More... | |
| struct | EFI_TIME_CAPABILITIES |
| This provides the capabilities of the real time clock device as exposed through the EFI interfaces. More... | |
| struct | EFI_OPEN_PROTOCOL_INFORMATION_ENTRY |
| EFI Oprn Protocol Information Entry. More... | |
| struct | EFI_CAPSULE_BLOCK_DESCRIPTOR |
| EFI Capsule Block Descriptor. More... | |
| struct | EFI_CAPSULE_HEADER |
| EFI Capsule Header. More... | |
| struct | EFI_CAPSULE_TABLE |
| The EFI System Table entry must point to an array of capsules that contain the same CapsuleGuid value. More... | |
| struct | EFI_RUNTIME_SERVICES |
| EFI Runtime Services Table. More... | |
| struct | EFI_BOOT_SERVICES |
| EFI Boot Services Table. More... | |
| struct | EFI_CONFIGURATION_TABLE |
| Contains a set of GUID/pointer pairs comprised of the ConfigurationTable field in the EFI System Table. More... | |
| struct | EFI_SYSTEM_TABLE |
| EFI System Table. More... | |
| struct | _EFI_LOAD_OPTION |
| union | EFI_BOOT_KEY_DATA |
| EFI Boot Key Data. More... | |
| struct | EFI_KEY_OPTION |
| EFI Key Option. More... | |
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) |
| Allocates memory pages from the system. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_FREE_PAGES) (IN EFI_PHYSICAL_ADDRESS Memory, IN UINTN Pages) |
| Frees memory pages. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_GET_MEMORY_MAP) (IN OUT UINTN *MemoryMapSize, OUT EFI_MEMORY_DESCRIPTOR *MemoryMap, OUT UINTN *MapKey, OUT UINTN *DescriptorSize, OUT UINT32 *DescriptorVersion) |
| Returns the current memory map. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_ALLOCATE_POOL) (IN EFI_MEMORY_TYPE PoolType, IN UINTN Size, OUT VOID **Buffer) |
| Allocates pool memory. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_FREE_POOL) (IN VOID *Buffer) |
| Returns pool memory to the system. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_SET_VIRTUAL_ADDRESS_MAP) (IN UINTN MemoryMapSize, IN UINTN DescriptorSize, IN UINT32 DescriptorVersion, IN EFI_MEMORY_DESCRIPTOR *VirtualMap) |
| Changes the runtime addressing mode of EFI firmware from physical to virtual. More... | |
| 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) |
| Connects one or more drivers to a controller. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_DISCONNECT_CONTROLLER) (IN EFI_HANDLE ControllerHandle, IN EFI_HANDLE DriverImageHandle OPTIONAL, IN EFI_HANDLE ChildHandle OPTIONAL) |
| Disconnects one or more drivers from a controller. More... | |
| 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. More... | |
| typedef VOID(EFIAPI * | EFI_EVENT_NOTIFY) (IN EFI_EVENT Event, IN VOID *Context) |
| Invoke a notification event. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_CREATE_EVENT) (IN UINT32 Type, IN EFI_TPL NotifyTpl, IN EFI_EVENT_NOTIFY NotifyFunction OPTIONAL, IN VOID *NotifyContext OPTIONAL, OUT EFI_EVENT *Event) |
| Creates an event. More... | |
| 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) |
| Creates an event in a group. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_SET_TIMER) (IN EFI_EVENT Event, IN EFI_TIMER_DELAY Type, IN UINT64 TriggerTime) |
| Sets the type of timer and the trigger time for a timer event. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_SIGNAL_EVENT) (IN EFI_EVENT Event) |
| Signals an event. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_WAIT_FOR_EVENT) (IN UINTN NumberOfEvents, IN EFI_EVENT *Event, OUT UINTN *Index) |
| Stops execution until an event is signaled. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_CLOSE_EVENT) (IN EFI_EVENT Event) |
| Closes an event. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_CHECK_EVENT) (IN EFI_EVENT Event) |
| Checks whether an event is in the signaled state. More... | |
| typedef EFI_TPL(EFIAPI * | EFI_RAISE_TPL) (IN EFI_TPL NewTpl) |
| Raises a task's priority level and returns its previous level. More... | |
| typedef VOID(EFIAPI * | EFI_RESTORE_TPL) (IN EFI_TPL OldTpl) |
| Restores a task's priority level to its previous value. More... | |
| 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 OPTIONAL) |
| Returns the value of a variable. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_GET_NEXT_VARIABLE_NAME) (IN OUT UINTN *VariableNameSize, IN OUT CHAR16 *VariableName, IN OUT EFI_GUID *VendorGuid) |
| Enumerates the current variable names. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_SET_VARIABLE) (IN CHAR16 *VariableName, IN EFI_GUID *VendorGuid, IN UINT32 Attributes, IN UINTN DataSize, IN VOID *Data) |
| Sets the value of a variable. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_GET_TIME) (OUT EFI_TIME *Time, OUT EFI_TIME_CAPABILITIES *Capabilities OPTIONAL) |
| Returns the current time and date information, and the time-keeping capabilities of the hardware platform. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_SET_TIME) (IN EFI_TIME *Time) |
| Sets the current local time and date information. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_GET_WAKEUP_TIME) (OUT BOOLEAN *Enabled, OUT BOOLEAN *Pending, OUT EFI_TIME *Time) |
| Returns the current wakeup alarm clock setting. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_SET_WAKEUP_TIME) (IN BOOLEAN Enable, IN EFI_TIME *Time OPTIONAL) |
| Sets the system wakeup alarm clock time. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_IMAGE_LOAD) (IN BOOLEAN BootPolicy, IN EFI_HANDLE ParentImageHandle, IN EFI_DEVICE_PATH_PROTOCOL *DevicePath OPTIONAL, IN VOID *SourceBuffer OPTIONAL, IN UINTN SourceSize, OUT EFI_HANDLE *ImageHandle) |
| Loads an EFI image into memory. More... | |
| 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. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_EXIT) (IN EFI_HANDLE ImageHandle, IN EFI_STATUS ExitStatus, IN UINTN ExitDataSize, IN CHAR16 *ExitData OPTIONAL) |
| Terminates a loaded EFI image and returns control to boot services. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_IMAGE_UNLOAD) (IN EFI_HANDLE ImageHandle) |
| Unloads an image. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_EXIT_BOOT_SERVICES) (IN EFI_HANDLE ImageHandle, IN UINTN MapKey) |
| Terminates all boot services. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_STALL) (IN UINTN Microseconds) |
| Induces a fine-grained stall. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_SET_WATCHDOG_TIMER) (IN UINTN Timeout, IN UINT64 WatchdogCode, IN UINTN DataSize, IN CHAR16 *WatchdogData OPTIONAL) |
| Sets the system's watchdog timer. More... | |
| 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. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_GET_NEXT_MONOTONIC_COUNT) (OUT UINT64 *Count) |
| Returns a monotonically increasing count for the platform. More... | |
| 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. More... | |
| 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. More... | |
| typedef VOID(EFIAPI * | EFI_COPY_MEM) (IN VOID *Destination, IN VOID *Source, IN UINTN Length) |
| Copies the contents of one buffer to another buffer. More... | |
| 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. More... | |
| 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) |
| Installs a protocol interface on a device handle. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES) (IN OUT EFI_HANDLE *Handle,...) |
| Installs one or more protocol interfaces into the boot services environment. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_REINSTALL_PROTOCOL_INTERFACE) (IN EFI_HANDLE Handle, IN EFI_GUID *Protocol, IN VOID *OldInterface, IN VOID *NewInterface) |
| Reinstalls a protocol interface on a device handle. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_UNINSTALL_PROTOCOL_INTERFACE) (IN EFI_HANDLE Handle, IN EFI_GUID *Protocol, IN VOID *Interface) |
| Removes a protocol interface from a device handle. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES) (IN EFI_HANDLE Handle,...) |
| Removes one or more protocol interfaces into the boot services environment. More... | |
| 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. More... | |
| 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) |
| Queries a handle to determine if it supports a specified protocol. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_CLOSE_PROTOCOL) (IN EFI_HANDLE Handle, IN EFI_GUID *Protocol, IN EFI_HANDLE AgentHandle, IN EFI_HANDLE ControllerHandle) |
| Closes a protocol on a handle that was opened using OpenProtocol(). More... | |
| 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) |
| Retrieves the list of agents that currently have a protocol interface opened. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_PROTOCOLS_PER_HANDLE) (IN EFI_HANDLE Handle, OUT EFI_GUID ***ProtocolBuffer, OUT UINTN *ProtocolBufferCount) |
| Retrieves the list of protocol interface GUIDs that are installed on a handle in a buffer allocated from pool. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_REGISTER_PROTOCOL_NOTIFY) (IN EFI_GUID *Protocol, IN EFI_EVENT Event, OUT VOID **Registration) |
| Creates an event that is to be signaled whenever an interface is installed for a specified protocol. More... | |
| 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) |
| Returns an array of handles that support a specified protocol. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_LOCATE_DEVICE_PATH) (IN EFI_GUID *Protocol, IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath, OUT EFI_HANDLE *Device) |
| Locates the handle to a device on the device path that supports the specified protocol. More... | |
| 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. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_LOCATE_HANDLE_BUFFER) (IN EFI_LOCATE_SEARCH_TYPE SearchType, IN EFI_GUID *Protocol OPTIONAL, IN VOID *SearchKey OPTIONAL, OUT UINTN *NoHandles, OUT EFI_HANDLE **Buffer) |
| Returns an array of handles that support the requested protocol in a buffer allocated from pool. More... | |
| 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. More... | |
| 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. More... | |
| 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(). More... | |
| 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. More... | |
| typedef EFI_STATUS(EFIAPI * | EFI_IMAGE_ENTRY_POINT) (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable) |
| This is the declaration of an EFI image entry point. More... | |
| typedef struct _EFI_LOAD_OPTION | EFI_LOAD_OPTION |
Enumerations | |
| enum | EFI_ALLOCATE_TYPE { AllocateAnyPages, AllocateMaxAddress, AllocateAddress, MaxAllocateType } |
| Enumeration of EFI memory allocation types. More... | |
| enum | EFI_TIMER_DELAY { TimerCancel, TimerPeriodic, TimerRelative } |
| Timer delay types. More... | |
| enum | EFI_INTERFACE_TYPE { EFI_NATIVE_INTERFACE } |
| Enumeration of EFI Interface Types. More... | |
| enum | EFI_LOCATE_SEARCH_TYPE { AllHandles, ByRegisterNotify, ByProtocol } |
| Enumeration of EFI Locate Search Types. More... | |
Functions | |
| FILE_LICENCE (BSD2_PATENT) | |
Include file that supports UEFI.
This include file must contain things defined in the UEFI 2.7 specification. If a code construct is defined in the UEFI 2.7 specification it must be included by this include file.
Copyright (c) 2006 - 2021, Intel Corporation. All rights reserved.
Portions Copyright (c) 2020, Hewlett Packard Enterprise Development LP. All rights reserved.
Copyright (c) 2022, Loongson Technology Corporation Limited. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
Definition in file UefiSpec.h.
| #define EFI_TIME_ADJUST_DAYLIGHT 0x01 |
Definition at line 54 of file UefiSpec.h.
| #define EFI_TIME_IN_DAYLIGHT 0x02 |
Definition at line 55 of file UefiSpec.h.
| #define EFI_UNSPECIFIED_TIMEZONE 0x07FF |
Value definition for EFI_TIME.TimeZone.
Definition at line 60 of file UefiSpec.h.
| #define EFI_MEMORY_UC 0x0000000000000001ULL |
Definition at line 65 of file UefiSpec.h.
| #define EFI_MEMORY_WC 0x0000000000000002ULL |
Definition at line 66 of file UefiSpec.h.
| #define EFI_MEMORY_WT 0x0000000000000004ULL |
Definition at line 67 of file UefiSpec.h.
| #define EFI_MEMORY_WB 0x0000000000000008ULL |
Definition at line 68 of file UefiSpec.h.
| #define EFI_MEMORY_UCE 0x0000000000000010ULL |
Definition at line 69 of file UefiSpec.h.
| #define EFI_MEMORY_WP 0x0000000000001000ULL |
Definition at line 76 of file UefiSpec.h.
| #define EFI_MEMORY_RP 0x0000000000002000ULL |
Definition at line 77 of file UefiSpec.h.
| #define EFI_MEMORY_XP 0x0000000000004000ULL |
Definition at line 78 of file UefiSpec.h.
| #define EFI_MEMORY_RO 0x0000000000020000ULL |
Definition at line 79 of file UefiSpec.h.
| #define EFI_MEMORY_NV 0x0000000000008000ULL |
Definition at line 84 of file UefiSpec.h.
| #define EFI_MEMORY_MORE_RELIABLE 0x0000000000010000ULL |
Definition at line 89 of file UefiSpec.h.
| #define EFI_MEMORY_SP 0x0000000000040000ULL |
Definition at line 99 of file UefiSpec.h.
| #define EFI_MEMORY_CPU_CRYPTO 0x0000000000080000ULL |
Definition at line 108 of file UefiSpec.h.
| #define EFI_MEMORY_RUNTIME 0x8000000000000000ULL |
Definition at line 113 of file UefiSpec.h.
| #define EFI_MEMORY_ISA_VALID 0x4000000000000000ULL |
Definition at line 120 of file UefiSpec.h.
| #define EFI_MEMORY_ISA_MASK 0x0FFFF00000000000ULL |
Definition at line 128 of file UefiSpec.h.
| #define EFI_CACHE_ATTRIBUTE_MASK (EFI_MEMORY_UC | EFI_MEMORY_WC | EFI_MEMORY_WT | EFI_MEMORY_WB | EFI_MEMORY_UCE | EFI_MEMORY_WP) |
Definition at line 133 of file UefiSpec.h.
| #define EFI_MEMORY_ACCESS_MASK (EFI_MEMORY_RP | EFI_MEMORY_XP | EFI_MEMORY_RO) |
Definition at line 134 of file UefiSpec.h.
| #define EFI_MEMORY_ATTRIBUTE_MASK (EFI_MEMORY_ACCESS_MASK | EFI_MEMORY_SP | EFI_MEMORY_CPU_CRYPTO) |
Definition at line 135 of file UefiSpec.h.
| #define EFI_MEMORY_DESCRIPTOR_VERSION 1 |
Memory descriptor version number.
Definition at line 140 of file UefiSpec.h.
| #define EFI_OPTIONAL_PTR 0x00000001 |
Definition at line 408 of file UefiSpec.h.
| #define EVT_TIMER 0x80000000 |
Definition at line 440 of file UefiSpec.h.
| #define EVT_RUNTIME 0x40000000 |
Definition at line 441 of file UefiSpec.h.
| #define EVT_NOTIFY_WAIT 0x00000100 |
Definition at line 442 of file UefiSpec.h.
| #define EVT_NOTIFY_SIGNAL 0x00000200 |
Definition at line 443 of file UefiSpec.h.
| #define EVT_SIGNAL_EXIT_BOOT_SERVICES 0x00000201 |
Definition at line 445 of file UefiSpec.h.
| #define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE 0x60000202 |
Definition at line 446 of file UefiSpec.h.
| #define EVT_RUNTIME_CONTEXT 0x20000000 |
Definition at line 453 of file UefiSpec.h.
| #define TPL_APPLICATION 4 |
Definition at line 637 of file UefiSpec.h.
| #define TPL_CALLBACK 8 |
Definition at line 638 of file UefiSpec.h.
| #define TPL_NOTIFY 16 |
Definition at line 639 of file UefiSpec.h.
| #define TPL_HIGH_LEVEL 31 |
Definition at line 640 of file UefiSpec.h.
| #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001 |
Definition at line 1343 of file UefiSpec.h.
| #define EFI_OPEN_PROTOCOL_GET_PROTOCOL 0x00000002 |
Definition at line 1344 of file UefiSpec.h.
| #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL 0x00000004 |
Definition at line 1345 of file UefiSpec.h.
| #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008 |
Definition at line 1346 of file UefiSpec.h.
| #define EFI_OPEN_PROTOCOL_BY_DRIVER 0x00000010 |
Definition at line 1347 of file UefiSpec.h.
| #define EFI_OPEN_PROTOCOL_EXCLUSIVE 0x00000020 |
Definition at line 1348 of file UefiSpec.h.
| #define CAPSULE_FLAGS_PERSIST_ACROSS_RESET 0x00010000 |
Definition at line 1719 of file UefiSpec.h.
| #define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE 0x00020000 |
Definition at line 1720 of file UefiSpec.h.
| #define CAPSULE_FLAGS_INITIATE_RESET 0x00040000 |
Definition at line 1721 of file UefiSpec.h.
| #define EFI_OS_INDICATIONS_BOOT_TO_FW_UI 0x0000000000000001 |
Definition at line 1833 of file UefiSpec.h.
| #define EFI_OS_INDICATIONS_TIMESTAMP_REVOCATION 0x0000000000000002 |
Definition at line 1834 of file UefiSpec.h.
| #define EFI_OS_INDICATIONS_FILE_CAPSULE_DELIVERY_SUPPORTED 0x0000000000000004 |
Definition at line 1835 of file UefiSpec.h.
| #define EFI_OS_INDICATIONS_FMP_CAPSULE_SUPPORTED 0x0000000000000008 |
Definition at line 1836 of file UefiSpec.h.
| #define EFI_OS_INDICATIONS_CAPSULE_RESULT_VAR_SUPPORTED 0x0000000000000010 |
Definition at line 1837 of file UefiSpec.h.
| #define EFI_OS_INDICATIONS_START_PLATFORM_RECOVERY 0x0000000000000040 |
Definition at line 1838 of file UefiSpec.h.
| #define EFI_OS_INDICATIONS_JSON_CONFIG_DATA_REFRESH 0x0000000000000080 |
Definition at line 1839 of file UefiSpec.h.
| #define EFI_SYSTEM_TABLE_SIGNATURE SIGNATURE_64 ('I','B','I',' ','S','Y','S','T') |
Definition at line 1844 of file UefiSpec.h.
| #define EFI_2_80_SYSTEM_TABLE_REVISION ((2 << 16) | (80)) |
Definition at line 1845 of file UefiSpec.h.
| #define EFI_2_70_SYSTEM_TABLE_REVISION ((2 << 16) | (70)) |
Definition at line 1846 of file UefiSpec.h.
| #define EFI_2_60_SYSTEM_TABLE_REVISION ((2 << 16) | (60)) |
Definition at line 1847 of file UefiSpec.h.
| #define EFI_2_50_SYSTEM_TABLE_REVISION ((2 << 16) | (50)) |
Definition at line 1848 of file UefiSpec.h.
| #define EFI_2_40_SYSTEM_TABLE_REVISION ((2 << 16) | (40)) |
Definition at line 1849 of file UefiSpec.h.
| #define EFI_2_31_SYSTEM_TABLE_REVISION ((2 << 16) | (31)) |
Definition at line 1850 of file UefiSpec.h.
| #define EFI_2_30_SYSTEM_TABLE_REVISION ((2 << 16) | (30)) |
Definition at line 1851 of file UefiSpec.h.
| #define EFI_2_20_SYSTEM_TABLE_REVISION ((2 << 16) | (20)) |
Definition at line 1852 of file UefiSpec.h.
| #define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) | (10)) |
Definition at line 1853 of file UefiSpec.h.
| #define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | (00)) |
Definition at line 1854 of file UefiSpec.h.
| #define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | (10)) |
Definition at line 1855 of file UefiSpec.h.
| #define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | (02)) |
Definition at line 1856 of file UefiSpec.h.
| #define EFI_SYSTEM_TABLE_REVISION EFI_2_70_SYSTEM_TABLE_REVISION |
Definition at line 1857 of file UefiSpec.h.
| #define EFI_SPECIFICATION_VERSION EFI_SYSTEM_TABLE_REVISION |
Definition at line 1858 of file UefiSpec.h.
| #define EFI_RUNTIME_SERVICES_SIGNATURE SIGNATURE_64 ('R','U','N','T','S','E','R','V') |
Definition at line 1860 of file UefiSpec.h.
| #define EFI_RUNTIME_SERVICES_REVISION EFI_SPECIFICATION_VERSION |
Definition at line 1861 of file UefiSpec.h.
| #define EFI_BOOT_SERVICES_SIGNATURE SIGNATURE_64 ('B','O','O','T','S','E','R','V') |
Definition at line 1911 of file UefiSpec.h.
| #define EFI_BOOT_SERVICES_REVISION EFI_SPECIFICATION_VERSION |
Definition at line 1912 of file UefiSpec.h.
| #define LOAD_OPTION_ACTIVE 0x00000001 |
Definition at line 2163 of file UefiSpec.h.
| #define LOAD_OPTION_FORCE_RECONNECT 0x00000002 |
Definition at line 2164 of file UefiSpec.h.
| #define LOAD_OPTION_HIDDEN 0x00000008 |
Definition at line 2165 of file UefiSpec.h.
| #define LOAD_OPTION_CATEGORY 0x00001F00 |
Definition at line 2166 of file UefiSpec.h.
| #define LOAD_OPTION_CATEGORY_BOOT 0x00000000 |
Definition at line 2168 of file UefiSpec.h.
| #define LOAD_OPTION_CATEGORY_APP 0x00000100 |
Definition at line 2169 of file UefiSpec.h.
| #define EFI_BOOT_OPTION_SUPPORT_KEY 0x00000001 |
Definition at line 2171 of file UefiSpec.h.
| #define EFI_BOOT_OPTION_SUPPORT_APP 0x00000002 |
Definition at line 2172 of file UefiSpec.h.
| #define EFI_BOOT_OPTION_SUPPORT_SYSPREP 0x00000010 |
Definition at line 2173 of file UefiSpec.h.
| #define EFI_BOOT_OPTION_SUPPORT_COUNT 0x00000300 |
Definition at line 2174 of file UefiSpec.h.
| #define EFI_REMOVABLE_MEDIA_FILE_NAME_IA32 L"\\EFI\\BOOT\\BOOTIA32.EFI" |
Definition at line 2252 of file UefiSpec.h.
| #define EFI_REMOVABLE_MEDIA_FILE_NAME_IA64 L"\\EFI\\BOOT\\BOOTIA64.EFI" |
Definition at line 2253 of file UefiSpec.h.
| #define EFI_REMOVABLE_MEDIA_FILE_NAME_X64 L"\\EFI\\BOOT\\BOOTX64.EFI" |
Definition at line 2254 of file UefiSpec.h.
| #define EFI_REMOVABLE_MEDIA_FILE_NAME_ARM L"\\EFI\\BOOT\\BOOTARM.EFI" |
Definition at line 2255 of file UefiSpec.h.
| #define EFI_REMOVABLE_MEDIA_FILE_NAME_AARCH64 L"\\EFI\\BOOT\\BOOTAA64.EFI" |
Definition at line 2256 of file UefiSpec.h.
| #define EFI_REMOVABLE_MEDIA_FILE_NAME_RISCV64 L"\\EFI\\BOOT\\BOOTRISCV64.EFI" |
Definition at line 2257 of file UefiSpec.h.
| #define EFI_REMOVABLE_MEDIA_FILE_NAME_LOONGARCH64 L"\\EFI\\BOOT\\BOOTLOONGARCH64.EFI" |
Definition at line 2258 of file UefiSpec.h.
| #define EFI_CAPSULE_FILE_DIRECTORY L"\\EFI\\UpdateCapsule\\" |
Definition at line 2282 of file UefiSpec.h.
| 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) |
Allocates memory pages from the system.
| [in] | Type | The type of allocation to perform. |
| [in] | MemoryType | The type of memory to allocate. MemoryType values in the range 0x70000000..0x7FFFFFFF are reserved for OEM use. MemoryType values in the range 0x80000000..0xFFFFFFFF are reserved for use by UEFI OS loaders that are provided by operating system vendors. |
| [in] | Pages | The number of contiguous 4 KB pages to allocate. |
| [in,out] | Memory | The pointer to a physical address. On input, the way in which the address is used depends on the value of Type. |
| EFI_SUCCESS | The requested pages were allocated. |
| EFI_INVALID_PARAMETER | 1) Type is not AllocateAnyPages or AllocateMaxAddress or AllocateAddress. 2) MemoryType is in the range EfiMaxMemoryType..0x6FFFFFFF. 3) Memory is NULL. 4) MemoryType is EfiPersistentMemory. |
| EFI_OUT_OF_RESOURCES | The pages could not be allocated. |
| EFI_NOT_FOUND | The requested pages could not be found. |
Definition at line 205 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_FREE_PAGES) (IN EFI_PHYSICAL_ADDRESS Memory, IN UINTN Pages) |
Frees memory pages.
| [in] | Memory | The base physical address of the pages to be freed. |
| [in] | Pages | The number of contiguous 4 KB pages to free. |
| EFI_SUCCESS | The requested pages were freed. |
| EFI_INVALID_PARAMETER | Memory is not a page-aligned address or Pages is invalid. |
| EFI_NOT_FOUND | The requested memory pages were not allocated with AllocatePages(). |
Definition at line 226 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_GET_MEMORY_MAP) (IN OUT UINTN *MemoryMapSize, OUT EFI_MEMORY_DESCRIPTOR *MemoryMap, OUT UINTN *MapKey, OUT UINTN *DescriptorSize, OUT UINT32 *DescriptorVersion) |
Returns the current memory map.
| [in,out] | MemoryMapSize | A 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. |
| [out] | MemoryMap | A pointer to the buffer in which firmware places the current memory map. |
| [out] | MapKey | A pointer to the location in which firmware returns the key for the current memory map. |
| [out] | DescriptorSize | A pointer to the location in which firmware returns the size, in bytes, of an individual EFI_MEMORY_DESCRIPTOR. |
| [out] | DescriptorVersion | A pointer to the location in which firmware returns the version number associated with the EFI_MEMORY_DESCRIPTOR. |
| EFI_SUCCESS | The memory map was returned in the MemoryMap buffer. |
| EFI_BUFFER_TOO_SMALL | The MemoryMap buffer was too small. The current buffer size needed to hold the memory map is returned in MemoryMapSize. |
| EFI_INVALID_PARAMETER | 1) MemoryMapSize is NULL. 2) The MemoryMap buffer is not too small and MemoryMap is NULL. |
Definition at line 258 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.
| [in] | PoolType | The type of pool to allocate. MemoryType values in the range 0x70000000..0x7FFFFFFF are reserved for OEM use. MemoryType values in the range 0x80000000..0xFFFFFFFF are reserved for use by UEFI OS loaders that are provided by operating system vendors. |
| [in] | Size | The number of bytes to allocate from the pool. |
| [out] | Buffer | A pointer to a pointer to the allocated buffer if the call succeeds; undefined otherwise. |
| EFI_SUCCESS | The requested number of bytes was allocated. |
| EFI_OUT_OF_RESOURCES | The pool requested could not be allocated. |
| EFI_INVALID_PARAMETER | Buffer is NULL. PoolType is in the range EfiMaxMemoryType..0x6FFFFFFF. PoolType is EfiPersistentMemory. |
Definition at line 287 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_FREE_POOL) (IN VOID *Buffer) |
Returns pool memory to the system.
| [in] | Buffer | The pointer to the buffer to free. |
| EFI_SUCCESS | The memory was returned to the system. |
| EFI_INVALID_PARAMETER | Buffer was invalid. |
Definition at line 304 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_SET_VIRTUAL_ADDRESS_MAP) (IN UINTN MemoryMapSize, IN UINTN DescriptorSize, IN UINT32 DescriptorVersion, IN EFI_MEMORY_DESCRIPTOR *VirtualMap) |
Changes the runtime addressing mode of EFI firmware from physical to virtual.
| [in] | MemoryMapSize | The size in bytes of VirtualMap. |
| [in] | DescriptorSize | The size in bytes of an entry in the VirtualMap. |
| [in] | DescriptorVersion | The version of the structure entries in VirtualMap. |
| [in] | VirtualMap | An array of memory descriptors which contain new virtual address mapping information for all runtime ranges. |
| EFI_SUCCESS | The virtual address map has been applied. |
| EFI_UNSUPPORTED | EFI firmware is not at runtime, or the EFI firmware is already in virtual address mapped mode. |
| EFI_INVALID_PARAMETER | DescriptorSize or DescriptorVersion is invalid. |
| EFI_NO_MAPPING | A virtual address was not supplied for a range in the memory map that requires a mapping. |
| EFI_NOT_FOUND | A virtual address was supplied for an address that is not found in the memory map. |
| EFI_UNSUPPORTED | This call is not supported by this platform at the time the call is made. The platform should describe this runtime service as unsupported at runtime via an EFI_RT_PROPERTIES_TABLE configuration table. |
Definition at line 332 of file UefiSpec.h.
| 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) |
Connects one or more drivers to a controller.
| [in] | ControllerHandle | The handle of the controller to which driver(s) are to be connected. |
| [in] | DriverImageHandle | A pointer to an ordered list handles that support the EFI_DRIVER_BINDING_PROTOCOL. |
| [in] | RemainingDevicePath | A pointer to the device path that specifies a child of the controller specified by ControllerHandle. |
| [in] | Recursive | If 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. |
| EFI_SUCCESS | 1) 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_PARAMETER | ControllerHandle is NULL. |
| EFI_NOT_FOUND | 1) There are no EFI_DRIVER_BINDING_PROTOCOL instances present in the system. 2) No drivers were connected to ControllerHandle. |
| EFI_SECURITY_VIOLATION | The user has no permission to start UEFI device drivers on the device path associated with the ControllerHandle or specified by the RemainingDevicePath. |
Definition at line 366 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_DISCONNECT_CONTROLLER) (IN EFI_HANDLE ControllerHandle, IN EFI_HANDLE DriverImageHandle OPTIONAL, IN EFI_HANDLE ChildHandle OPTIONAL) |
Disconnects one or more drivers from a controller.
| [in] | ControllerHandle | The handle of the controller from which driver(s) are to be disconnected. |
| [in] | DriverImageHandle | The driver to disconnect from ControllerHandle. If DriverImageHandle is NULL, then all the drivers currently managing ControllerHandle are disconnected from ControllerHandle. |
| [in] | ChildHandle | The 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. |
| EFI_SUCCESS | 1) 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_PARAMETER | 1) 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_RESOURCES | There are not enough resources available to disconnect any drivers from ControllerHandle. |
| EFI_DEVICE_ERROR | The controller could not be disconnected because of a device error. |
Definition at line 399 of file UefiSpec.h.
Determines the new virtual address that is to be used on subsequent memory accesses.
| [in] | DebugDisposition | Supplies type information for the pointer being converted. |
| [in,out] | Address | A pointer to a pointer that is to be fixed to be the value needed for the new virtual address mappings being applied. |
| EFI_SUCCESS | The pointer pointed to by Address was modified. |
| EFI_NOT_FOUND | The pointer pointed to by Address was not found to be part of the current memory map. This is normally fatal. |
| EFI_INVALID_PARAMETER | Address is NULL. |
| EFI_INVALID_PARAMETER | *Address is NULL and DebugDisposition does not have the EFI_OPTIONAL_PTR bit set. |
| EFI_UNSUPPORTED | This call is not supported by this platform at the time the call is made. The platform should describe this runtime service as unsupported at runtime via an EFI_RT_PROPERTIES_TABLE configuration table. |
Definition at line 430 of file UefiSpec.h.
Invoke a notification event.
| [in] | Event | Event whose notification function is being invoked. |
| [in] | Context | The pointer to the notification function's context, which is implementation-dependent. |
Definition at line 465 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_CREATE_EVENT) (IN UINT32 Type, IN EFI_TPL NotifyTpl, IN EFI_EVENT_NOTIFY NotifyFunction OPTIONAL, IN VOID *NotifyContext OPTIONAL, OUT EFI_EVENT *Event) |
Creates an event.
| [in] | Type | The type of event to create and its mode and attributes. |
| [in] | NotifyTpl | The task priority level of event notifications, if needed. |
| [in] | NotifyFunction | The pointer to the event's notification function, if any. |
| [in] | NotifyContext | The pointer to the notification function's context; corresponds to parameter Context in the notification function. |
| [out] | Event | The pointer to the newly created event if the call succeeds; undefined otherwise. |
| EFI_SUCCESS | The event structure was created. |
| EFI_INVALID_PARAMETER | One or more parameters are invalid. |
| EFI_OUT_OF_RESOURCES | The event could not be allocated. |
Definition at line 488 of file UefiSpec.h.
| 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) |
Creates an event in a group.
| [in] | Type | The type of event to create and its mode and attributes. |
| [in] | NotifyTpl | The task priority level of event notifications,if needed. |
| [in] | NotifyFunction | The pointer to the event's notification function, if any. |
| [in] | NotifyContext | The pointer to the notification function's context; corresponds to parameter Context in the notification function. |
| [in] | EventGroup | The 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. |
| [out] | Event | The pointer to the newly created event if the call succeeds; undefined otherwise. |
| EFI_SUCCESS | The event structure was created. |
| EFI_INVALID_PARAMETER | One or more parameters are invalid. |
| EFI_OUT_OF_RESOURCES | The event could not be allocated. |
Definition at line 517 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_SET_TIMER) (IN EFI_EVENT Event, IN EFI_TIMER_DELAY Type, IN UINT64 TriggerTime) |
Sets the type of timer and the trigger time for a timer event.
| [in] | Event | The timer event that is to be signaled at the specified time. |
| [in] | Type | The type of time that is specified in TriggerTime. |
| [in] | TriggerTime | The 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. |
| EFI_SUCCESS | The event has been set to be signaled at the requested time. |
| EFI_INVALID_PARAMETER | Event or Type is not valid. |
Definition at line 562 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_SIGNAL_EVENT) (IN EFI_EVENT Event) |
Signals an event.
| [in] | Event | The event to signal. |
| EFI_SUCCESS | The event has been signaled. |
Definition at line 578 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_WAIT_FOR_EVENT) (IN UINTN NumberOfEvents, IN EFI_EVENT *Event, OUT UINTN *Index) |
Stops execution until an event is signaled.
| [in] | NumberOfEvents | The number of events in the Event array. |
| [in] | Event | An array of EFI_EVENT. |
| [out] | Index | The pointer to the index of the event which satisfied the wait condition. |
| EFI_SUCCESS | The event indicated by Index was signaled. |
| EFI_INVALID_PARAMETER | 1) NumberOfEvents is 0. 2) The event indicated by Index is of type EVT_NOTIFY_SIGNAL. |
| EFI_UNSUPPORTED | The current TPL is not TPL_APPLICATION. |
Definition at line 598 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_CLOSE_EVENT) (IN EFI_EVENT Event) |
Closes an event.
| [in] | Event | The event to close. |
| EFI_SUCCESS | The event has been closed. |
Definition at line 614 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_CHECK_EVENT) (IN EFI_EVENT Event) |
Checks whether an event is in the signaled state.
| [in] | Event | The event to check. |
| EFI_SUCCESS | The event is in the signaled state. |
| EFI_NOT_READY | The event is not in the signaled state. |
| EFI_INVALID_PARAMETER | Event is of type EVT_NOTIFY_SIGNAL. |
Definition at line 630 of file UefiSpec.h.
Raises a task's priority level and returns its previous level.
| [in] | NewTpl | The new task priority level. |
Definition at line 652 of file UefiSpec.h.
Restores a task's priority level to its previous value.
| [in] | OldTpl | The previous task priority level to restore. |
Definition at line 664 of file UefiSpec.h.
| 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 OPTIONAL) |
Returns the value of a variable.
| [in] | VariableName | A Null-terminated string that is the name of the vendor's variable. |
| [in] | VendorGuid | A unique identifier for the vendor. |
| [out] | Attributes | If not NULL, a pointer to the memory location to return the attributes bitmask for the variable. |
| [in,out] | DataSize | On input, the size in bytes of the return Data buffer. On output the size of data returned in Data. |
| [out] | Data | The buffer to return the contents of the variable. May be NULL with a zero DataSize in order to determine the size buffer needed. |
| EFI_SUCCESS | The function completed successfully. |
| EFI_NOT_FOUND | The variable was not found. |
| EFI_BUFFER_TOO_SMALL | The DataSize is too small for the result. |
| EFI_INVALID_PARAMETER | VariableName is NULL. |
| EFI_INVALID_PARAMETER | VendorGuid is NULL. |
| EFI_INVALID_PARAMETER | DataSize is NULL. |
| EFI_INVALID_PARAMETER | The DataSize is not too small and Data is NULL. |
| EFI_DEVICE_ERROR | The variable could not be retrieved due to a hardware error. |
| EFI_SECURITY_VIOLATION | The variable could not be retrieved due to an authentication failure. |
| EFI_UNSUPPORTED | After ExitBootServices() has been called, this return code may be returned if no variable storage is supported. The platform should describe this runtime service as unsupported at runtime via an EFI_RT_PROPERTIES_TABLE configuration table. |
Definition at line 698 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_GET_NEXT_VARIABLE_NAME) (IN OUT UINTN *VariableNameSize, IN OUT CHAR16 *VariableName, IN OUT EFI_GUID *VendorGuid) |
Enumerates the current variable names.
| [in,out] | VariableNameSize | The size of the VariableName buffer. The size must be large enough to fit input string supplied in VariableName buffer. |
| [in,out] | VariableName | On input, supplies the last VariableName that was returned by GetNextVariableName(). On output, returns the Nullterminated string of the current variable. |
| [in,out] | VendorGuid | On input, supplies the last VendorGuid that was returned by GetNextVariableName(). On output, returns the VendorGuid of the current variable. |
| EFI_SUCCESS | The function completed successfully. |
| EFI_NOT_FOUND | The next variable was not found. |
| EFI_BUFFER_TOO_SMALL | The VariableNameSize is too small for the result. VariableNameSize has been updated with the size needed to complete the request. |
| EFI_INVALID_PARAMETER | VariableNameSize is NULL. |
| EFI_INVALID_PARAMETER | VariableName is NULL. |
| EFI_INVALID_PARAMETER | VendorGuid is NULL. |
| EFI_INVALID_PARAMETER | The input values of VariableName and VendorGuid are not a name and GUID of an existing variable. |
| EFI_INVALID_PARAMETER | Null-terminator is not found in the first VariableNameSize bytes of the input VariableName buffer. |
| EFI_DEVICE_ERROR | The variable could not be retrieved due to a hardware error. |
| EFI_UNSUPPORTED | After ExitBootServices() has been called, this return code may be returned if no variable storage is supported. The platform should describe this runtime service as unsupported at runtime via an EFI_RT_PROPERTIES_TABLE configuration table. |
Definition at line 738 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_SET_VARIABLE) (IN CHAR16 *VariableName, IN EFI_GUID *VendorGuid, IN UINT32 Attributes, IN UINTN DataSize, IN VOID *Data) |
Sets the value of a variable.
| [in] | VariableName | A 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. |
| [in] | VendorGuid | A unique identifier for the vendor. |
| [in] | Attributes | Attributes bitmask to set for the variable. |
| [in] | DataSize | The size in bytes of the Data buffer. Unless the EFI_VARIABLE_APPEND_WRITE or EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS attribute is set, a size of zero causes the variable to be deleted. When the EFI_VARIABLE_APPEND_WRITE attribute is set, then a SetVariable() call with a DataSize of zero will not cause any change to the variable value (the timestamp associated with the variable may be updated however even if no new data value is provided,see the description of the EFI_VARIABLE_AUTHENTICATION_2 descriptor below. In this case the DataSize will not be zero since the EFI_VARIABLE_AUTHENTICATION_2 descriptor will be populated). |
| [in] | Data | The contents for the variable. |
| EFI_SUCCESS | The firmware has successfully stored the variable and its data as defined by the Attributes. |
| EFI_INVALID_PARAMETER | An invalid combination of attribute bits, name, and GUID was supplied, or the DataSize exceeds the maximum allowed. |
| EFI_INVALID_PARAMETER | VariableName is an empty string. |
| EFI_OUT_OF_RESOURCES | Not enough storage is available to hold the variable and its data. |
| EFI_DEVICE_ERROR | The variable could not be retrieved due to a hardware error. |
| EFI_WRITE_PROTECTED | The variable in question is read-only. |
| EFI_WRITE_PROTECTED | The variable in question cannot be deleted. |
| EFI_SECURITY_VIOLATION | The variable could not be written due to EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACESS being set, but the AuthInfo does NOT pass the validation check carried out by the firmware. |
| EFI_NOT_FOUND | The variable trying to be updated or deleted was not found. |
| EFI_UNSUPPORTED | This call is not supported by this platform at the time the call is made. The platform should describe this runtime service as unsupported at runtime via an EFI_RT_PROPERTIES_TABLE configuration table. |
Definition at line 783 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_GET_TIME) (OUT EFI_TIME *Time, OUT EFI_TIME_CAPABILITIES *Capabilities OPTIONAL) |
Returns the current time and date information, and the time-keeping capabilities of the hardware platform.
| [out] | Time | A pointer to storage to receive a snapshot of the current time. |
| [out] | Capabilities | An optional pointer to a buffer to receive the real time clock device's capabilities. |
| EFI_SUCCESS | The operation completed successfully. |
| EFI_INVALID_PARAMETER | Time is NULL. |
| EFI_DEVICE_ERROR | The time could not be retrieved due to hardware error. |
| EFI_UNSUPPORTED | This call is not supported by this platform at the time the call is made. The platform should describe this runtime service as unsupported at runtime via an EFI_RT_PROPERTIES_TABLE configuration table. |
Definition at line 838 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_SET_TIME) (IN EFI_TIME *Time) |
Sets the current local time and date information.
| [in] | Time | A pointer to the current time. |
| EFI_SUCCESS | The operation completed successfully. |
| EFI_INVALID_PARAMETER | A time field is out of range. |
| EFI_DEVICE_ERROR | The time could not be set due due to hardware error. |
| EFI_UNSUPPORTED | This call is not supported by this platform at the time the call is made. The platform should describe this runtime service as unsupported at runtime via an EFI_RT_PROPERTIES_TABLE configuration table. |
Definition at line 858 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_GET_WAKEUP_TIME) (OUT BOOLEAN *Enabled, OUT BOOLEAN *Pending, OUT EFI_TIME *Time) |
Returns the current wakeup alarm clock setting.
| [out] | Enabled | Indicates if the alarm is currently enabled or disabled. |
| [out] | Pending | Indicates if the alarm signal is pending and requires acknowledgement. |
| [out] | Time | The current alarm setting. |
| EFI_SUCCESS | The alarm settings were returned. |
| EFI_INVALID_PARAMETER | Enabled is NULL. |
| EFI_INVALID_PARAMETER | Pending is NULL. |
| EFI_INVALID_PARAMETER | Time is NULL. |
| EFI_DEVICE_ERROR | The wakeup time could not be retrieved due to a hardware error. |
| EFI_UNSUPPORTED | This call is not supported by this platform at the time the call is made. The platform should describe this runtime service as unsupported at runtime via an EFI_RT_PROPERTIES_TABLE configuration table. |
Definition at line 881 of file UefiSpec.h.
Sets the system wakeup alarm clock time.
| [in] | Enable | Enable or disable the wakeup alarm. |
| [in] | Time | If Enable is TRUE, the time to set the wakeup alarm for. If Enable is FALSE, then this parameter is optional, and may be NULL. |
| EFI_SUCCESS | If Enable is TRUE, then the wakeup alarm was enabled. If Enable is FALSE, then the wakeup alarm was disabled. |
| EFI_INVALID_PARAMETER | A time field is out of range. |
| EFI_DEVICE_ERROR | The wakeup time could not be set due to a hardware error. |
| EFI_UNSUPPORTED | This call is not supported by this platform at the time the call is made. The platform should describe this runtime service as unsupported at runtime via an EFI_RT_PROPERTIES_TABLE configuration table. |
Definition at line 905 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_IMAGE_LOAD) (IN BOOLEAN BootPolicy, IN EFI_HANDLE ParentImageHandle, IN EFI_DEVICE_PATH_PROTOCOL *DevicePath OPTIONAL, IN VOID *SourceBuffer OPTIONAL, IN UINTN SourceSize, OUT EFI_HANDLE *ImageHandle) |
Loads an EFI image into memory.
| [in] | BootPolicy | If 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. |
| [in] | ParentImageHandle | The caller's image handle. |
| [in] | DevicePath | The DeviceHandle specific file path from which the image is loaded. |
| [in] | SourceBuffer | If not NULL, a pointer to the memory location containing a copy of the image to be loaded. |
| [in] | SourceSize | The size in bytes of SourceBuffer. Ignored if SourceBuffer is NULL. |
| [out] | ImageHandle | The pointer to the returned image handle that is created when the image is successfully loaded. |
| EFI_SUCCESS | Image was loaded into memory correctly. |
| EFI_NOT_FOUND | Both SourceBuffer and DevicePath are NULL. |
| EFI_INVALID_PARAMETER | One or more parametes are invalid. |
| EFI_UNSUPPORTED | The image type is not supported. |
| EFI_OUT_OF_RESOURCES | Image was not loaded due to insufficient resources. |
| EFI_LOAD_ERROR | Image was not loaded because the image format was corrupt or not understood. |
| EFI_DEVICE_ERROR | Image was not loaded because the device returned a read error. |
| EFI_ACCESS_DENIED | Image was not loaded because the platform policy prohibits the image from being loaded. NULL is returned in *ImageHandle. |
| EFI_SECURITY_VIOLATION | Image 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 942 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.
| [in] | ImageHandle | Handle of image to be started. |
| [out] | ExitDataSize | The pointer to the size, in bytes, of ExitData. |
| [out] | ExitData | The pointer to a pointer to a data buffer that includes a Null-terminated string, optionally followed by additional binary data. |
| EFI_INVALID_PARAMETER | ImageHandle is either an invalid image handle or the image has already been initialized with StartImage. |
| EFI_SECURITY_VIOLATION | The current platform policy specifies that the image should not be started. |
Definition at line 967 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_EXIT) (IN EFI_HANDLE ImageHandle, IN EFI_STATUS ExitStatus, IN UINTN ExitDataSize, IN CHAR16 *ExitData OPTIONAL) |
Terminates a loaded EFI image and returns control to boot services.
| [in] | ImageHandle | Handle that identifies the image. This parameter is passed to the image on entry. |
| [in] | ExitStatus | The image's exit code. |
| [in] | ExitDataSize | The size, in bytes, of ExitData. Ignored if ExitStatus is EFI_SUCCESS. |
| [in] | ExitData | The 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(). |
| EFI_SUCCESS | The image specified by ImageHandle was unloaded. |
| EFI_INVALID_PARAMETER | The 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 995 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_IMAGE_UNLOAD) (IN EFI_HANDLE ImageHandle) |
Unloads an image.
| [in] | ImageHandle | Handle that identifies the image to be unloaded. |
| EFI_SUCCESS | The image has been unloaded. |
| EFI_INVALID_PARAMETER | ImageHandle is not a valid image handle. |
Definition at line 1013 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_EXIT_BOOT_SERVICES) (IN EFI_HANDLE ImageHandle, IN UINTN MapKey) |
Terminates all boot services.
| [in] | ImageHandle | Handle that identifies the exiting image. |
| [in] | MapKey | Key to the latest memory map. |
| EFI_SUCCESS | Boot services have been terminated. |
| EFI_INVALID_PARAMETER | MapKey is incorrect. |
Definition at line 1029 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_STALL) (IN UINTN Microseconds) |
Induces a fine-grained stall.
| [in] | Microseconds | The number of microseconds to stall execution. |
| EFI_SUCCESS | Execution was stalled at least the requested number of Microseconds. |
Definition at line 1045 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_SET_WATCHDOG_TIMER) (IN UINTN Timeout, IN UINT64 WatchdogCode, IN UINTN DataSize, IN CHAR16 *WatchdogData OPTIONAL) |
Sets the system's watchdog timer.
| [in] | Timeout | The number of seconds to set the watchdog timer to. |
| [in] | WatchdogCode | The numeric code to log on a watchdog timer timeout event. |
| [in] | DataSize | The size, in bytes, of WatchdogData. |
| [in] | WatchdogData | A data buffer that includes a Null-terminated string, optionally followed by additional binary data. |
| EFI_SUCCESS | The timeout has been set. |
| EFI_INVALID_PARAMETER | The supplied WatchdogCode is invalid. |
| EFI_UNSUPPORTED | The system does not have a watchdog timer. |
| EFI_DEVICE_ERROR | The watchdog timer could not be programmed due to a hardware error. |
Definition at line 1067 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.
| [in] | ResetType | The type of reset to perform. |
| [in] | ResetStatus | The status code for the reset. |
| [in] | DataSize | The size, in bytes, of ResetData. |
| [in] | ResetData | For a ResetType of EfiResetCold, EfiResetWarm, or EfiResetShutdown the data buffer starts with 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 system reset. For a ResetType of EfiResetPlatformSpecific the data buffer also starts with a Null-terminated string that is followed by an EFI_GUID that describes the specific type of reset to perform. |
Definition at line 1091 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_GET_NEXT_MONOTONIC_COUNT) (OUT UINT64 *Count) |
Returns a monotonically increasing count for the platform.
| [out] | Count | The pointer to returned value. |
| EFI_SUCCESS | The next monotonic count was returned. |
| EFI_INVALID_PARAMETER | Count is NULL. |
| EFI_DEVICE_ERROR | The device is not functioning properly. |
Definition at line 1110 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.
| [out] | HighCount | The pointer to returned value. |
| EFI_SUCCESS | The next high monotonic count was returned. |
| EFI_INVALID_PARAMETER | HighCount is NULL. |
| EFI_DEVICE_ERROR | The device is not functioning properly. |
| EFI_UNSUPPORTED | This call is not supported by this platform at the time the call is made. The platform should describe this runtime service as unsupported at runtime via an EFI_RT_PROPERTIES_TABLE configuration table. |
Definition at line 1129 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.
| [in] | Data | A pointer to the buffer on which the 32-bit CRC is to be computed. |
| [in] | DataSize | The number of bytes in the buffer Data. |
| [out] | Crc32 | The 32-bit CRC that was computed for the data buffer specified by Data and DataSize. |
| EFI_SUCCESS | The 32-bit CRC was computed for the data buffer and returned in Crc32. |
| EFI_INVALID_PARAMETER | Data is NULL. |
| EFI_INVALID_PARAMETER | Crc32 is NULL. |
| EFI_INVALID_PARAMETER | DataSize is 0. |
Definition at line 1150 of file UefiSpec.h.
Copies the contents of one buffer to another buffer.
| [in] | Destination | The pointer to the destination buffer of the memory copy. |
| [in] | Source | The pointer to the source buffer of the memory copy. |
| [in] | Length | Number of bytes to copy from Source to Destination. |
Definition at line 1166 of file UefiSpec.h.
The SetMem() function fills a buffer with a specified value.
| [in] | Buffer | The pointer to the buffer to fill. |
| [in] | Size | Number of bytes in Buffer to fill. |
| [in] | Value | Value to fill Buffer with. |
Definition at line 1182 of file UefiSpec.h.
| 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) |
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()
| [in,out] | Handle | A pointer to the EFI_HANDLE on which the interface is to be installed. |
| [in] | Protocol | The numeric ID of the protocol interface. |
| [in] | InterfaceType | Indicates whether Interface is supplied in native form. |
| [in] | Interface | A pointer to the protocol interface. |
| EFI_SUCCESS | The protocol interface was installed. |
| EFI_OUT_OF_RESOURCES | Space for a new handle could not be allocated. |
| EFI_INVALID_PARAMETER | Handle is NULL. |
| EFI_INVALID_PARAMETER | Protocol is NULL. |
| EFI_INVALID_PARAMETER | InterfaceType is not EFI_NATIVE_INTERFACE. |
| EFI_INVALID_PARAMETER | Protocol is already installed on the handle specified by Handle. |
Definition at line 1220 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES) (IN OUT EFI_HANDLE *Handle,...) |
Installs one or more protocol interfaces into the boot services environment.
| [in,out] | Handle | The pointer to a handle to install the new protocol interfaces on, or a pointer to NULL if a new handle is to be allocated. |
| ... | A variable argument list containing pairs of protocol GUIDs and protocol interfaces. |
| EFI_SUCCESS | All the protocol interface was installed. |
| EFI_OUT_OF_RESOURCES | There was not enough memory in pool to install all the protocols. |
| EFI_ALREADY_STARTED | A Device Path Protocol instance was passed in that is already present in the handle database. |
| EFI_INVALID_PARAMETER | Handle is NULL. |
| EFI_INVALID_PARAMETER | Protocol is already installed on the handle specified by Handle. |
Definition at line 1245 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_REINSTALL_PROTOCOL_INTERFACE) (IN EFI_HANDLE Handle, IN EFI_GUID *Protocol, IN VOID *OldInterface, IN VOID *NewInterface) |
Reinstalls a protocol interface on a device handle.
| [in] | Handle | Handle on which the interface is to be reinstalled. |
| [in] | Protocol | The numeric ID of the interface. |
| [in] | OldInterface | A pointer to the old interface. NULL can be used if a structure is not associated with Protocol. |
| [in] | NewInterface | A pointer to the new interface. |
| EFI_SUCCESS | The protocol interface was reinstalled. |
| EFI_NOT_FOUND | The OldInterface on the handle was not found. |
| EFI_ACCESS_DENIED | The protocol interface could not be reinstalled, because OldInterface is still being used by a driver that will not release it. |
| EFI_INVALID_PARAMETER | Handle is NULL. |
| EFI_INVALID_PARAMETER | Protocol is NULL. |
Definition at line 1270 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_UNINSTALL_PROTOCOL_INTERFACE) (IN EFI_HANDLE Handle, IN EFI_GUID *Protocol, IN VOID *Interface) |
Removes a protocol interface from a device handle.
It is recommended that UninstallMultipleProtocolInterfaces() be used in place of UninstallProtocolInterface().
| [in] | Handle | The handle on which the interface was installed. |
| [in] | Protocol | The numeric ID of the interface. |
| [in] | Interface | A pointer to the interface. |
| EFI_SUCCESS | The interface was removed. |
| EFI_NOT_FOUND | The interface was not found. |
| EFI_ACCESS_DENIED | The interface was not removed because the interface is still being used by a driver. |
| EFI_INVALID_PARAMETER | Handle is NULL. |
| EFI_INVALID_PARAMETER | Protocol is NULL. |
Definition at line 1296 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES) (IN EFI_HANDLE Handle,...) |
Removes one or more protocol interfaces into the boot services environment.
| [in] | Handle | The handle to remove the protocol interfaces from. |
| ... | A variable argument list containing pairs of protocol GUIDs and protocol interfaces. |
| EFI_SUCCESS | All the protocol interfaces were removed. |
| EFI_INVALID_PARAMETER | One of the protocol interfaces was not previously installed on Handle. |
Definition at line 1315 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.
| [in] | Handle | The handle being queried. |
| [in] | Protocol | The published unique identifier of the protocol. |
| [out] | Interface | Supplies the address where a pointer to the corresponding Protocol Interface is returned. |
| EFI_SUCCESS | The interface information for the specified protocol was returned. |
| EFI_UNSUPPORTED | The device does not support the specified protocol. |
| EFI_INVALID_PARAMETER | Handle is NULL. |
| EFI_INVALID_PARAMETER | Protocol is NULL. |
| EFI_INVALID_PARAMETER | Interface is NULL. |
Definition at line 1337 of file UefiSpec.h.
| 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) |
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.
| [in] | Handle | The handle for the protocol interface that is being opened. |
| [in] | Protocol | The published unique identifier of the protocol. |
| [out] | Interface | Supplies the address where a pointer to the corresponding Protocol Interface is returned. |
| [in] | AgentHandle | The handle of the agent that is opening the protocol interface specified by Protocol and Interface. |
| [in] | ControllerHandle | If 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. |
| [in] | Attributes | The open mode of the protocol interface specified by Handle and Protocol. |
| EFI_SUCCESS | An item was added to the open list for the protocol interface, and the protocol interface was returned in Interface. |
| EFI_UNSUPPORTED | Handle does not support Protocol. |
| EFI_INVALID_PARAMETER | One or more parameters are invalid. |
| EFI_ACCESS_DENIED | Required attributes can't be supported in current environment. |
| EFI_ALREADY_STARTED | Item on the open list already has requierd attributes whose agent handle is the same as AgentHandle. |
Definition at line 1379 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_CLOSE_PROTOCOL) (IN EFI_HANDLE Handle, IN EFI_GUID *Protocol, IN EFI_HANDLE AgentHandle, IN EFI_HANDLE ControllerHandle) |
Closes a protocol on a handle that was opened using OpenProtocol().
| [in] | Handle | The handle for the protocol interface that was previously opened with OpenProtocol(), and is now being closed. |
| [in] | Protocol | The published unique identifier of the protocol. |
| [in] | AgentHandle | The handle of the agent that is closing the protocol interface. |
| [in] | ControllerHandle | If 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. |
| EFI_SUCCESS | The protocol instance was closed. |
| EFI_INVALID_PARAMETER | 1) 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_FOUND | 1) 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 1411 of file UefiSpec.h.
| 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) |
Retrieves the list of agents that currently have a protocol interface opened.
| [in] | Handle | The handle for the protocol interface that is being queried. |
| [in] | Protocol | The published unique identifier of the protocol. |
| [out] | EntryBuffer | A pointer to a buffer of open protocol information in the form of EFI_OPEN_PROTOCOL_INFORMATION_ENTRY structures. |
| [out] | EntryCount | A pointer to the number of entries in EntryBuffer. |
| EFI_SUCCESS | The open protocol information was returned in EntryBuffer, and the number of entries was returned EntryCount. |
| EFI_OUT_OF_RESOURCES | There are not enough resources available to allocate EntryBuffer. |
| EFI_NOT_FOUND | Handle does not support the protocol specified by Protocol. |
Definition at line 1445 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_PROTOCOLS_PER_HANDLE) (IN EFI_HANDLE Handle, OUT EFI_GUID ***ProtocolBuffer, OUT UINTN *ProtocolBufferCount) |
Retrieves the list of protocol interface GUIDs that are installed on a handle in a buffer allocated from pool.
| [in] | Handle | The handle from which to retrieve the list of protocol interface GUIDs. |
| [out] | ProtocolBuffer | A pointer to the list of protocol interface GUID pointers that are installed on Handle. |
| [out] | ProtocolBufferCount | A pointer to the number of GUID pointers present in ProtocolBuffer. |
| EFI_SUCCESS | The 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_RESOURCES | There is not enough pool memory to store the results. |
| EFI_INVALID_PARAMETER | Handle is NULL. |
| EFI_INVALID_PARAMETER | Handle is not a valid EFI_HANDLE. |
| EFI_INVALID_PARAMETER | ProtocolBuffer is NULL. |
| EFI_INVALID_PARAMETER | ProtocolBufferCount is NULL. |
Definition at line 1475 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_REGISTER_PROTOCOL_NOTIFY) (IN EFI_GUID *Protocol, IN EFI_EVENT Event, OUT VOID **Registration) |
Creates an event that is to be signaled whenever an interface is installed for a specified protocol.
| [in] | Protocol | The numeric ID of the protocol for which the event is to be registered. |
| [in] | Event | Event that is to be signaled whenever a protocol interface is registered for Protocol. |
| [out] | Registration | A pointer to a memory location to receive the registration value. |
| EFI_SUCCESS | The notification event has been registered. |
| EFI_OUT_OF_RESOURCES | Space for the notification event could not be allocated. |
| EFI_INVALID_PARAMETER | Protocol is NULL. |
| EFI_INVALID_PARAMETER | Event is NULL. |
| EFI_INVALID_PARAMETER | Registration is NULL. |
Definition at line 1498 of file UefiSpec.h.
| 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) |
Returns an array of handles that support a specified protocol.
| [in] | SearchType | Specifies which handle(s) are to be returned. |
| [in] | Protocol | Specifies the protocol to search by. |
| [in] | SearchKey | Specifies the search key. |
| [in,out] | BufferSize | On 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). |
| [out] | Buffer | The buffer in which the array is returned. |
| EFI_SUCCESS | The array of handles was returned. |
| EFI_NOT_FOUND | No handles match the search. |
| EFI_BUFFER_TOO_SMALL | The BufferSize is too small for the result. |
| EFI_INVALID_PARAMETER | SearchType is not a member of EFI_LOCATE_SEARCH_TYPE. |
| EFI_INVALID_PARAMETER | SearchType is ByRegisterNotify and SearchKey is NULL. |
| EFI_INVALID_PARAMETER | SearchType is ByProtocol and Protocol is NULL. |
| EFI_INVALID_PARAMETER | One or more matches are found and BufferSize is NULL. |
| EFI_INVALID_PARAMETER | BufferSize is large enough for the result and Buffer is NULL. |
Definition at line 1547 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_LOCATE_DEVICE_PATH) (IN EFI_GUID *Protocol, IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath, OUT EFI_HANDLE *Device) |
Locates the handle to a device on the device path that supports the specified protocol.
| [in] | Protocol | Specifies the protocol to search for. |
| [in,out] | DevicePath | On 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. |
| [out] | Device | A pointer to the returned device handle. |
| EFI_SUCCESS | The resulting handle was returned. |
| EFI_NOT_FOUND | No handles match the search. |
| EFI_INVALID_PARAMETER | Protocol is NULL. |
| EFI_INVALID_PARAMETER | DevicePath is NULL. |
| EFI_INVALID_PARAMETER | A handle matched the search and Device is NULL. |
Definition at line 1573 of file UefiSpec.h.
Adds, updates, or removes a configuration table entry from the EFI System Table.
| [in] | Guid | A pointer to the GUID for the entry to add, update, or remove. |
| [in] | Table | A pointer to the configuration table for the entry to add, update, or remove. May be NULL. |
| EFI_SUCCESS | The (Guid, Table) pair was added, updated, or removed. |
| EFI_NOT_FOUND | An attempt was made to delete a nonexistent entry. |
| EFI_INVALID_PARAMETER | Guid is NULL. |
| EFI_OUT_OF_RESOURCES | There is not enough memory available to complete the operation. |
Definition at line 1594 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, OUT UINTN *NoHandles, OUT EFI_HANDLE **Buffer) |
Returns an array of handles that support the requested protocol in a buffer allocated from pool.
| [in] | SearchType | Specifies which handle(s) are to be returned. |
| [in] | Protocol | Provides the protocol to search by. This parameter is only valid for a SearchType of ByProtocol. |
| [in] | SearchKey | Supplies the search key depending on the SearchType. |
| [out] | NoHandles | The number of handles returned in Buffer. |
| [out] | Buffer | A pointer to the buffer to return the requested array of handles that support Protocol. |
| EFI_SUCCESS | The array of handles was returned in Buffer, and the number of handles in Buffer was returned in NoHandles. |
| EFI_NOT_FOUND | No handles match the search. |
| EFI_OUT_OF_RESOURCES | There is not enough pool memory to store the matching results. |
| EFI_INVALID_PARAMETER | NoHandles is NULL. |
| EFI_INVALID_PARAMETER | Buffer is NULL. |
Definition at line 1620 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.
| [in] | Protocol | Provides the protocol to search for. |
| [in] | Registration | Optional registration key returned from RegisterProtocolNotify(). |
| [out] | Interface | On return, a pointer to the first interface that matches Protocol and Registration. |
| EFI_SUCCESS | A protocol instance matching Protocol was found and returned in Interface. |
| EFI_NOT_FOUND | No protocol instances were found that match Protocol and Registration. |
| EFI_INVALID_PARAMETER | Interface is NULL. Protocol is NULL. |
Definition at line 1647 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.
| [in] | CapsuleHeaderArray | Virtual pointer to an array of virtual pointers to the capsules being passed into update capsule. |
| [in] | CapsuleCount | Number of pointers to EFI_CAPSULE_HEADER in CaspuleHeaderArray. |
| [in] | ScatterGatherList | Physical pointer to a set of EFI_CAPSULE_BLOCK_DESCRIPTOR that describes the location in physical memory of a set of capsules. |
| EFI_SUCCESS | Valid capsule was passed. If CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set, the capsule has been successfully processed by the firmware. |
| EFI_INVALID_PARAMETER | CapsuleSize is NULL, or an incompatible set of flags were set in the capsule header. |
| EFI_INVALID_PARAMETER | CapsuleCount is 0. |
| EFI_DEVICE_ERROR | The capsule update was started, but failed due to a device error. |
| EFI_UNSUPPORTED | The capsule type is not supported on this platform. |
| EFI_OUT_OF_RESOURCES | When ExitBootServices() has been previously called this error indicates the capsule is compatible with this platform but is not capable of being submitted or processed in runtime. The caller may resubmit the capsule prior to ExitBootServices(). |
| EFI_OUT_OF_RESOURCES | When ExitBootServices() has not been previously called then this error indicates the capsule is compatible with this platform but there are insufficient resources to process. |
| EFI_UNSUPPORTED | This call is not supported by this platform at the time the call is made. The platform should describe this runtime service as unsupported at runtime via an EFI_RT_PROPERTIES_TABLE configuration table. |
Definition at line 1758 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().
| [in] | CapsuleHeaderArray | Virtual pointer to an array of virtual pointers to the capsules being passed into update capsule. |
| [in] | CapsuleCount | Number of pointers to EFI_CAPSULE_HEADER in CaspuleHeaderArray. |
| [out] | MaxiumCapsuleSize | On output the maximum size that UpdateCapsule() can support as an argument to UpdateCapsule() via CapsuleHeaderArray and ScatterGatherList. |
| [out] | ResetType | Returns the type of reset required for the capsule update. |
| EFI_SUCCESS | Valid answer returned. |
| EFI_UNSUPPORTED | The capsule type is not supported on this platform, and MaximumCapsuleSize and ResetType are undefined. |
| EFI_INVALID_PARAMETER | MaximumCapsuleSize is NULL. |
| EFI_OUT_OF_RESOURCES | When ExitBootServices() has been previously called this error indicates the capsule is compatible with this platform but is not capable of being submitted or processed in runtime. The caller may resubmit the capsule prior to ExitBootServices(). |
| EFI_OUT_OF_RESOURCES | When ExitBootServices() has not been previously called then this error indicates the capsule is compatible with this platform but there are insufficient resources to process. |
| EFI_UNSUPPORTED | This call is not supported by this platform at the time the call is made. The platform should describe this runtime service as unsupported at runtime via an EFI_RT_PROPERTIES_TABLE configuration table. |
Definition at line 1792 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.
| [in] | Attributes | Attributes bitmask to specify the type of variables on which to return information. |
| [out] | MaximumVariableStorageSize | On output the maximum size of the storage space available for the EFI variables associated with the attributes specified. |
| [out] | RemainingVariableStorageSize | Returns the remaining size of the storage space available for the EFI variables associated with the attributes specified. |
| [out] | MaximumVariableSize | Returns the maximum size of the individual EFI variables associated with the attributes specified. |
| EFI_SUCCESS | Valid answer returned. |
| EFI_INVALID_PARAMETER | An invalid combination of attribute bits was supplied |
| EFI_UNSUPPORTED | The attribute is not supported on this platform, and the MaximumVariableStorageSize, RemainingVariableStorageSize, MaximumVariableSize are undefined. |
Definition at line 1823 of file UefiSpec.h.
| typedef EFI_STATUS(EFIAPI * EFI_IMAGE_ENTRY_POINT) (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable) |
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.
| [in] | ImageHandle | The firmware allocated handle for the UEFI image. |
| [in] | SystemTable | A pointer to the EFI System Table. |
| EFI_SUCCESS | The operation completed successfully. |
| Others | An unexpected error occurred. |
Definition at line 2106 of file UefiSpec.h.
| typedef struct _EFI_LOAD_OPTION EFI_LOAD_OPTION |
| enum EFI_ALLOCATE_TYPE |
Enumeration of EFI memory allocation types.
Definition at line 31 of file UefiSpec.h.
| enum EFI_TIMER_DELAY |
Timer delay types.
Definition at line 529 of file UefiSpec.h.
| enum EFI_INTERFACE_TYPE |
Enumeration of EFI Interface Types.
| Enumerator | |
|---|---|
| EFI_NATIVE_INTERFACE | Indicates that the supplied protocol interface is supplied in native form. |
Definition at line 1191 of file UefiSpec.h.
Enumeration of EFI Locate Search Types.
Definition at line 1507 of file UefiSpec.h.
| FILE_LICENCE | ( | BSD2_PATENT | ) |
1.8.15