Expand description
UEFI System Integration
This header defines the structures and types of the surrounding system of an UEFI application. It contains the definitions of the system table, the runtime and boot services, as well as common types.
We do not document the behavior of each of these types and functions. They follow the UEFI specification, which does a well-enough job of documenting each. This file just provides you the rust definitions of each symbol and some limited hints on some pecularities.
Structs§
- Boot
Services - Capsule
Block Descriptor - Capsule
Header - Capsule
Result VariableFMP - Capsule
Result Variable Header - Configuration
Table - Conformance
Profiles Table - Memory
Attributes Table - Memory
Descriptor - Open
Protocol Information Entry - Properties
Table - RtProperties
Table - Runtime
Services - System
Table - Table
Header - Time
- Time
Capabilities - Variable
Authentication - Variable
Authentication2 - Variable
Authentication3 - Variable
Authentication3 Cert Id - Variable
Authentication3 Nonce
Constants§
- ACPI_
10_ TABLE_ GUID - ACPI_
20_ TABLE_ GUID - ACPI_
MEMORY_ NVS - ACPI_
RECLAIM_ MEMORY - ALLOCATE_
ADDRESS - ALLOCATE_
ANY_ PAGES - ALLOCATE_
MAX_ ADDRESS - ALL_
HANDLES - BOOT_
SERVICES_ CODE - BOOT_
SERVICES_ DATA - BOOT_
SERVICES_ REVISION - BOOT_
SERVICES_ SIGNATURE - BY_
PROTOCOL - BY_
REGISTER_ NOTIFY - CACHE_
ATTRIBUTE_ MASK - Mask of memory attributes that specify cacheability attributes. No symbol
is defined by the spec, but the attributes are annotated in the spec. Note
that
MEMORY_WP, despite its name, is treated as cacheability attribute. UseMEMORY_ROas replacement access attribute (see the spec for details). - CAPSULE_
FLAGS_ INITIATE_ RESET - CAPSULE_
FLAGS_ PERSIST_ ACROSS_ RESET - CAPSULE_
FLAGS_ POPULATE_ SYSTEM_ TABLE - CAPSULE_
REPORT_ GUID - CONFORMANCE_
PROFILES_ TABLE_ GUID - CONFORMANCE_
PROFILES_ TABLE_ VERSION - CONFORMANCE_
PROFILES_ UEFI_ SPEC_ GUID - CONVENTIONAL_
MEMORY - DTB_
TABLE_ GUID - EVENT_
GROUP_ AFTER_ READY_ TO_ BOOT - EVENT_
GROUP_ BEFORE_ EXIT_ BOOT_ SERVICES - EVENT_
GROUP_ EXIT_ BOOT_ SERVICES - EVENT_
GROUP_ MEMORY_ MAP_ CHANGE - EVENT_
GROUP_ READY_ TO_ BOOT - EVENT_
GROUP_ RESET_ SYSTEM - EVENT_
GROUP_ VIRTUAL_ ADDRESS_ CHANGE - EVT_
NOTIFY_ SIGNAL - EVT_
NOTIFY_ WAIT - EVT_
RUNTIME - EVT_
SIGNAL_ EXIT_ BOOT_ SERVICES - EVT_
SIGNAL_ VIRTUAL_ ADDRESS_ CHANGE - EVT_
TIMER - HARDWARE_
ERROR_ VARIABLE_ GUID - JSON_
CAPSULE_ DATA_ TABLE_ GUID - JSON_
CAPSULE_ RESULT_ TABLE_ GUID - JSON_
CONFIG_ DATA_ TABLE_ GUID - LOADER_
CODE - LOADER_
DATA - MEMORY_
ACCESS_ MASK - Mask of memory attributes that specify access protection attributes. No
symbol is defined by the spec, but the attributes are annotated in the
spec. Note that
MEMORY_WPis treated as cacheability attribute, and its access protection functionality is replaced byMEMORY_RO. - MEMORY_
ATTRIBUTES_ TABLE_ GUID - MEMORY_
ATTRIBUTES_ TABLE_ VERSION - MEMORY_
ATTRIBUTE_ MASK - Mask of memory attributes that specify properties of a memory region that can be managed via the CPU architecture protocol.
- MEMORY_
CPU_ CRYPTO - MEMORY_
DESCRIPTOR_ VERSION - MEMORY_
ISA_ MASK - MEMORY_
ISA_ VALID - MEMORY_
MAPPED_ IO - MEMORY_
MAPPED_ IO_ PORT_ SPACE - MEMORY_
MORE_ RELIABLE - MEMORY_
NV - MEMORY_
RO - MEMORY_
RP - MEMORY_
RUNTIME - MEMORY_
SP - MEMORY_
UC - MEMORY_
UCE - MEMORY_
WB - MEMORY_
WC - MEMORY_
WP - MEMORY_
WT - MEMORY_
XP - MPS_
TABLE_ GUID - NATIVE_
INTERFACE - OPEN_
PROTOCOL_ BY_ CHILD_ CONTROLLER - OPEN_
PROTOCOL_ BY_ DRIVER - OPEN_
PROTOCOL_ BY_ HANDLE_ PROTOCOL - OPEN_
PROTOCOL_ EXCLUSIVE - OPEN_
PROTOCOL_ GET_ PROTOCOL - OPEN_
PROTOCOL_ TEST_ PROTOCOL - OPTIONAL_
POINTER - OS_
INDICATIONS_ BOOT_ TO_ FW_ UI - OS_
INDICATIONS_ CAPSULE_ RESULT_ VAR_ SUPPORTED - OS_
INDICATIONS_ FILE_ CAPSULE_ DELIVERY_ SUPPORTED - OS_
INDICATIONS_ FMP_ CAPSULE_ SUPPORTED - OS_
INDICATIONS_ START_ OS_ RECOVERY - OS_
INDICATIONS_ START_ PLATFORM_ RECOVERY - OS_
INDICATIONS_ TIMESTAMP_ REVOCATION - PAL_
CODE - PERSISTENT_
MEMORY - PROPERTIES_
RUNTIME_ MEMORY_ PROTECTION_ NON_ EXECUTABLE_ PE_ DATA - PROPERTIES_
TABLE_ GUID - PROPERTIES_
TABLE_ VERSION - RESERVED_
MEMORY_ TYPE - RESET_
COLD - RESET_
PLATFORM_ SPECIFIC - RESET_
SHUTDOWN - RESET_
WARM - RT_
PROPERTIES_ TABLE_ GUID - RT_
PROPERTIES_ TABLE_ VERSION - RT_
SUPPORTED_ CONVERT_ POINTER - RT_
SUPPORTED_ GET_ NEXT_ HIGH_ MONOTONIC_ COUNT - RT_
SUPPORTED_ GET_ NEXT_ VARIABLE_ NAME - RT_
SUPPORTED_ GET_ TIME - RT_
SUPPORTED_ GET_ VARIABLE - RT_
SUPPORTED_ GET_ WAKEUP_ TIME - RT_
SUPPORTED_ QUERY_ CAPSULE_ CAPABILITIES - RT_
SUPPORTED_ QUERY_ VARIABLE_ INFO - RT_
SUPPORTED_ RESET_ SYSTEM - RT_
SUPPORTED_ SET_ TIME - RT_
SUPPORTED_ SET_ VARIABLE - RT_
SUPPORTED_ SET_ VIRTUAL_ ADDRESS_ MAP - RT_
SUPPORTED_ SET_ WAKEUP_ TIME - RT_
SUPPORTED_ UPDATE_ CAPSULE - RUNTIME_
SERVICES_ CODE - RUNTIME_
SERVICES_ DATA - RUNTIME_
SERVICES_ REVISION - RUNTIME_
SERVICES_ SIGNATURE - SAL_
SYSTEM_ TABLE_ GUID - SMBIO
S3_ TABLE_ GUID - SMBIOS_
TABLE_ GUID - SPECIFICATION_
REVISION - SYSTEM_
TABLE_ REVISION - SYSTEM_
TABLE_ REVISION_ 1_ 02 - SYSTEM_
TABLE_ REVISION_ 1_ 10 - SYSTEM_
TABLE_ REVISION_ 2_ 00 - SYSTEM_
TABLE_ REVISION_ 2_ 10 - SYSTEM_
TABLE_ REVISION_ 2_ 20 - SYSTEM_
TABLE_ REVISION_ 2_ 30 - SYSTEM_
TABLE_ REVISION_ 2_ 31 - SYSTEM_
TABLE_ REVISION_ 2_ 40 - SYSTEM_
TABLE_ REVISION_ 2_ 50 - SYSTEM_
TABLE_ REVISION_ 2_ 60 - SYSTEM_
TABLE_ REVISION_ 2_ 70 - SYSTEM_
TABLE_ SIGNATURE - TIMER_
CANCEL - TIMER_
PERIODIC - TIMER_
RELATIVE - TIME_
ADJUST_ DAYLIGHT - TIME_
IN_ DAYLIGHT - TPL_
APPLICATION - TPL_
CALLBACK - TPL_
HIGH_ LEVEL - TPL_
NOTIFY - UNACCEPTED_
MEMORY_ TYPE - UNSPECIFIED_
TIMEZONE - UNUSABLE_
MEMORY - VARIABLE_
APPEND_ WRITE - VARIABLE_
AUTHENTICATED_ WRITE_ ACCESS - VARIABLE_
AUTHENTICATION_ 3_ CERT_ ID_ SHA256 - VARIABLE_
AUTHENTICATION_ 3_ NONCE_ TYPE - VARIABLE_
AUTHENTICATION_ 3_ TIMESTAMP_ TYPE - VARIABLE_
BOOTSERVICE_ ACCESS - VARIABLE_
ENHANCED_ AUTHENTICATED_ ACCESS - VARIABLE_
HARDWARE_ ERROR_ RECORD - VARIABLE_
NON_ VOLATILE - VARIABLE_
RUNTIME_ ACCESS - VARIABLE_
TIME_ BASED_ AUTHENTICATED_ WRITE_ ACCESS
Type Aliases§
- Allocate
Type - Boot
Allocate Pages - Boot
Allocate Pool - Boot
Calculate Crc32 - Boot
Check Event - Boot
Close Event - Boot
Close Protocol - Boot
Connect Controller - Boot
Copy Mem - Boot
Create Event - Boot
Create Event Ex - Boot
Disconnect Controller - Boot
Exit - Boot
Exit Boot Services - Boot
Free Pages - Boot
Free Pool - Boot
GetMemory Map - Boot
GetNext Monotonic Count - Boot
Handle Protocol - Boot
Install Configuration Table - Boot
Install Multiple Protocol Interfaces - Boot
Install Protocol Interface - Boot
Load Image - Boot
Locate Device Path - Boot
Locate Handle - Boot
Locate Handle Buffer - Boot
Locate Protocol - Boot
Open Protocol - Boot
Open Protocol Information - Boot
Protocols PerHandle - Boot
Raise Tpl - Boot
Register Protocol Notify - Boot
Reinstall Protocol Interface - Boot
Restore Tpl - Boot
SetMem - Boot
SetTimer - Boot
SetWatchdog Timer - Boot
Signal Event - Boot
Stall - Boot
Start Image - Boot
Uninstall Multiple Protocol Interfaces - Boot
Uninstall Protocol Interface - Boot
Unload Image - Boot
Wait ForEvent - Event
Notify - Interface
Type - Locate
Search Type - Memory
Type - Reset
Type - Runtime
Convert Pointer - Runtime
GetNext High Mono Count - Runtime
GetNext Variable Name - Runtime
GetTime - Runtime
GetVariable - Runtime
GetWakeup Time - Runtime
Query Capsule Capabilities - Runtime
Query Variable Info - Runtime
Reset System - Runtime
SetTime - Runtime
SetVariable - Runtime
SetVirtual Address Map - Runtime
SetWakeup Time - Runtime
Update Capsule - Timer
Delay