#include <Uefi.h>
#include <Guid/Acpi.h>
#include <Protocol/RealTimeClock.h>
#include <Library/BaseLib.h>
#include <Library/DebugLib.h>
#include <Library/UefiLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/IoLib.h>
#include <Library/TimerLib.h>
#include <Library/UefiDriverEntryPoint.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiRuntimeLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
#include <Library/PcdLib.h>
#include <Library/ReportStatusCodeLib.h>

Data Structures
struct	PC_RTC_MODULE_GLOBALS

struct	RTC_REGISTER_A_BITS

union	RTC_REGISTER_A

struct	RTC_REGISTER_B_BITS

union	RTC_REGISTER_B

struct	RTC_REGISTER_C_BITS

union	RTC_REGISTER_C

struct	RTC_REGISTER_D_BITS

union	RTC_REGISTER_D

Macros
#define	RTC_ADDRESS_SECONDS 0

#define	RTC_ADDRESS_SECONDS_ALARM 1

#define	RTC_ADDRESS_MINUTES 2

#define	RTC_ADDRESS_MINUTES_ALARM 3

#define	RTC_ADDRESS_HOURS 4

#define	RTC_ADDRESS_HOURS_ALARM 5

#define	RTC_ADDRESS_DAY_OF_THE_WEEK 6

#define	RTC_ADDRESS_DAY_OF_THE_MONTH 7

#define	RTC_ADDRESS_MONTH 8

#define	RTC_ADDRESS_YEAR 9

#define	RTC_ADDRESS_REGISTER_A 10

#define	RTC_ADDRESS_REGISTER_B 11

#define	RTC_ADDRESS_REGISTER_C 12

#define	RTC_ADDRESS_REGISTER_D 13

#define	RTC_INIT_SECOND 0

#define	RTC_INIT_MINUTE 0

#define	RTC_INIT_HOUR 0

#define	RTC_INIT_DAY 1

#define	RTC_INIT_MONTH 1

#define	RTC_DIV_RESET 0x70

Functions
EFI_STATUS	PcRtcInit (IN PC_RTC_MODULE_GLOBALS *Global)

EFI_STATUS	PcRtcSetTime (IN EFI_TIME Time, IN PC_RTC_MODULE_GLOBALS Global)

EFI_STATUS	PcRtcGetTime (OUT EFI_TIME Time, OUT EFI_TIME_CAPABILITIES Capabilities OPTIONAL, IN PC_RTC_MODULE_GLOBALS *Global)

EFI_STATUS	PcRtcSetWakeupTime (IN BOOLEAN Enable, IN EFI_TIME Time OPTIONAL, IN PC_RTC_MODULE_GLOBALS Global)

EFI_STATUS	PcRtcGetWakeupTime (OUT BOOLEAN Enabled, OUT BOOLEAN Pending, OUT EFI_TIME Time, IN PC_RTC_MODULE_GLOBALS Global)

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

EFI_STATUS	RtcTimeFieldsValid (IN EFI_TIME *Time)

VOID	ConvertEfiTimeToRtcTime (IN OUT EFI_TIME *Time, IN RTC_REGISTER_B RegisterB)

EFI_STATUS	ConvertRtcTimeToEfiTime (IN OUT EFI_TIME *Time, IN RTC_REGISTER_B RegisterB)

EFI_STATUS	RtcWaitToUpdate (UINTN Timeout)

BOOLEAN	DayValid (IN EFI_TIME *Time)

BOOLEAN	IsLeapYear (IN EFI_TIME *Time)

UINT8	GetCenturyRtcAddress (VOID)

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

Variables
PC_RTC_MODULE_GLOBALS	mModuleGlobal

Detailed Description

Header file for real time clock driver.

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

Definition in file PcRtc.h.

Macro Definition Documentation

◆ RTC_ADDRESS_DAY_OF_THE_MONTH

#define RTC_ADDRESS_DAY_OF_THE_MONTH 7

Definition at line 52 of file PcRtc.h.

◆ RTC_ADDRESS_DAY_OF_THE_WEEK

#define RTC_ADDRESS_DAY_OF_THE_WEEK 6

Definition at line 51 of file PcRtc.h.

◆ RTC_ADDRESS_HOURS

#define RTC_ADDRESS_HOURS 4

Definition at line 49 of file PcRtc.h.

◆ RTC_ADDRESS_HOURS_ALARM

#define RTC_ADDRESS_HOURS_ALARM 5

Definition at line 50 of file PcRtc.h.

◆ RTC_ADDRESS_MINUTES

#define RTC_ADDRESS_MINUTES 2

Definition at line 47 of file PcRtc.h.

◆ RTC_ADDRESS_MINUTES_ALARM

#define RTC_ADDRESS_MINUTES_ALARM 3

Definition at line 48 of file PcRtc.h.

◆ RTC_ADDRESS_MONTH

#define RTC_ADDRESS_MONTH 8

Definition at line 53 of file PcRtc.h.

◆ RTC_ADDRESS_REGISTER_A

#define RTC_ADDRESS_REGISTER_A 10

Definition at line 55 of file PcRtc.h.

