HalRuntimeServicesLib.h File Reference

Go to the source code of this file.

Functions
VOID	LibMtcInitialize (VOID)
VOID	LibMtcVirtualAddressChangeEvent (VOID)
EFI_STATUS EFIAPI	LibMtcGetNextHighMonotonicCount (OUT UINT32 *HighCount)
EFI_STATUS	LibMtcGetNextMonotonicCount (OUT UINT64 *Count)
VOID	LibVariableInitialize (VOID)
VOID	LibVariableVirtualAddressChangeEvent (VOID)
EFI_STATUS	LibGetVariable (IN CHAR16 *VariableName, IN EFI_GUID *VendorGuid, OUT UINT32 *Attributes OPTIONAL, IN OUT UINTN *DataSize, OUT VOID *Data)
EFI_STATUS	LibGetNextVariableName (IN OUT UINTN *VariableNameSize, IN OUT CHAR16 *VariableName, IN OUT EFI_GUID *VendorGuid)
EFI_STATUS	LibSetVariable (IN CHAR16 *VariableName, IN EFI_GUID *VendorGuid, IN UINT32 Attributes, IN UINTN DataSize, IN VOID *Data)
EFI_STATUS	LibQueryVariableInfo (IN UINT32 Attributes, OUT UINT64 *MaximumVariableStorageSize, OUT UINT64 *RemainingVariableStorageSize, OUT UINT64 *MaximumVariableSize)
VOID	LibResetInitializeReset (VOID)
VOID	LibResetVirtualAddressChangeEvent (VOID)
VOID	LibResetSystem (IN EFI_RESET_TYPE ResetType, IN EFI_STATUS ResetStatus, IN UINTN DataSize, IN CHAR16 *ResetData OPTIONAL)
VOID	LibCapsuleInitialize (VOID)
VOID	LibCapsuleVirtualAddressChangeEvent (VOID)
EFI_STATUS	LibUpdateCapsule (IN UEFI_CAPSULE_HEADER **CapsuleHeaderArray, IN UINTN CapsuleCount, IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL)
EFI_STATUS	QueryCapsuleCapabilities (IN UEFI_CAPSULE_HEADER **CapsuleHeaderArray, IN UINTN CapsuleCount, OUT UINT64 *MaxiumCapsuleSize, OUT EFI_RESET_TYPE *ResetType)
VOID	LibRtcInitialize (VOID)
VOID	LibRtcVirtualAddressChangeEvent (VOID)
EFI_STATUS	LibGetTime (OUT EFI_TIME *Time, OUT EFI_TIME_CAPABILITIES *Capabilities)
EFI_STATUS	LibSetTime (IN EFI_TIME *Time)
EFI_STATUS	LibGetWakeupTime (OUT BOOLEAN *Enabled, OUT BOOLEAN *Pending, OUT EFI_TIME *Time)
EFI_STATUS	LibSetWakeupTime (IN BOOLEAN Enabled, OUT EFI_TIME *Time)
VOID	LibReportStatusCodeInitialize (VOID)
VOID	LibReportStatusCodeVirtualAddressChangeEvent (VOID)
EFI_STATUS	LibReportStatusCode (IN EFI_STATUS_CODE_TYPE CodeType, IN EFI_STATUS_CODE_VALUE Value, IN UINT32 Instance, IN EFI_GUID *CallerId, IN EFI_STATUS_CODE_DATA *Data OPTIONAL)

Detailed Description

Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file HalRuntimeServicesLib.h.

Function Documentation

LibGetTime()

EFI_STATUS LibGetTime	(	OUT EFI_TIME *	Time,
		OUT EFI_TIME_CAPABILITIES *	Capabilities
	)

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

Parameters

Time	A pointer to storage to receive a snapshot of the current time.
Capabilities	An optional pointer to a buffer to receive the real time clock device's capabilities.

Return values

EFI_SUCCESS	The operation completed successfully.
EFI_INVALID_PARAMETER	Time is NULL.
EFI_DEVICE_ERROR	The time could not be retrieved due to hardware error.
EFI_UNSUPPORTED	This call is not supported by this platform at the time the call is made. The platform should describe this runtime service as unsupported at runtime via an EFI_RT_PROPERTIES_TABLE configuration table.

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

Parameters

Time	A pointer to storage to receive a snapshot of the current time.
Capabilities	An optional pointer to a buffer to receive the real time clock device's capabilities.

Return values

EFI_SUCCESS	The operation completed successfully.
EFI_INVALID_PARAMETER	Time is NULL.
EFI_DEVICE_ERROR	The time could not be retrieved due to hardware error.

Returns the current time and date information, and the time-keeping capabilities of the virtual RTC.

Parameters

Time	A pointer to storage to receive a snapshot of the current time.
Capabilities	An optional pointer to a buffer to receive the real time clock device's capabilities.

Return values

