4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Include file that supports UEFI.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This include file must contain things defined in the UEFI 2.3 specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If a code construct is defined in the UEFI 2.3 specification it must be included
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by this include file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials are licensed and made available under
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncthe terms and conditions of the BSD License that accompanies this distribution.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThe full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Enumeration of EFI memory allocation types.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Allocate any available range of pages that satisfies the request.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Allocate any available range of pages whose uppermost address is less than
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// or equal to a specified maximum address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Allocate pages at a specified address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Maximum enumeration value that may be used for bounds checking.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Bit definitions for EFI_TIME.Daylight
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Value definition for EFI_TIME.TimeZone.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Memory cacheability attributes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Physical memory protection attributes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Runtime memory attribute
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Memory descriptor version number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Definition of an EFI memory descriptor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Type of the memory region. See EFI_MEMORY_TYPE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Physical address of the first byte of the memory region. Must aligned
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// on a 4 KB boundary.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Virtual address of the first byte of the memory region. Must aligned
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// on a 4 KB boundary.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Number of 4KB pages in the memory region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Attributes of the memory region that describe the bit mask of capabilities
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// for that memory region, and not necessarily the current settings for that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// memory region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Allocates memory pages from the system.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Type The type of allocation to perform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MemoryType The type of memory to allocate.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Pages The number of contiguous 4 KB pages to allocate.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Memory The pointer to a physical address. On input, the way in which the address is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync used depends on the value of Type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The requested pages were allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER 1) Type is not AllocateAnyPages or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AllocateMaxAddress or AllocateAddress.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 2) MemoryType is in the range
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 3) Memory is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiMaxMemoryType..0x7FFFFFFF.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The pages could not be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The requested pages could not be found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Frees memory pages.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Memory The base physical address of the pages to be freed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Pages The number of contiguous 4 KB pages to free.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The requested pages were freed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Memory is not a page-aligned address or Pages is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The requested memory pages were not allocated with
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AllocatePages().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns the current memory map.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MemoryMapSize A pointer to the size, in bytes, of the MemoryMap buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync On input, this is the size of the buffer allocated by the caller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync On output, it is the size of the buffer returned by the firmware if
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the buffer was large enough, or the size of the buffer needed to contain
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the map if the buffer was too small.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MemoryMap A pointer to the buffer in which firmware places the current memory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MapKey A pointer to the location in which firmware returns the key for the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync current memory map.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DescriptorSize A pointer to the location in which firmware returns the size, in bytes, of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync an individual EFI_MEMORY_DESCRIPTOR.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DescriptorVersion A pointer to the location in which firmware returns the version number
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync associated with the EFI_MEMORY_DESCRIPTOR.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The memory map was returned in the MemoryMap buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TOO_SMALL The MemoryMap buffer was too small. The current buffer size
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync needed to hold the memory map is returned in MemoryMapSize.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER 1) MemoryMapSize is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 2) The MemoryMap buffer is not too small and MemoryMap is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Allocates pool memory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PoolType The type of pool to allocate.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Size The number of bytes to allocate from the pool.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer A pointer to a pointer to the allocated buffer if the call succeeds;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync undefined otherwise.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The requested number of bytes was allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The pool requested could not be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER PoolType was invalid or Buffer is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns pool memory to the system.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer The pointer to the buffer to free.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The memory was returned to the system.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Buffer was invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Changes the runtime addressing mode of EFI firmware from physical to virtual.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MemoryMapSize The size in bytes of VirtualMap.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DescriptorSize The size in bytes of an entry in the VirtualMap.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DescriptorVersion The version of the structure entries in VirtualMap.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VirtualMap An array of memory descriptors which contain new virtual
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync address mapping information for all runtime ranges.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The virtual address map has been applied.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED EFI firmware is not at runtime, or the EFI firmware is already in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync virtual address mapped mode.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER DescriptorSize or DescriptorVersion is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING A virtual address was not supplied for a range in the memory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync map that requires a mapping.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND A virtual address was supplied for an address that is not found
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in the memory map.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Connects one or more drivers to a controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ControllerHandle The handle of the controller to which driver(s) are to be connected.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DriverImageHandle A pointer to an ordered list handles that support the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_DRIVER_BINDING_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param RemainingDevicePath A pointer to the device path that specifies a child of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync controller specified by ControllerHandle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Recursive If TRUE, then ConnectController() is called recursively
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync until the entire tree of controllers below the controller specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by ControllerHandle have been created. If FALSE, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the tree of controllers is only expanded one level.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS 1) One or more drivers were connected to ControllerHandle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 2) No drivers were connected to ControllerHandle, but
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RemainingDevicePath is not NULL, and it is an End Device
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND 1) There are no EFI_DRIVER_BINDING_PROTOCOL instances
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync present in the system.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 2) No drivers were connected to ControllerHandle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Disconnects one or more drivers from a controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ControllerHandle The handle of the controller from which driver(s) are to be disconnected.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DriverImageHandle The driver to disconnect from ControllerHandle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If DriverImageHandle is NULL, then all the drivers currently managing
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ControllerHandle are disconnected from ControllerHandle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ChildHandle The handle of the child to destroy.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If ChildHandle is NULL, then all the children of ControllerHandle are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync destroyed before the drivers are disconnected from ControllerHandle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS 1) One or more drivers were disconnected from the controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 2) On entry, no drivers are managing ControllerHandle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 3) DriverImageHandle is not NULL, and on entry
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DriverImageHandle is not managing ControllerHandle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER 1) ControllerHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 2) DriverImageHandle is not NULL, and it is not a valid EFI_HANDLE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 3) ChildHandle is not NULL, and it is not a valid EFI_HANDLE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 4) DriverImageHandle does not support the EFI_DRIVER_BINDING_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There are not enough resources available to disconnect any drivers from
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ControllerHandle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The controller could not be disconnected because of a device error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// ConvertPointer DebugDisposition type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Determines the new virtual address that is to be used on subsequent memory accesses.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DebugDisposition Supplies type information for the pointer being converted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Address A pointer to a pointer that is to be fixed to be the value needed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for the new virtual address mappings being applied.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The pointer pointed to by Address was modified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER 1) Address is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 2) *Address is NULL and DebugDisposition does
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not have the EFI_OPTIONAL_PTR bit set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The pointer pointed to by Address was not found to be part
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the current memory map. This is normally fatal.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// These types can be ORed together as needed - for example,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// EVT_TIMER might be Ored with EVT_NOTIFY_WAIT or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// EVT_NOTIFY_SIGNAL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE 0x60000202
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// The event's NotifyContext pointer points to a runtime memory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// The event is deprecated in UEFI2.0 and later specifications.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Invoke a notification event
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Event Event whose notification function is being invoked.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Context The pointer to the notification function's context,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which is implementation-dependent.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Creates an event.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Type The type of event to create and its mode and attributes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NotifyTpl The task priority level of event notifications, if needed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NotifyFunction The pointer to the event's notification function, if any.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NotifyContext The pointer to the notification function's context; corresponds to parameter
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Context in the notification function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Event The pointer to the newly created event if the call succeeds; undefined
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The event structure was created.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The event could not be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Creates an event in a group.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Type The type of event to create and its mode and attributes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NotifyTpl The task priority level of event notifications,if needed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NotifyFunction The pointer to the event's notification function, if any.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NotifyContext The pointer to the notification function's context; corresponds to parameter
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Context in the notification function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param EventGroup The pointer to the unique identifier of the group to which this event belongs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If this is NULL, then the function behaves as if the parameters were passed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to CreateEvent.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Event The pointer to the newly created event if the call succeeds; undefined
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The event structure was created.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The event could not be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Timer delay types
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// An event's timer settings is to be cancelled and not trigger time is to be set/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// An event is to be signalled periodically at a specified interval from the current time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// An event is to be signalled once at a specified interval from the current time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sets the type of timer and the trigger time for a timer event.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Event The timer event that is to be signaled at the specified time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Type The type of time that is specified in TriggerTime.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param TriggerTime The number of 100ns units until the timer expires.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync A TriggerTime of 0 is legal.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Type is TimerRelative and TriggerTime is 0, then the timer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync event will be signaled on the next timer tick.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Type is TimerPeriodic and TriggerTime is 0, then the timer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync event will be signaled on every timer tick.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The event has been set to be signaled at the requested time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Event or Type is not valid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Signals an event.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Event The event to signal.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The event has been signaled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Stops execution until an event is signaled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NumberOfEvents The number of events in the Event array.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Event An array of EFI_EVENT.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Index The pointer to the index of the event which satisfied the wait condition.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The event indicated by Index was signaled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER 1) NumberOfEvents is 0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 2) The event indicated by Index is of type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EVT_NOTIFY_SIGNAL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The current TPL is not TPL_APPLICATION.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Closes an event.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Event The event to close.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The event has been closed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Checks whether an event is in the signaled state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Event The event to check.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The event is in the signaled state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY The event is not in the signaled state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Event is of type EVT_NOTIFY_SIGNAL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Task priority level
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Raises a task's priority level and returns its previous level.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NewTpl The new task priority level.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return Previous task priority level
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Restores a task's priority level to its previous value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param OldTpl The previous task priority level to restore.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns the value of a variable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VariableName A Null-terminated string that is the name of the vendor's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VendorGuid A unique identifier for the vendor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Attributes If not NULL, a pointer to the memory location to return the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync attributes bitmask for the variable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DataSize On input, the size in bytes of the return Data buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync On output the size of data returned in Data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Data The buffer to return the contents of the variable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The function completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The variable was not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER VariableName is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER VendorGuid is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER DataSize is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The DataSize is not too small and Data is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SECURITY_VIOLATION The variable could not be retrieved due to an authentication failure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Enumerates the current variable names.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VariableNameSize The size of the VariableName buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VariableName On input, supplies the last VariableName that was returned
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by GetNextVariableName(). On output, returns the Nullterminated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync string of the current variable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VendorGuid On input, supplies the last VendorGuid that was returned by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync GetNextVariableName(). On output, returns the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync VendorGuid of the current variable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The function completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The next variable was not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER VariableNameSize is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER VariableName is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER VendorGuid is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sets the value of a variable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VariableName A Null-terminated string that is the name of the vendor's variable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Each VariableName is unique for each VendorGuid. VariableName must
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync contain 1 or more characters. If VariableName is an empty string,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then EFI_INVALID_PARAMETER is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VendorGuid A unique identifier for the vendor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Attributes Attributes bitmask to set for the variable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DataSize The size in bytes of the Data buffer. A size of zero causes the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync variable to be deleted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Data The contents for the variable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync defined by the Attributes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied, or the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DataSize exceeds the maximum allowed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER VariableName is an empty string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_WRITE_PROTECTED The variable in question is read-only.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync set but the AuthInfo does NOT pass the validation check carried out
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by the firmware.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// This provides the capabilities of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// real time clock device as exposed through the EFI interfaces.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Provides the reporting resolution of the real-time clock device in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// counts per second. For a normal PC-AT CMOS RTC device, this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// value would be 1 Hz, or 1, to indicate that the device only reports
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the time to the resolution of 1 second.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Provides the timekeeping accuracy of the real-time clock in an
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// error rate of 1E-6 parts per million. For a clock with an accuracy
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// of 50 parts per million, the value in this field would be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// 50,000,000.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A TRUE indicates that a time set operation clears the device's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// time below the Resolution reporting level. A FALSE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// indicates that the state below the Resolution level of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// device is not cleared when the time is set. Normal PC-AT CMOS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// RTC devices set this value to FALSE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns the current time and date information, and the time-keeping capabilities
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the hardware platform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Time A pointer to storage to receive a snapshot of the current time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Capabilities An optional pointer to a buffer to receive the real time clock
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync device's capabilities.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The operation completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Time is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The time could not be retrieved due to hardware error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sets the current local time and date information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Time A pointer to the current time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The operation completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER A time field is out of range.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The time could not be set due due to hardware error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns the current wakeup alarm clock setting.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Enabled Indicates if the alarm is currently enabled or disabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Pending Indicates if the alarm signal is pending and requires acknowledgement.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Time The current alarm setting.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The alarm settings were returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Enabled is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Pending is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Time is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The wakeup time could not be retrieved due to a hardware error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sets the system wakeup alarm clock time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Enabled Enable or disable the wakeup alarm.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Time If Enable is TRUE, the time to set the wakeup alarm for.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Enable is FALSE, then this parameter is optional, and may be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS If Enable is TRUE, then the wakeup alarm was enabled. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Enable is FALSE, then the wakeup alarm was disabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER A time field is out of range.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The wakeup time could not be set due to a hardware error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Loads an EFI image into memory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BootPolicy If TRUE, indicates that the request originates from the boot
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync manager, and that the boot manager is attempting to load
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FilePath as a boot selection. Ignored if SourceBuffer is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ParentImageHandle The caller's image handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DevicePath The DeviceHandle specific file path from which the image is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SourceBuffer If not NULL, a pointer to the memory location containing a copy
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the image to be loaded.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SourceSize The size in bytes of SourceBuffer. Ignored if SourceBuffer is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ImageHandle The pointer to the returned image handle that is created when the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync image is successfully loaded.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Image was loaded into memory correctly.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND Both SourceBuffer and DevicePath are NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more parametes are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The image type is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_LOAD_ERROR Image was not loaded because the image format was corrupt or not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync understood.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR Image was not loaded because the device returned a read error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED Image was not loaded because the platform policy prohibits the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync image from being loaded. NULL is returned in *ImageHandle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SECURITY_VIOLATION Image was loaded and an ImageHandle was created with a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync valid EFI_LOADED_IMAGE_PROTOCOL. However, the current
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync platform policy specifies that the image should not be started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Transfers control to a loaded image's entry point.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ImageHandle Handle of image to be started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ExitDataSize The pointer to the size, in bytes, of ExitData.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ExitData The pointer to a pointer to a data buffer that includes a Null-terminated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync string, optionally followed by additional binary data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER ImageHandle is either an invalid image handle or the image
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync has already been initialized with StartImage.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return Exit code from image
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Terminates a loaded EFI image and returns control to boot services.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ImageHandle Handle that identifies the image. This parameter is passed to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync image on entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ExitStatus The image's exit code.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ExitDataSize The size, in bytes, of ExitData. Ignored if ExitStatus is EFI_SUCCESS.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ExitData The pointer to a data buffer that includes a Null-terminated string,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync optionally followed by additional binary data. The string is a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync description that the caller may use to further indicate the reason
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for the image's exit. ExitData is only valid if ExitStatus
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is something other than EFI_SUCCESS. The ExitData buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync must be allocated by calling AllocatePool().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The image specified by ImageHandle was unloaded.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The image specified by ImageHandle has been loaded and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync started with LoadImage() and StartImage(), but the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync image is not the currently executing image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Unloads an image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ImageHandle Handle that identifies the image to be unloaded.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The image has been unloaded.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER ImageHandle is not a valid image handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Terminates all boot services.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ImageHandle Handle that identifies the exiting image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MapKey Key to the latest memory map.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Boot services have been terminated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER MapKey is incorrect.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Induces a fine-grained stall.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Microseconds The number of microseconds to stall execution.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Execution was stalled at least the requested number of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Microseconds.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sets the system's watchdog timer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Timeout The number of seconds to set the watchdog timer to.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param WatchdogCode The numeric code to log on a watchdog timer timeout event.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DataSize The size, in bytes, of WatchdogData.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param WatchdogData A data buffer that includes a Null-terminated string, optionally
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync followed by additional binary data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The timeout has been set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The supplied WatchdogCode is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The system does not have a watchdog timer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The watchdog timer could not be programmed due to a hardware
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Enumeration of reset types.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Used to induce a system-wide reset. This sets all circuitry within the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// system to its initial state. This type of reset is asynchronous to system
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// operation and operates withgout regard to cycle boundaries. EfiColdReset
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// is tantamount to a system power cycle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Used to induce a system-wide initialization. The processors are set to their
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// initial state, and pending cycles are not corrupted. If the system does
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// not support this reset type, then an EfiResetCold must be performed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Used to induce an entry into a power state equivalent to the ACPI G2/S5 or G3
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// state. If the system does not support this reset type, then when the system
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// is rebooted, it should exhibit the EfiResetCold attributes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Resets the entire platform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ResetType The type of reset to perform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ResetStatus The status code for the reset.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DataSize The size, in bytes, of WatchdogData.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ResetData For a ResetType of EfiResetCold, EfiResetWarm, or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiResetShutdown the data buffer starts with a Null-terminated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync string, optionally followed by additional binary data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns a monotonically increasing count for the platform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Count The pointer to returned value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The next monotonic count was returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Count is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The device is not functioning properly.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns the next high 32 bits of the platform's monotonic counter.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param HighCount The pointer to returned value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The next high monotonic count was returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER HighCount is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The device is not functioning properly.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Computes and returns a 32-bit CRC for a data buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Data A pointer to the buffer on which the 32-bit CRC is to be computed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DataSize The number of bytes in the buffer Data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Crc32 The 32-bit CRC that was computed for the data buffer specified by Data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and DataSize.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The 32-bit CRC was computed for the data buffer and returned in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Data is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Crc32 is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER DataSize is 0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copies the contents of one buffer to another buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Destination The pointer to the destination buffer of the memory copy.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Source The pointer to the source buffer of the memory copy.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Length Number of bytes to copy from Source to Destination.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The SetMem() function fills a buffer with a specified value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer The pointer to the buffer to fill.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Size Number of bytes in Buffer to fill.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Value Value to fill Buffer with.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Enumeration of EFI Interface Types
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Indicates that the supplied protocol interface is supplied in native form.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Installs a protocol interface on a device handle. If the handle does not exist, it is created and added
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to the list of handles in the system. InstallMultipleProtocolInterfaces() performs
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync more error checking than InstallProtocolInterface(), so it is recommended that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync InstallMultipleProtocolInterfaces() be used in place of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync InstallProtocolInterface()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Handle A pointer to the EFI_HANDLE on which the interface is to be installed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Protocol The numeric ID of the protocol interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param InterfaceType Indicates whether Interface is supplied in native form.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Interface A pointer to the protocol interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The protocol interface was installed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Space for a new handle could not be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Handle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Protocol is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER InterfaceType is not EFI_NATIVE_INTERFACE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Protocol is already installed on the handle specified by Handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Installs one or more protocol interfaces into the boot services environment.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Handle The handle to install the new protocol interfaces on, or NULL if a new
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync handle is to be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ... A variable argument list containing pairs of protocol GUIDs and protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync interfaces.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS All the protocol interface was installed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ALREADY_STARTED A Device Path Protocol instance was passed in that is already present in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the handle database.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Reinstalls a protocol interface on a device handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Handle Handle on which the interface is to be reinstalled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Protocol The numeric ID of the interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param OldInterface A pointer to the old interface. NULL can be used if a structure is not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync associated with Protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NewInterface A pointer to the new interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The protocol interface was reinstalled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The OldInterface on the handle was not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The protocol interface could not be reinstalled,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync because OldInterface is still being used by a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync driver that will not release it.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Handle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Protocol is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Removes a protocol interface from a device handle. It is recommended that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UninstallMultipleProtocolInterfaces() be used in place of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UninstallProtocolInterface().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Handle The handle on which the interface was installed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Protocol The numeric ID of the interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Interface A pointer to the interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The interface was removed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The interface was not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The interface was not removed because the interface
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is still being used by a driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Handle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Protocol is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Removes one or more protocol interfaces into the boot services environment.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Handle The handle to remove the protocol interfaces from.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ... A variable argument list containing pairs of protocol GUIDs and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync protocol interfaces.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS All the protocol interfaces were removed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One of the protocol interfaces was not previously installed on Handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync(EFIAPI *EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES)(
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Queries a handle to determine if it supports a specified protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Handle The handle being queried.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Protocol The published unique identifier of the protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Interface Supplies the address where a pointer to the corresponding Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Interface is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The interface information for the specified protocol was returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The device does not support the specified protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Handle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Protocol is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Interface is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Queries a handle to determine if it supports a specified protocol. If the protocol is supported by the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync handle, it opens the protocol on behalf of the calling agent.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Handle The handle for the protocol interface that is being opened.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Protocol The published unique identifier of the protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Interface Supplies the address where a pointer to the corresponding Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Interface is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param AgentHandle The handle of the agent that is opening the protocol interface
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by Protocol and Interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ControllerHandle If the agent that is opening a protocol is a driver that follows the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UEFI Driver Model, then this parameter is the controller handle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync that requires the protocol interface. If the agent does not follow
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the UEFI Driver Model, then this parameter is optional and may
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Attributes The open mode of the protocol interface specified by Handle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and Protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS An item was added to the open list for the protocol interface, and the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync protocol interface was returned in Interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED Handle does not support Protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED Required attributes can't be supported in current environment.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ALREADY_STARTED Item on the open list already has requierd attributes whose agent
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync handle is the same as AgentHandle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Closes a protocol on a handle that was opened using OpenProtocol().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Handle The handle for the protocol interface that was previously opened
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync with OpenProtocol(), and is now being closed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Protocol The published unique identifier of the protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param AgentHandle The handle of the agent that is closing the protocol interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ControllerHandle If the agent that opened a protocol is a driver that follows the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UEFI Driver Model, then this parameter is the controller handle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync that required the protocol interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The protocol instance was closed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER 1) Handle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 2) AgentHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 3) ControllerHandle is not NULL and ControllerHandle is not a valid EFI_HANDLE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 4) Protocol is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND 1) Handle does not support the protocol specified by Protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 2) The protocol interface specified by Handle and Protocol is not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync currently open by AgentHandle and ControllerHandle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI Oprn Protocol Information Entry
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves the list of agents that currently have a protocol interface opened.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Handle The handle for the protocol interface that is being queried.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Protocol The published unique identifier of the protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param EntryBuffer A pointer to a buffer of open protocol information in the form of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_OPEN_PROTOCOL_INFORMATION_ENTRY structures.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param EntryCount A pointer to the number of entries in EntryBuffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The open protocol information was returned in EntryBuffer, and the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync number of entries was returned EntryCount.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There are not enough resources available to allocate EntryBuffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND Handle does not support the protocol specified by Protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT EFI_OPEN_PROTOCOL_INFORMATION_ENTRY **EntryBuffer,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves the list of protocol interface GUIDs that are installed on a handle in a buffer allocated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Handle The handle from which to retrieve the list of protocol interface
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ProtocolBuffer A pointer to the list of protocol interface GUID pointers that are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync installed on Handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ProtocolBufferCount A pointer to the number of GUID pointers present in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ProtocolBuffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The list of protocol interface GUIDs installed on Handle was returned in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ProtocolBuffer. The number of protocol interface GUIDs was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returned in ProtocolBufferCount.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the results.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Handle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER ProtocolBuffer is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER ProtocolBufferCount is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Creates an event that is to be signaled whenever an interface is installed for a specified protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Protocol The numeric ID of the protocol for which the event is to be registered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Event Event that is to be signaled whenever a protocol interface is registered
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for Protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Registration A pointer to a memory location to receive the registration value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The notification event has been registered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Space for the notification event could not be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Protocol is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Event is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Registration is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Enumeration of EFI Locate Search Types
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Retrieve all the handles in the handle database.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Retrieve the next handle fron a RegisterProtocolNotify() event.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Retrieve the set of handles from the handle database that support a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// specified protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns an array of handles that support a specified protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SearchType Specifies which handle(s) are to be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Protocol Specifies the protocol to search by.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SearchKey Specifies the search key.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BufferSize On input, the size in bytes of Buffer. On output, the size in bytes of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the array returned in Buffer (if the buffer was large enough) or the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync size, in bytes, of the buffer needed to obtain the array (if the buffer was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not large enough).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer The buffer in which the array is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The array of handles was returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND No handles match the search.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER SearchType is not a member of EFI_LOCATE_SEARCH_TYPE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER SearchType is ByRegisterNotify and SearchKey is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER SearchType is ByProtocol and Protocol is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more matches are found and BufferSize is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER BufferSize is large enough for the result and Buffer is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Locates the handle to a device on the device path that supports the specified protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Protocol Specifies the protocol to search for.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DevicePath On input, a pointer to a pointer to the device path. On output, the device
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync path pointer is modified to point to the remaining part of the device
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Device A pointer to the returned device handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The resulting handle was returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND No handles match the search.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Protocol is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER DevicePath is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER A handle matched the search and Device is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Adds, updates, or removes a configuration table entry from the EFI System Table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Guid A pointer to the GUID for the entry to add, update, or remove.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Table A pointer to the configuration table for the entry to add, update, or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync remove. May be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The (Guid, Table) pair was added, updated, or removed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND An attempt was made to delete a nonexistent entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Guid is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There is not enough memory available to complete the operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns an array of handles that support the requested protocol in a buffer allocated from pool.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SearchType Specifies which handle(s) are to be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Protocol Provides the protocol to search by.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This parameter is only valid for a SearchType of ByProtocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SearchKey Supplies the search key depending on the SearchType.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NoHandles The number of handles returned in Buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer A pointer to the buffer to return the requested array of handles that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync support Protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The array of handles was returned in Buffer, and the number of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync handles in Buffer was returned in NoHandles.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND No handles match the search.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the matching results.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER NoHandles is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Buffer is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns the first protocol instance that matches the given protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Protocol Provides the protocol to search for.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Registration Optional registration key returned from
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RegisterProtocolNotify().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Interface On return, a pointer to the first interface that matches Protocol and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Registration.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS A protocol instance matching Protocol was found and returned in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND No protocol instances were found that match Protocol and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Registration.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Interface is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI Capsule Block Descriptor
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Length in bytes of the data pointed to by DataBlock/ContinuationPointer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Physical address of the data block. This member of the union is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// used if Length is not equal to zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Physical address of another block of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_CAPSULE_BLOCK_DESCRIPTOR structures. This
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// member of the union is used if Length is equal to zero. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// ContinuationPointer is zero this entry represents the end of the list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI Capsule Header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A GUID that defines the contents of a capsule.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The size of the capsule header. This may be larger than the size of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the EFI_CAPSULE_HEADER since CapsuleGuid may imply
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// extended header entries
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Bit-mapped list describing the capsule attributes. The Flag values
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// of 0x0000 - 0xFFFF are defined by CapsuleGuid. Flag values
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// of 0x10000 - 0xFFFFFFFF are defined by this specification
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Size in bytes of the capsule.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The EFI System Table entry must point to an array of capsules
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// that contain the same CapsuleGuid value. The array must be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// prefixed by a UINT32 that represents the size of the array of capsules.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the size of the array of capsules.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Point to an array of capsules that contain the same CapsuleGuid value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define CAPSULE_FLAGS_PERSIST_ACROSS_RESET 0x00010000
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE 0x00020000
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Passes capsules to the firmware with both virtual and physical mapping. Depending on the intended
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync consumption, the firmware may process the capsule immediately. If the payload should persist
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync across a system reset, the reset value returned from EFI_QueryCapsuleCapabilities must
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be passed into ResetSystem() and will cause the capsule to be processed by the firmware as
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync part of the reset process.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync being passed into update capsule.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CaspuleHeaderArray.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ScatterGatherList Physical pointer to a set of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_CAPSULE_BLOCK_DESCRIPTOR that describes the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync location in physical memory of a set of capsules.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Valid capsule was passed. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set, the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync capsule has been successfully processed by the firmware.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER CapsuleSize is NULL, or an incompatible set of flags were
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync set in the capsule header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER CapsuleCount is 0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The capsule update was started, but failed due to a device error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The capsule type is not supported on this platform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There were insufficient resources to process the capsule.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns if the capsule can be supported via UpdateCapsule().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync being passed into update capsule.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CaspuleHeaderArray.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MaxiumCapsuleSize On output the maximum size that UpdateCapsule() can
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync support as an argument to UpdateCapsule() via
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CapsuleHeaderArray and ScatterGatherList.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ResetType Returns the type of reset required for the capsule update.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Valid answer returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The capsule type is not supported on this platform, and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MaximumCapsuleSize and ResetType are undefined.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There were insufficient resources to process the query request.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns information about the EFI variables.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Attributes Attributes bitmask to specify the type of variables on
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which to return information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MaximumVariableStorageSize On output the maximum size of the storage space
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync available for the EFI variables associated with the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync attributes specified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param RemainingVariableStorageSize Returns the remaining size of the storage space
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync available for the EFI variables associated with the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync attributes specified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MaximumVariableSize Returns the maximum size of the individual EFI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync variables associated with the attributes specified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Valid answer returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The attribute is not supported on this platform, and the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MaximumVariableStorageSize,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RemainingVariableStorageSize, MaximumVariableSize
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are undefined.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// EFI Runtime Services Table
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_SYSTEM_TABLE_SIGNATURE SIGNATURE_64 ('I','B','I',' ','S','Y','S','T')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_2_31_SYSTEM_TABLE_REVISION ((2 << 16) | (31))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_2_30_SYSTEM_TABLE_REVISION ((2 << 16) | (30))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_2_20_SYSTEM_TABLE_REVISION ((2 << 16) | (20))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) | (10))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | (00))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | (10))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | (02))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_SYSTEM_TABLE_REVISION EFI_2_31_SYSTEM_TABLE_REVISION
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_RUNTIME_SERVICES_SIGNATURE SIGNATURE_64 ('R','U','N','T','S','E','R','V')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_RUNTIME_SERVICES_REVISION EFI_2_31_SYSTEM_TABLE_REVISION
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI Runtime Services Table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The table header for the EFI Runtime Services Table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Time Services
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Virtual Memory Services
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Variable Services
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Miscellaneous Services
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_GET_NEXT_HIGH_MONO_COUNT GetNextHighMonotonicCount;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // UEFI 2.0 Capsule Services
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_QUERY_CAPSULE_CAPABILITIES QueryCapsuleCapabilities;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Miscellaneous UEFI 2.0 Service
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_BOOT_SERVICES_SIGNATURE SIGNATURE_64 ('B','O','O','T','S','E','R','V')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_BOOT_SERVICES_REVISION EFI_2_31_SYSTEM_TABLE_REVISION
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI Boot Services Table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The table header for the EFI Boot Services Table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Task Priority Services
65e438608a60500a86a843c3d0d363b73a54b7f7vboxsync/* 64: 3*8 */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Memory Services
65e438608a60500a86a843c3d0d363b73a54b7f7vboxsync/* 64: 5*8 */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Event & Timer Services
65e438608a60500a86a843c3d0d363b73a54b7f7vboxsync/* 64: 10*8 = 0x50 (80) */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Protocol Handler Services
65e438608a60500a86a843c3d0d363b73a54b7f7vboxsync/* 64: 16*8 = 0x80 (128) */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_INSTALL_PROTOCOL_INTERFACE InstallProtocolInterface;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_REINSTALL_PROTOCOL_INTERFACE ReinstallProtocolInterface;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_UNINSTALL_PROTOCOL_INTERFACE UninstallProtocolInterface;
65e438608a60500a86a843c3d0d363b73a54b7f7vboxsync/* 64: 20*8 = 0xA0 (160) */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_REGISTER_PROTOCOL_NOTIFY RegisterProtocolNotify;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_INSTALL_CONFIGURATION_TABLE InstallConfigurationTable;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Image Services
65e438608a60500a86a843c3d0d363b73a54b7f7vboxsync/* 64: 25*8 = 0xC8 (200) */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Miscellaneous Services
65e438608a60500a86a843c3d0d363b73a54b7f7vboxsync/* 64: 30*8 = 0xF0 (240) */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_GET_NEXT_MONOTONIC_COUNT GetNextMonotonicCount;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // DriverSupport Services
65e438608a60500a86a843c3d0d363b73a54b7f7vboxsync/* 64: 33*8 = 0x108 (264) */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Open and Close Protocol Services
65e438608a60500a86a843c3d0d363b73a54b7f7vboxsync/* 64: 35*8 = 0x118 (280) */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_OPEN_PROTOCOL_INFORMATION OpenProtocolInformation;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Library Services
65e438608a60500a86a843c3d0d363b73a54b7f7vboxsync/* 64: 38*8 = 0x130 (304) */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES InstallMultipleProtocolInterfaces;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES UninstallMultipleProtocolInterfaces;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // 32-bit CRC Services
65e438608a60500a86a843c3d0d363b73a54b7f7vboxsync/* 64: 43*8 = 0x158 (344) */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Miscellaneous Services
65e438608a60500a86a843c3d0d363b73a54b7f7vboxsync/* 64: 44*8 = 0x160 (352) */
65e438608a60500a86a843c3d0d363b73a54b7f7vboxsync/* 64: 47*8 = 0x178 (376) */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Contains a set of GUID/pointer pairs comprised of the ConfigurationTable field in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI System Table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The 128-bit GUID value that uniquely identifies the system configuration table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A pointer to the table associated with VendorGuid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI System Table
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The table header for the EFI System Table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A pointer to a null terminated string that identifies the vendor
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// that produces the system firmware for the platform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A firmware vendor specific value that identifies the revision
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// of the system firmware for the platform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The handle for the active console input device. This handle must support
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_SIMPLE_TEXT_INPUT_PROTOCOL and EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A pointer to the EFI_SIMPLE_TEXT_INPUT_PROTOCOL interface that is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// associated with ConsoleInHandle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The handle for the active console output device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A pointer to the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL interface
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// that is associated with ConsoleOutHandle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The handle for the active standard error console device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This handle must support the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A pointer to the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL interface
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// that is associated with StandardErrorHandle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A pointer to the EFI Runtime Services Table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A pointer to the EFI Boot Services Table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The number of system configuration tables in the buffer ConfigurationTable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A pointer to the system configuration tables.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The number of entries in the table is NumberOfTableEntries.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is the declaration of an EFI image entry point. This entry point is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync both device drivers and bus drivers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ImageHandle The firmware allocated handle for the UEFI image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SystemTable A pointer to the EFI System Table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The operation completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval Others An unexpected error occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// EFI Load Options Attributes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI Boot Key Data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef union {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Indicates the revision of the EFI_KEY_OPTION structure. This revision level should be 0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Either the left or right Shift keys must be pressed (1) or must not be pressed (0).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Either the left or right Control keys must be pressed (1) or must not be pressed (0).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Either the left or right Alt keys must be pressed (1) or must not be pressed (0).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Either the left or right Logo keys must be pressed (1) or must not be pressed (0).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The Menu key must be pressed (1) or must not be pressed (0).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The SysReq key must be pressed (1) or must not be pressed (0).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Specifies the actual number of entries in EFI_KEY_OPTION.Keys, from 0-3. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// zero, then only the shift state is considered. If more than one, then the boot option will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// only be launched if all of the specified keys are pressed with the same shift state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI Key Option.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Specifies options about how the key will be processed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The CRC-32 which should match the CRC-32 of the entire EFI_LOAD_OPTION to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// which BootOption refers. If the CRC-32s do not match this value, then this key
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// option is ignored.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The Boot#### option which will be invoked if this key is pressed and the boot option
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// is active (LOAD_OPTION_ACTIVE is set).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The key codes to compare against those returned by the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_SIMPLE_TEXT_INPUT and EFI_SIMPLE_TEXT_INPUT_EX protocols.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The number of key codes (0-3) is specified by the EFI_KEY_CODE_COUNT field in KeyOptions.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //EFI_INPUT_KEY Keys[];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// EFI File location to boot from on removable media devices
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_REMOVABLE_MEDIA_FILE_NAME_IA32 L"\\EFI\\BOOT\\BOOTIA32.EFI"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_REMOVABLE_MEDIA_FILE_NAME_IA64 L"\\EFI\\BOOT\\BOOTIA64.EFI"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_REMOVABLE_MEDIA_FILE_NAME_X64 L"\\EFI\\BOOT\\BOOTX64.EFI"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_REMOVABLE_MEDIA_FILE_NAME_ARM L"\\EFI\\BOOT\\BOOTARM.EFI"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_IA32
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_IA64
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_X64