◆ RTC_ADDRESS_REGISTER_B

#define RTC_ADDRESS_REGISTER_B 11

Definition at line 56 of file PcRtc.h.

◆ RTC_ADDRESS_REGISTER_C

#define RTC_ADDRESS_REGISTER_C 12

Definition at line 57 of file PcRtc.h.

◆ RTC_ADDRESS_REGISTER_D

#define RTC_ADDRESS_REGISTER_D 13

Definition at line 58 of file PcRtc.h.

◆ RTC_ADDRESS_SECONDS

#define RTC_ADDRESS_SECONDS 0

Definition at line 45 of file PcRtc.h.

◆ RTC_ADDRESS_SECONDS_ALARM

#define RTC_ADDRESS_SECONDS_ALARM 1

Definition at line 46 of file PcRtc.h.

◆ RTC_ADDRESS_YEAR

#define RTC_ADDRESS_YEAR 9

Definition at line 54 of file PcRtc.h.

◆ RTC_DIV_RESET

#define RTC_DIV_RESET 0x70

Definition at line 73 of file PcRtc.h.

◆ RTC_INIT_DAY

#define RTC_INIT_DAY 1

Definition at line 66 of file PcRtc.h.

◆ RTC_INIT_HOUR

#define RTC_INIT_HOUR 0

Definition at line 65 of file PcRtc.h.

◆ RTC_INIT_MINUTE

#define RTC_INIT_MINUTE 0

Definition at line 64 of file PcRtc.h.

◆ RTC_INIT_MONTH

#define RTC_INIT_MONTH 1

Definition at line 67 of file PcRtc.h.

◆ RTC_INIT_SECOND

#define RTC_INIT_SECOND 0

Definition at line 63 of file PcRtc.h.

Function Documentation

◆ ConvertEfiTimeToRtcTime()

VOID ConvertEfiTimeToRtcTime	(	IN OUT EFI_TIME *	Time,
		IN RTC_REGISTER_B	RegisterB
	)

Converts time from EFI_TIME format defined by UEFI spec to RTC format.

This function converts time from EFI_TIME format defined by UEFI spec to RTC format. If data mode of RTC is BCD, then converts EFI_TIME to it. If RTC is in 12-hour format, then converts EFI_TIME to it.

Parameters

Time	On input, the time data read from UEFI to convert On output, the time converted to RTC format
RegisterB	Value of Register B of RTC, indicating data mode

Definition at line 1260 of file PcRtc.c.

◆ ConvertRtcTimeToEfiTime()

EFI_STATUS ConvertRtcTimeToEfiTime	(	IN OUT EFI_TIME *	Time,
		IN RTC_REGISTER_B	RegisterB
	)

Converts time read from RTC to EFI_TIME format defined by UEFI spec.

This function converts raw time data read from RTC to the EFI_TIME format defined by UEFI spec. If data mode of RTC is BCD, then converts it to decimal, If RTC is in 12-hour format, then converts it to 24-hour format.

Parameters

Time	On input, the time data read from RTC to convert On output, the time converted to UEFI format
RegisterB	Value of Register B of RTC, indicating data mode and hour format.

Return values

EFI_INVALID_PARAMETER	Parameters passed in are invalid.
EFI_SUCCESS	Convert RTC time to EFI time successfully.

Definition at line 1051 of file PcRtc.c.

◆ DayValid()

BOOLEAN DayValid ( IN EFI_TIME * Time )

See if field Day of an EFI_TIME is correct.

Parameters

Time	Its Day field is to be checked.

Return values

TRUE	Day field of Time is correct.
FALSE	Day field of Time is NOT correct.

Definition at line 271 of file RealTimeClock.c.

◆ GetCenturyRtcAddress()

UINT8 GetCenturyRtcAddress ( VOID )

Get the century RTC address from the ACPI FADT table.

Returns: The century RTC address or 0 if not found.

Definition at line 1404 of file PcRtc.c.

◆ InitializePcRtc()

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

The user Entry Point for PcRTC module.

This is the entry point for PcRTC module. It installs the UEFI runtime service including GetTime(),SetTime(),GetWakeupTime(),and SetWakeupTime().

Parameters

ImageHandle	The firmware allocated handle for the EFI image.
SystemTable	A pointer to the EFI System Table.

Return values

EFI_SUCCESS	The entry point is executed successfully.
Others	Some error occurs when executing this entry point.

Definition at line 157 of file PcRtcEntry.c.

◆ IsLeapYear()

BOOLEAN IsLeapYear ( IN EFI_TIME * Time )

Check if it is a leapyear.

Parameters

Time	The time to be checked.

Return values

TRUE	It is a leapyear.
FALSE	It is NOT a leapyear.

Check if it is a leap year.

Parameters

Time	The UEFI time to be checked.

Return values

TRUE	It is a leap year.
FALSE	It is NOT a leap year.

Check if it is a leap year.

Parameters

Time	The time to be checked.

Return values

TRUE	It is a leap year.
FALSE	It is NOT a leap year.

Definition at line 166 of file TimeBaseLib.c.

