4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Provides library functions for each of the UEFI Runtime Services.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Only available to DXE and UEFI module types.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006 - 2010, 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 This function allows the caller to determine if UEFI ExitBootServices() has been called.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns TRUE after all the EVT_SIGNAL_EXIT_BOOT_SERVICES functions have
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync executed as a result of the OS calling ExitBootServices(). Prior to this time FALSE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is returned. This function is used by runtime code to decide it is legal to access
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync services that go away after ExitBootServices().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE The system has finished executing the EVT_SIGNAL_EXIT_BOOT_SERVICES event.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE The system has not finished executing the EVT_SIGNAL_EXIT_BOOT_SERVICES event.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function allows the caller to determine if UEFI SetVirtualAddressMap() has been called.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns TRUE after all the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE functions have
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync executed as a result of the OS calling SetVirtualAddressMap(). Prior to this time FALSE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is returned. This function is used by runtime code to decide it is legal to access services
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync that go away after SetVirtualAddressMap().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE The system has finished executing the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE The system has not finished executing the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service is a wrapper for the UEFI Runtime Service GetTime().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The GetTime() function returns a time that was valid sometime during the call to the function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync While the returned EFI_TIME structure contains TimeZone and Daylight savings time information,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the actual clock does not maintain these values. The current time zone and daylight saving time
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information returned by GetTime() are the values that were last set via SetTime().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The GetTime() function should take approximately the same amount of time to read the time each
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync time it is called. All reported device capabilities are to be rounded up.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync During runtime, if a PC-AT CMOS device is present in the platform, the caller must synchronize
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync access to the device before calling GetTime().
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 device's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 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 a hardware error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service is a wrapper for the UEFI Runtime Service SetTime().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The SetTime() function sets the real time clock device to the supplied time, and records the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync current time zone and daylight savings time information. The SetTime() function is not allowed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to loop based on the current time. For example, if the device does not support a hardware reset
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for the sub-resolution time, the code is not to implement the feature by waiting for the time to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync During runtime, if a PC-AT CMOS device is present in the platform, the caller must synchronize
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync access to the device before calling SetTime().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Time A pointer to the current time. Type EFI_TIME is defined in the GetTime()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync function description. Full error checking is performed on the different
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync fields of the EFI_TIME structure (refer to the EFI_TIME definition in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync GetTime() function description for full details), and EFI_INVALID_PARAMETER
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is returned if any field is out of range.
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 to a hardware error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service is a wrapper for the UEFI Runtime Service GetWakeupTime().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The alarm clock time may be rounded from the set alarm clock time to be within the resolution
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the alarm clock device. The resolution of the alarm clock device is defined to be one second.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync During runtime, if a PC-AT CMOS device is present in the platform the caller must synchronize
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync access to the device before calling GetWakeupTime().
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. Type EFI_TIME is defined in the GetTime()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync function description.
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 This service is a wrapper for the UEFI Runtime Service SetWakeupTime()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Setting a system wakeup alarm causes the system to wake up or power on at the set time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync When the alarm fires, the alarm signal is latched until it is acknowledged by calling SetWakeupTime()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to disable the alarm. If the alarm fires before the system is put into a sleeping or off state,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync since the alarm signal is latched the system will immediately wake up. If the alarm fires while
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the system is off and there is insufficient power to power on the system, the system is powered
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync on when power is restored.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Enable Enable or disable the wakeup alarm.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Time If Enable is TRUE, the time to set the wakeup alarm for. Type EFI_TIME
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is defined in the GetTime() function description. If Enable is FALSE,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then this parameter is optional, and may be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS If Enable is TRUE, then the wakeup alarm was enabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If 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 This service is a wrapper for the UEFI Runtime Service GetVariable().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Each vendor may create and manage its own variables without the risk of name conflicts by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync using a unique VendorGuid. When a variable is set, its Attributes are supplied to indicate
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync how the data variable should be stored and maintained by the system. The attributes affect
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync when the variable may be accessed and volatility of the data. Any attempts to access a variable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync that does not have the attribute set for runtime access will yield the EFI_NOT_FOUND error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the Data buffer is too small to hold the contents of the variable, the error EFI_BUFFER_TOO_SMALL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is returned and DataSize is set to the required buffer size to obtain the data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VariableName the name of the vendor's variable, it's a Null-Terminated Unicode String
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VendorGuid Unify identifier for vendor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Attributes Point to memory location to return the attributes of variable. If the point
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is NULL, the parameter would be ignored.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DataSize As input, point to the maximum size of return Data-Buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync As output, point to the actual size of the returned Data-Buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Data Point to return Data-Buffer.
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. DataSize has
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync been updated with the size needed to complete the request.
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 This service is a wrapper for the UEFI Runtime Service GetNextVariableName().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync GetNextVariableName() is called multiple times to retrieve the VariableName and VendorGuid of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync all variables currently available in the system. On each call to GetNextVariableName() the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync previous results are passed into the interface, and on output the interface returns the next
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync variable name data. When the entire variable list has been returned, the error EFI_NOT_FOUND
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VariableNameSize As input, point to maximum size of variable name.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync As output, point to actual size of variable name.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VariableName As input, supplies the last VariableName that was returned by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync GetNextVariableName().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync As output, returns the name of variable. The name
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync string is Null-Terminated Unicode string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VendorGuid As input, supplies the last VendorGuid that was returned by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync GetNextVriableName().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync As output, returns the 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 VariableNameSize has been updated with the size needed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to complete the request.
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 name could not be retrieved due to a hardware error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service is a wrapper for the UEFI Runtime Service GetNextVariableName()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Variables are stored by the firmware and may maintain their values across power cycles. Each vendor
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync may create and manage its own variables without the risk of name conflicts by using a unique VendorGuid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VariableName the name of the vendor's variable, as a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Null-Terminated Unicode String
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VendorGuid Unify identifier for vendor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Attributes Point to memory location to return the attributes of variable. If the point
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is NULL, the parameter would be ignored.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DataSize The size in bytes of Data-Buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Data Point to the content of 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 Unicode 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 saved due to a hardware failure.
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
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync out by the firmware.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service is a wrapper for the UEFI Runtime Service GetNextHighMonotonicCount().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The platform's monotonic counter is comprised of two 32-bit quantities: the high 32 bits and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the low 32 bits. During boot service time the low 32-bit value is volatile: it is reset to zero
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync on every system reset and is increased by 1 on every call to GetNextMonotonicCount(). The high
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 32-bit value is nonvolatile and is increased by 1 whenever the system resets or whenever the low
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 32-bit count (returned by GetNextMonoticCount()) overflows.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param HighCount Pointer to returned value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The next high monotonic count was returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The device is not functioning properly.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER HighCount is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service is a wrapper for the UEFI Runtime Service ResetSystem().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The ResetSystem()function resets the entire platform, including all processors and devices,and reboots the system.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Calling this interface with ResetType of EfiResetCold causes a system-wide reset. This sets all circuitry within
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the system to its initial state. This type of reset is asynchronous to system operation and operates without regard
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to cycle boundaries. EfiResetCold is tantamount to a system power cycle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Calling this interface with ResetType of EfiResetWarm causes a system-wide initialization. The processors are set to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync their initial state, and pending cycles are not corrupted. If the system does not support this reset type, then an
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiResetCold must be performed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Calling this interface with ResetType of EfiResetShutdown causes the system to enter a power state equivalent to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ACPI G2/S5 or G3 states. If the system does not support this reset type, then when the system is rebooted, it should
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync exhibit the EfiResetCold attributes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The platform may optionally log the parameters from any non-normal reset that occurs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The ResetSystem() function does not return.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ResetType The type of reset to perform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ResetStatus The status code for the reset. If the system reset is part of a normal operation, the status code
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync would be EFI_SUCCESS. If the system reset is due to some type of failure the most appropriate EFI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status code would be used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DataSizeThe size, in bytes, of ResetData.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ResetData For a ResetType of EfiResetCold, EfiResetWarm, or EfiResetShutdown the data buffer starts with a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Null-terminated Unicode string, optionally followed by additional binary data. The string is a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync description that the caller may use to further indicate the reason for the system reset. ResetData
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is only valid if ResetStatus is something other then EFI_SUCCESS. This pointer must be a physical
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync address. For a ResetType of EfiRestUpdate the data buffer also starts with a Null-terminated string
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync that is followed by a physical VOID * to an EFI_CAPSULE_HEADER.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service is a wrapper for the UEFI Runtime Service ConvertPointer().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The ConvertPointer() function is used by an EFI component during the SetVirtualAddressMap() operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ConvertPointer()must be called using physical address pointers during the execution of SetVirtualAddressMap().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DebugDisposition Supplies type information for the pointer being converted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Address The pointer to a pointer that is to be fixed to be the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync value needed for the new virtual address mapping being
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The pointer pointed to by Address was modified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The pointer pointed to by Address was not found to be part of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the current memory map. This is normally fatal.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Address is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER *Address is NULL and DebugDispositio
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Determines the new virtual address that is to be used on subsequent memory accesses.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync For IA32, x64, and EBC, this service is a wrapper for the UEFI Runtime Service
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ConvertPointer(). See the UEFI Specification for details.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync For IPF, this function interprets Address as a pointer to an EFI_PLABEL structure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and both the EntryPoint and GP fields of an EFI_PLABEL are converted from physical
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to virtiual addressing. Since IPF allows the GP to point to an address outside
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a PE/COFF image, the physical to virtual offset for the EntryPoint field is used
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to adjust the GP field. The UEFI Runtime Service ConvertPointer() is used to convert
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EntryPoint and the status code for this conversion is always returned. If the convertion
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of EntryPoint fails, then neither EntryPoint nor GP are modified. See the UEFI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Specification for details on the UEFI Runtime Service ConvertPointer().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DebugDisposition Supplies type information for the pointer being converted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Address The pointer to a pointer that is to be fixed to be the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync value needed for the new virtual address mapping being
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return EFI_STATUS value from EfiConvertPointer().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service is a wrapper for the UEFI Runtime Service SetVirtualAddressMap().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The SetVirtualAddressMap() function is used by the OS loader. The function can only be called
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync at runtime, and is called by the owner of the system's memory map. I.e., the component which
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync called ExitBootServices(). All events of type EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE must be signaled
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync before SetVirtualAddressMap() returns.
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. Type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_MEMORY_DESCRIPTOR is defined in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync GetMemoryMap() function description.
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
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 Convert the standard Lib double linked list to a virtual mapping.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service uses EfiConvertPointer() to walk a double linked list and convert all the link
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync pointers to their virtual mappings. This function is only guaranteed to work during the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event and calling it at other times has undefined results.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DebugDisposition Supplies type information for the pointer being converted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ListHead Head of linked list to convert.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Successfully executed the function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval !EFI_SUCCESS Failed to execute the function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service is a wrapper for the UEFI Runtime Service UpdateCapsule().
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 across a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync system reset, the reset value returned from EFI_QueryCapsuleCapabilities must be passed into ResetSystem()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and will cause the capsule to be processed by the firmware as 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. Each capsules is assumed to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync stored in contiguous virtual memory. The capsules in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CapsuleHeaderArray must be the same capsules as the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScatterGatherList. The CapsuleHeaderArray must
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync have the capsules in the same order as the ScatterGatherList.
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. See Related
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Definitions for an explanation of how more than one capsule is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync passed via this interface. The capsules in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScatterGatherList must be in the same order as the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CapsuleHeaderArray. This parameter is only referenced if
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the capsules are defined to persist across system reset.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS A valid capsule was passed. If CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the 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 This service is a wrapper for the UEFI Runtime Service QueryCapsuleCapabilities().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The QueryCapsuleCapabilities() function allows a caller to test to see if a capsule or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync capsules can be updated via UpdateCapsule(). The Flags values in the capsule header and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync size of the entire capsule is checked.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the caller needs to query for generic capsule capability a fake EFI_CAPSULE_HEADER can be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync constructed where CapsuleImageSize is equal to HeaderSize that is equal to sizeof
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (EFI_CAPSULE_HEADER). To determine reset requirements,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CAPSULE_FLAGS_PERSIST_ACROSS_RESET should be set in the Flags field of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_CAPSULE_HEADER.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The firmware must support any capsule that has the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CAPSULE_FLAGS_PERSIST_ACROSS_RESET flag set in EFI_CAPSULE_HEADER. The
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync firmware sets the policy for what capsules are supported that do not have the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CAPSULE_FLAGS_PERSIST_ACROSS_RESET flag set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync being passed into update capsule. The capsules are assumed to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync stored in contiguous virtual memory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CaspuleHeaderArray.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MaximumCapsuleSize On output the maximum size that UpdateCapsule() can
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync support as an argument to UpdateCapsule() via
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CapsuleHeaderArray and ScatterGatherList.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Undefined on input.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ResetType Returns the type of reset required for the capsule update.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS A valid answer was returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The capsule type is not supported on this platform, and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MaximumCapsuleSize and ResetType are undefined.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There were insufficient resources to process the query request.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service is a wrapper for the UEFI Runtime Service QueryVariableInfo().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The QueryVariableInfo() function allows a caller to obtain the information about the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync maximum size of the storage space available for the EFI variables, the remaining size of the storage
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync space available for the EFI variables and the maximum size of each individual EFI variable,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync associated with the attributes specified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The returned MaximumVariableStorageSize, RemainingVariableStorageSize,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MaximumVariableSize information may change immediately after the call based on other
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync runtime activities including asynchronous error events. Also, these values associated with different
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync attributes are not additive in nature.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Attributes Attributes bitmask to specify the type of variables on
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which to return information. Refer to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync GetVariable() function description.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MaximumVariableStorageSize
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync On output the maximum size of the storage space
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync available for the EFI variables associated with the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync attributes specified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param RemainingVariableStorageSize
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 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 A valid answer was returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED EFI_UNSUPPORTED The attribute is not supported on this platform, and the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MaximumVariableStorageSize,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RemainingVariableStorageSize, MaximumVariableSize
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are undefined.