EFI_SUCCESS	The operation completed successfully.
EFI_INVALID_PARAMETER	Time is NULL.
EFI_DEVICE_ERROR	The time could not be retrieved due to hardware error.

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

Parameters

Time	A pointer to storage to receive a snapshot of the current time.
Capabilities	An optional pointer to a buffer to receive the real time clock device's capabilities.

Return values

EFI_SUCCESS	The operation completed successfully.
EFI_INVALID_PARAMETER	Time is NULL.
EFI_DEVICE_ERROR	The time could not be retrieved due to hardware error.
EFI_SECURITY_VIOLATION	The time could not be retrieved due to an authentication failure.

Definition at line 121 of file PL031RealTimeClockLib.c.

LibGetWakeupTime()

EFI_STATUS LibGetWakeupTime	(	OUT BOOLEAN *	Enabled,
		OUT BOOLEAN *	Pending,
		OUT EFI_TIME *	Time
	)

Returns the current wakeup alarm clock setting.

Parameters

Enabled	Indicates if the alarm is currently enabled or disabled.
Pending	Indicates if the alarm signal is pending and requires acknowledgement.
Time	The current alarm setting.

Return values

EFI_SUCCESS	The alarm settings were returned.
EFI_INVALID_PARAMETER	Enabled is NULL.
EFI_INVALID_PARAMETER	Pending is NULL.
EFI_INVALID_PARAMETER	Time is NULL.
EFI_DEVICE_ERROR	The wakeup time could not be retrieved due to a hardware error.
EFI_UNSUPPORTED	This call is not supported by this platform at the time the call is made. The platform should describe this runtime service as unsupported at runtime via an EFI_RT_PROPERTIES_TABLE configuration table.

Returns the current wakeup alarm clock setting.

Parameters

Enabled	Indicates if the alarm is currently enabled or disabled.
Pending	Indicates if the alarm signal is pending and requires acknowledgement.
Time	The current alarm setting.

Return values

EFI_SUCCESS	The alarm settings were returned.
EFI_INVALID_PARAMETER	Any parameter is NULL.
EFI_DEVICE_ERROR	The wakeup time could not be retrieved due to a hardware error.

Definition at line 243 of file PL031RealTimeClockLib.c.

LibSetTime()

EFI_STATUS LibSetTime

(

IN EFI_TIME *

Time

)

Sets the current local time and date information.

Parameters

Time	A pointer to the current time.

Return values

EFI_SUCCESS	The operation completed successfully.
EFI_INVALID_PARAMETER	A time field is out of range.
EFI_DEVICE_ERROR	The time could not be set due to hardware error.
EFI_UNSUPPORTED	This call is not supported by this platform at the time the call is made. The platform should describe this runtime service as unsupported at runtime via an EFI_RT_PROPERTIES_TABLE configuration table.

Sets the current local time and date information.

Parameters

Time	A pointer to the current time.

Return values

EFI_SUCCESS	The operation completed successfully.
EFI_INVALID_PARAMETER	A time field is out of range.
EFI_DEVICE_ERROR	The time could not be set due to hardware error.

Sets the current local time and date information.

Parameters

Time	A pointer to the current time.

Return values

EFI_SUCCESS	The operation completed successfully.
EFI_INVALID_PARAMETER	A time field is out of range.
EFI_DEVICE_ERROR	The time could not be set due due to hardware error.

Definition at line 184 of file PL031RealTimeClockLib.c.

LibSetWakeupTime()

EFI_STATUS LibSetWakeupTime	(	IN BOOLEAN	Enabled,
		OUT EFI_TIME *	Time
	)

Sets the system wakeup alarm clock time.

Parameters

Enabled	Enable or disable the wakeup alarm.
Time	If Enable is TRUE, the time to set the wakeup alarm for.

Return values

EFI_SUCCESS	If Enable is TRUE, then the wakeup alarm was enabled. If Enable is FALSE, then the wakeup alarm was disabled.
EFI_INVALID_PARAMETER	Enabled is NULL.
EFI_INVALID_PARAMETER	Pending is NULL.
EFI_INVALID_PARAMETER	Time is NULL.
EFI_DEVICE_ERROR	The wakeup time could not be set due to a hardware error.
EFI_UNSUPPORTED	This call is not supported by this platform at the time the call is made. The platform should describe this runtime service as unsupported at runtime via an EFI_RT_PROPERTIES_TABLE configuration table.

Sets the system wakeup alarm clock time.

Parameters

Enabled	Enable or disable the wakeup alarm.
Time	If Enable is TRUE, the time to set the wakeup alarm for.

Return values

EFI_SUCCESS	If Enable is TRUE, then the wakeup alarm was enabled. If Enable is FALSE, then the wakeup alarm was disabled.
EFI_INVALID_PARAMETER	A time field is out of range.
EFI_DEVICE_ERROR	The wakeup time could not be set due to a hardware error.
EFI_UNSUPPORTED	A wakeup timer is not supported on this platform.

Definition at line 272 of file PL031RealTimeClockLib.c.