◆ PcRtcAcpiTableChangeCallback()

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

Notification function of ACPI Table change.

This is a notification function registered on ACPI Table change event. It saves the Century address stored in ACPI FADT table.

Parameters

Event	Event whose notification function is being invoked.
Context	Pointer to the notification function's context.

Definition at line 1436 of file PcRtc.c.

◆ PcRtcGetTime()

EFI_STATUS PcRtcGetTime	(	OUT EFI_TIME *	Time,
		OUT EFI_TIME_CAPABILITIES *Capabilities	OPTIONAL,
		IN PC_RTC_MODULE_GLOBALS *	Global
	)

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.
Global	For global use inside this module.

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.

Definition at line 527 of file PcRtc.c.

◆ PcRtcGetWakeupTime()

EFI_STATUS PcRtcGetWakeupTime	(	OUT BOOLEAN *	Enabled,
		OUT BOOLEAN *	Pending,
		OUT EFI_TIME *	Time,
		IN PC_RTC_MODULE_GLOBALS *	Global
	)

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.
Global	For global use inside this module.

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	A wakeup timer is not supported on this platform.

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 acknowledgment.
Time	The current alarm setting.
Global	For global use inside this module.

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	A wakeup timer is not supported on this platform.

Definition at line 750 of file PcRtc.c.

◆ PcRtcInit()

EFI_STATUS PcRtcInit ( IN PC_RTC_MODULE_GLOBALS * Global )

Initialize RTC.

Parameters

Global For global use inside this module.

Return values

EFI_DEVICE_ERROR	Initialization failed due to device error.
EFI_SUCCESS	Initialization successful.

Definition at line 262 of file PcRtc.c.

◆ PcRtcSetTime()

EFI_STATUS PcRtcSetTime	(	IN EFI_TIME *	Time,
		IN PC_RTC_MODULE_GLOBALS *	Global
	)

Sets the current local time and date information.

Parameters

Time	A pointer to the current time.
Global	For global use inside this module.

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 632 of file PcRtc.c.

◆ PcRtcSetWakeupTime()

EFI_STATUS PcRtcSetWakeupTime	(	IN BOOLEAN	Enable,
		IN EFI_TIME *Time	OPTIONAL,
		IN PC_RTC_MODULE_GLOBALS *	Global
	)

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. If Enable is FALSE, then this parameter is optional, and may be NULL.
Global	For global use inside this module.

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 868 of file PcRtc.c.

◆ RtcTimeFieldsValid()

EFI_STATUS RtcTimeFieldsValid ( IN EFI_TIME * Time )

See if all fields of a variable of EFI_TIME type is correct.

Parameters

Time	The time to be checked.

Return values

EFI_INVALID_PARAMETER	Some fields of Time are not correct.
EFI_SUCCESS	Time is a valid EFI_TIME variable.

Definition at line 238 of file RealTimeClock.c.

◆ RtcWaitToUpdate()

EFI_STATUS RtcWaitToUpdate ( UINTN Timeout )

Wait for a period for the RTC to be ready.

Parameters

Timeout Tell how long it should take to wait.

Return values

EFI_DEVICE_ERROR	RTC device error.
EFI_SUCCESS	RTC is updated and ready.

Definition at line 1124 of file PcRtc.c.

Variable Documentation

◆ mModuleGlobal

PC_RTC_MODULE_GLOBALS mModuleGlobal

extern

Definition at line 13 of file PcRtcEntry.c.

Data Structures

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ RTC_ADDRESS_DAY_OF_THE_MONTH

◆ RTC_ADDRESS_DAY_OF_THE_WEEK

◆ RTC_ADDRESS_HOURS

◆ RTC_ADDRESS_HOURS_ALARM

◆ RTC_ADDRESS_MINUTES

◆ RTC_ADDRESS_MINUTES_ALARM

◆ RTC_ADDRESS_MONTH

◆ RTC_ADDRESS_REGISTER_A

◆ RTC_ADDRESS_REGISTER_B

◆ RTC_ADDRESS_REGISTER_C

◆ RTC_ADDRESS_REGISTER_D

◆ RTC_ADDRESS_SECONDS

◆ RTC_ADDRESS_SECONDS_ALARM

◆ RTC_ADDRESS_YEAR

◆ RTC_DIV_RESET

◆ RTC_INIT_DAY

◆ RTC_INIT_HOUR

◆ RTC_INIT_MINUTE

◆ RTC_INIT_MONTH

◆ RTC_INIT_SECOND

Function Documentation

◆ ConvertEfiTimeToRtcTime()

◆ ConvertRtcTimeToEfiTime()

◆ DayValid()

◆ GetCenturyRtcAddress()

◆ InitializePcRtc()

◆ IsLeapYear()

◆ PcRtcAcpiTableChangeCallback()

◆ PcRtcGetTime()

◆ PcRtcGetWakeupTime()

◆ PcRtcInit()

◆ PcRtcSetTime()

◆ PcRtcSetWakeupTime()

◆ RtcTimeFieldsValid()

◆ RtcWaitToUpdate()

Variable Documentation

◆ mModuleGlobal