RealTimeClockLib.h File Reference

Functions
EFI_STATUS EFIAPI	LibGetTime (OUT EFI_TIME *Time, OUT EFI_TIME_CAPABILITIES *Capabilities)
EFI_STATUS EFIAPI	LibSetTime (IN EFI_TIME *Time)
EFI_STATUS EFIAPI	LibGetWakeupTime (OUT BOOLEAN *Enabled, OUT BOOLEAN *Pending, OUT EFI_TIME *Time)
EFI_STATUS EFIAPI	LibSetWakeupTime (IN BOOLEAN Enabled, OUT EFI_TIME *Time)
EFI_STATUS EFIAPI	LibRtcInitialize (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
VOID EFIAPI	LibRtcVirtualNotifyEvent (IN EFI_EVENT Event, IN VOID *Context)

Detailed Description

Implement EFI RealTimeClock runtime services via Lib.

Currently this driver does not support runtime virtual calling.

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

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

Function Documentation

EFI_STATUS EFIAPI 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_STATUS EFIAPI 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	Any parameter is NULL.
EFI_DEVICE_ERROR	The wakeup time could not be retrieved due to a hardware error.

EFI_STATUS EFIAPI LibRtcInitialize	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

This is the declaration of an EFI image entry point. This can be the entry point to an application written to this specification, an EFI boot service driver, or an EFI runtime driver.

Parameters

ImageHandle	Handle that identifies the loaded image.
SystemTable	System Table for this image.

Return values

EFI_SUCCESS

The operation completed successfully.

VOID EFIAPI LibRtcVirtualNotifyEvent	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

Fixup internal data so that EFI can be call in virtual mode. Call the passed in Child Notify event and convert any pointers in lib to virtual mode.

Parameters

[in]	Event	The Event that is being processed
[in]	Context	Event Context

EFI_STATUS EFIAPI 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 due to hardware error.

EFI_STATUS EFIAPI 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	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.