Intel Extensible Firmware Interface, Specification

Page: 107 / 494

Services
Version 1.02 12/12/00 89
3.6.3 GetWakeupTime()
Summary
Returns the current wakeup alarm clock setting.
Prototype
EFI_STATUS
GetWakeupTime (
OUT BOOLEAN *Enabled,
OUT BOOLEAN *Pending,
OUT EFI_TIME *Time
);
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. Type
EFI_TIME
is defined in Section 3.6.1.
Description
The alarm clock time may be rounded from the set alarm clock time to be within the resolution of
the alarm clock device. The resolution of the alarm clock device is defined to be one second.
During runtime, if a PC-AT CMOS device is present in the platform the caller must synchronize
access to the device before calling
GetWakeupTime()
.
Status Codes Returned
EFI_SUCCESS The alarm settings were returned.
EFI_INVALID_PARAMETER A time field is out of range.
EFI_DEVICE_ERROR The wakeup time could not be retrieved due to a hardware error.