ba5dd00fabaa3475fa5da200d134c73f1c961b49vboxsync Header file for real time clock driver.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsyncCopyright (c) 2006 - 2007, Intel Corporation. All rights reserved.<BR>
ba5dd00fabaa3475fa5da200d134c73f1c961b49vboxsyncThis program and the accompanying materials
ba5dd00fabaa3475fa5da200d134c73f1c961b49vboxsyncare licensed and made available under the terms and conditions of the BSD License
ba5dd00fabaa3475fa5da200d134c73f1c961b49vboxsyncwhich accompanies this distribution. The full text of the license may be found at
ba5dd00fabaa3475fa5da200d134c73f1c961b49vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
ba5dd00fabaa3475fa5da200d134c73f1c961b49vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsynctypedef struct {
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync// Dallas DS12C887 Real Time Clock
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync#define RTC_ADDRESS_SECONDS_ALARM 1 // R/W Range 0..59
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync#define RTC_ADDRESS_MINUTES_ALARM 3 // R/W Range 0..59
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync#define RTC_ADDRESS_HOURS 4 // R/W Range 1..12 or 0..23 Bit 7 is AM/PM
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync#define RTC_ADDRESS_HOURS_ALARM 5 // R/W Range 1..12 or 0..23 Bit 7 is AM/PM
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync#define RTC_ADDRESS_DAY_OF_THE_WEEK 6 // R/W Range 1..7
2412a232e34038160df062f7939f353bee5567a9vboxsync#define RTC_ADDRESS_DAY_OF_THE_MONTH 7 // R/W Range 1..31
2412a232e34038160df062f7939f353bee5567a9vboxsync#define RTC_ADDRESS_REGISTER_A 10 // R/W[0..6] R0[7]
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync#define RTC_ADDRESS_CENTURY 50 // R/W Range 19..20 Bit 8 is R/W
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync// Date and time initial values.
ba5dd00fabaa3475fa5da200d134c73f1c961b49vboxsync// They are used if the RTC values are invalid during driver initialization
56dabd8ef969a182c5f3cc6ac76cabf21751192evboxsync// Register initial values
06913e4efbdb8192155c00fa59de4174c7a50b57vboxsync// Register A
06913e4efbdb8192155c00fa59de4174c7a50b57vboxsynctypedef struct {
a5b0b691c49d35639207d4539753eaebf3f05275vboxsynctypedef union {
ba5dd00fabaa3475fa5da200d134c73f1c961b49vboxsync// Register B
a5b0b691c49d35639207d4539753eaebf3f05275vboxsynctypedef struct {
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync UINT8 Dse : 1; // 0 - Daylight saving disabled 1 - Daylight savings enabled
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync UINT8 Mil : 1; // 0 - 12 hour mode 1 - 24 hour mode
2412a232e34038160df062f7939f353bee5567a9vboxsync UINT8 Sqwe : 1; // 0 - Disable SQWE output 1 - Enable SQWE output
ba5dd00fabaa3475fa5da200d134c73f1c961b49vboxsync UINT8 Uie : 1; // 0 - Update INT disabled 1 - Update INT enabled
ba5dd00fabaa3475fa5da200d134c73f1c961b49vboxsync UINT8 Aie : 1; // 0 - Alarm INT disabled 1 - Alarm INT Enabled
56dabd8ef969a182c5f3cc6ac76cabf21751192evboxsync UINT8 Pie : 1; // 0 - Periodic INT disabled 1 - Periodic INT Enabled
56dabd8ef969a182c5f3cc6ac76cabf21751192evboxsync UINT8 Set : 1; // 0 - Normal operation. 1 - Updates inhibited
ba5dd00fabaa3475fa5da200d134c73f1c961b49vboxsynctypedef union {
ba5dd00fabaa3475fa5da200d134c73f1c961b49vboxsync// Register C
ba5dd00fabaa3475fa5da200d134c73f1c961b49vboxsynctypedef struct {
2412a232e34038160df062f7939f353bee5567a9vboxsync UINT8 Reserved : 4; // Read as zero. Can not be written.
ba5dd00fabaa3475fa5da200d134c73f1c961b49vboxsync UINT8 Irqf : 1; // Iterrupt Request Flag = PF & PIE | AF & AIE | UF & UIE
ba5dd00fabaa3475fa5da200d134c73f1c961b49vboxsynctypedef union {
2412a232e34038160df062f7939f353bee5567a9vboxsync// Register D
ba5dd00fabaa3475fa5da200d134c73f1c961b49vboxsynctypedef struct {
ba5dd00fabaa3475fa5da200d134c73f1c961b49vboxsync UINT8 Reserved : 7; // Read as zero. Can not be written.
2412a232e34038160df062f7939f353bee5567a9vboxsynctypedef union {
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync Initialize RTC.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @param Global For global use inside this module.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @retval EFI_DEVICE_ERROR Initialization failed due to device error.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @retval EFI_SUCCESS Initialization successful.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync Sets the current local time and date information.
56dabd8ef969a182c5f3cc6ac76cabf21751192evboxsync @param Time A pointer to the current time.
56dabd8ef969a182c5f3cc6ac76cabf21751192evboxsync @param Global For global use inside this module.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @retval EFI_SUCCESS The operation completed successfully.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @retval EFI_INVALID_PARAMETER A time field is out of range.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @retval EFI_DEVICE_ERROR The time could not be set due due to hardware error.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync Returns the current time and date information, and the time-keeping capabilities
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync of the hardware platform.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @param Time A pointer to storage to receive a snapshot of the current time.
2412a232e34038160df062f7939f353bee5567a9vboxsync @param Capabilities An optional pointer to a buffer to receive the real time clock
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync device's capabilities.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @param Global For global use inside this module.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @retval EFI_SUCCESS The operation completed successfully.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @retval EFI_INVALID_PARAMETER Time is NULL.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @retval EFI_DEVICE_ERROR The time could not be retrieved due to hardware error.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync Sets the system wakeup alarm clock time.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @param Enabled Enable or disable the wakeup alarm.
2412a232e34038160df062f7939f353bee5567a9vboxsync @param Time If Enable is TRUE, the time to set the wakeup alarm for.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync If Enable is FALSE, then this parameter is optional, and may be NULL.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @param Global For global use inside this module.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @retval EFI_SUCCESS If Enable is TRUE, then the wakeup alarm was enabled.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync If Enable is FALSE, then the wakeup alarm was disabled.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @retval EFI_INVALID_PARAMETER A time field is out of range.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @retval EFI_DEVICE_ERROR The wakeup time could not be set due to a hardware error.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
2412a232e34038160df062f7939f353bee5567a9vboxsync Returns the current wakeup alarm clock setting.
2412a232e34038160df062f7939f353bee5567a9vboxsync @param Enabled Indicates if the alarm is currently enabled or disabled.
2412a232e34038160df062f7939f353bee5567a9vboxsync @param Pending Indicates if the alarm signal is pending and requires acknowledgement.
2412a232e34038160df062f7939f353bee5567a9vboxsync @param Time The current alarm setting.
2412a232e34038160df062f7939f353bee5567a9vboxsync @param Global For global use inside this module.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @retval EFI_SUCCESS The alarm settings were returned.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @retval EFI_INVALID_PARAMETER Enabled is NULL.
2412a232e34038160df062f7939f353bee5567a9vboxsync @retval EFI_INVALID_PARAMETER Pending is NULL.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @retval EFI_INVALID_PARAMETER Time is NULL.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @retval EFI_DEVICE_ERROR The wakeup time could not be retrieved due to a hardware error.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync The user Entry Point for PcRTC module.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync This is the entrhy point for PcRTC module. It installs the UEFI runtime service
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync including GetTime(),SetTime(),GetWakeupTime(),and SetWakeupTime().
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @param ImageHandle The firmware allocated handle for the EFI image.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @param SystemTable A pointer to the EFI System Table.
2412a232e34038160df062f7939f353bee5567a9vboxsync @retval EFI_SUCCESS The entry point is executed successfully.
2412a232e34038160df062f7939f353bee5567a9vboxsync @retval Others Some error occurs when executing this entry point.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync See if all fields of a variable of EFI_TIME type is correct.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @param Time The time to be checked.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @retval EFI_INVALID_PARAMETER Some fields of Time are not correct.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @retval EFI_SUCCESS Time is a valid EFI_TIME variable.
2412a232e34038160df062f7939f353bee5567a9vboxsync Converts time from EFI_TIME format defined by UEFI spec to RTC's.
2412a232e34038160df062f7939f353bee5567a9vboxsync This function converts time from EFI_TIME format defined by UEFI spec to RTC's.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync If data mode of RTC is BCD, then converts EFI_TIME to it.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync If RTC is in 12-hour format, then converts EFI_TIME to it.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @param Time On input, the time data read from UEFI to convert
2412a232e34038160df062f7939f353bee5567a9vboxsync On output, the time converted to RTC format
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @param RegisterB Value of Register B of RTC, indicating data mode
2412a232e34038160df062f7939f353bee5567a9vboxsync @param Century It is set according to EFI_TIME Time.
2412a232e34038160df062f7939f353bee5567a9vboxsync Converts time read from RTC to EFI_TIME format defined by UEFI spec.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync This function converts raw time data read from RTC to the EFI_TIME format
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync defined by UEFI spec.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync If data mode of RTC is BCD, then converts it to decimal,
2412a232e34038160df062f7939f353bee5567a9vboxsync If RTC is in 12-hour format, then converts it to 24-hour format.
2412a232e34038160df062f7939f353bee5567a9vboxsync @param Time On input, the time data read from RTC to convert
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync On output, the time converted to UEFI format
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @param Century Value of century read from RTC.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @param RegisterB Value of Register B of RTC, indicating data mode
2412a232e34038160df062f7939f353bee5567a9vboxsync and hour format.
2412a232e34038160df062f7939f353bee5567a9vboxsync @retval EFI_INVALID_PARAMETER Parameters passed in are invalid.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @retval EFI_SUCCESS Convert RTC time to EFI time successfully.
2412a232e34038160df062f7939f353bee5567a9vboxsync Wait for a period for the RTC to be ready.
2412a232e34038160df062f7939f353bee5567a9vboxsync @param Timeout Tell how long it should take to wait.
2412a232e34038160df062f7939f353bee5567a9vboxsync @retval EFI_DEVICE_ERROR RTC device error.
2412a232e34038160df062f7939f353bee5567a9vboxsync @retval EFI_SUCCESS RTC is updated and ready.
2412a232e34038160df062f7939f353bee5567a9vboxsync See if field Day of an EFI_TIME is correct.
2412a232e34038160df062f7939f353bee5567a9vboxsync @param Time Its Day field is to be checked.
2412a232e34038160df062f7939f353bee5567a9vboxsync @retval TRUE Day field of Time is correct.
2412a232e34038160df062f7939f353bee5567a9vboxsync @retval FALSE Day field of Time is NOT correct.
2412a232e34038160df062f7939f353bee5567a9vboxsync Check if it is a leapyear.
2412a232e34038160df062f7939f353bee5567a9vboxsync @param Time The time to be checked.
a5b0b691c49d35639207d4539753eaebf3f05275vboxsync @retval TRUE It is a leapyear.
2412a232e34038160df062f7939f353bee5567a9vboxsync @retval FALSE It is NOT a leapyear.