[mirror_edk2.git] / PcAtChipsetPkg / PcatRealTimeClockRuntimeDxe / PcRtc.h

/** @file\r
  Header file for real time clock driver.\r
\r
Copyright (c) 2006 - 2007, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
\r
#ifndef _RTC_H_\r
#define _RTC_H_\r
\r
\r
#include <Uefi.h>\r
\r
#include <Protocol/RealTimeClock.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/IoLib.h>\r
#include <Library/TimerLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiRuntimeLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/PcdLib.h>\r
\r
\r
typedef struct {\r
  EFI_LOCK  RtcLock;\r
  INT16     SavedTimeZone;\r
  UINT8     Daylight;\r
} PC_RTC_MODULE_GLOBALS;\r
\r
#define PCAT_RTC_ADDRESS_REGISTER 0x70\r
#define PCAT_RTC_DATA_REGISTER    0x71\r
\r
//\r
// Dallas DS12C887 Real Time Clock\r
//\r
#define RTC_ADDRESS_SECONDS           0   // R/W  Range 0..59\r
#define RTC_ADDRESS_SECONDS_ALARM     1   // R/W  Range 0..59\r
#define RTC_ADDRESS_MINUTES           2   // R/W  Range 0..59\r
#define RTC_ADDRESS_MINUTES_ALARM     3   // R/W  Range 0..59\r
#define RTC_ADDRESS_HOURS             4   // R/W  Range 1..12 or 0..23 Bit 7 is AM/PM\r
#define RTC_ADDRESS_HOURS_ALARM       5   // R/W  Range 1..12 or 0..23 Bit 7 is AM/PM\r
#define RTC_ADDRESS_DAY_OF_THE_WEEK   6   // R/W  Range 1..7\r
#define RTC_ADDRESS_DAY_OF_THE_MONTH  7   // R/W  Range 1..31\r
#define RTC_ADDRESS_MONTH             8   // R/W  Range 1..12\r
#define RTC_ADDRESS_YEAR              9   // R/W  Range 0..99\r
#define RTC_ADDRESS_REGISTER_A        10  // R/W[0..6]  R0[7]\r
#define RTC_ADDRESS_REGISTER_B        11  // R/W\r
#define RTC_ADDRESS_REGISTER_C        12  // RO\r
#define RTC_ADDRESS_REGISTER_D        13  // RO\r
#define RTC_ADDRESS_CENTURY           50  // R/W  Range 19..20 Bit 8 is R/W\r
//\r
// Date and time initial values.\r
// They are used if the RTC values are invalid during driver initialization\r
//\r
#define RTC_INIT_SECOND 0\r
#define RTC_INIT_MINUTE 0\r
#define RTC_INIT_HOUR   0\r
#define RTC_INIT_DAY    1\r
#define RTC_INIT_MONTH  1\r
#define RTC_INIT_YEAR   2001\r
\r
//\r
// Register initial values\r
//\r
#define RTC_INIT_REGISTER_A 0x26\r
#define RTC_INIT_REGISTER_B 0x02\r
#define RTC_INIT_REGISTER_D 0x0\r
\r
#pragma pack(1)\r
//\r
// Register A\r
//\r
typedef struct {\r
  UINT8 RS : 4;   // Rate Selection Bits\r
  UINT8 DV : 3;   // Divisor\r
  UINT8 UIP : 1;  // Update in progress\r
} RTC_REGISTER_A_BITS;\r
\r
typedef union {\r
  RTC_REGISTER_A_BITS Bits;\r
  UINT8               Data;\r
} RTC_REGISTER_A;\r
\r
//\r
// Register B\r
//\r
typedef struct {\r
  UINT8 DSE : 1;  // 0 - Daylight saving disabled  1 - Daylight savings enabled\r
  UINT8 MIL : 1;  // 0 - 12 hour mode              1 - 24 hour mode\r
  UINT8 DM : 1;   // 0 - BCD Format                1 - Binary Format\r
  UINT8 SQWE : 1; // 0 - Disable SQWE output       1 - Enable SQWE output\r
  UINT8 UIE : 1;  // 0 - Update INT disabled       1 - Update INT enabled\r
  UINT8 AIE : 1;  // 0 - Alarm INT disabled        1 - Alarm INT Enabled\r
  UINT8 PIE : 1;  // 0 - Periodic INT disabled     1 - Periodic INT Enabled\r
  UINT8 SET : 1;  // 0 - Normal operation.         1 - Updates inhibited\r
} RTC_REGISTER_B_BITS;\r
\r
typedef union {\r
  RTC_REGISTER_B_BITS Bits;\r
  UINT8               Data;\r
} RTC_REGISTER_B;\r
\r
//\r
// Register C\r
//\r
typedef struct {\r
  UINT8 Reserved : 4; // Read as zero.  Can not be written.\r
  UINT8 UF : 1;       // Update End Interrupt Flag\r
  UINT8 AF : 1;       // Alarm Interrupt Flag\r
  UINT8 PF : 1;       // Periodic Interrupt Flag\r
  UINT8 IRQF : 1;     // Iterrupt Request Flag = PF & PIE | AF & AIE | UF & UIE\r
} RTC_REGISTER_C_BITS;\r
\r
typedef union {\r
  RTC_REGISTER_C_BITS Bits;\r
  UINT8               Data;\r
} RTC_REGISTER_C;\r
\r
//\r
// Register D\r
//\r
typedef struct {\r
  UINT8 Reserved : 7; // Read as zero.  Can not be written.\r
  UINT8 VRT : 1;      // Valid RAM and Time\r
} RTC_REGISTER_D_BITS;\r
\r
typedef union {\r
  RTC_REGISTER_D_BITS Bits;\r
  UINT8               Data;\r
} RTC_REGISTER_D;\r
\r
#pragma pack()\r
\r
/**\r
  Initialize RTC.\r
\r
  @param  Global            For global use inside this module.\r
\r
  @retval EFI_DEVICE_ERROR  Initialization failed due to device error.\r
  @retval EFI_SUCCESS       Initialization successful.\r
\r
**/\r
EFI_STATUS\r
PcRtcInit (\r
  IN PC_RTC_MODULE_GLOBALS  *Global\r
  );\r
\r
/**\r
  Sets the current local time and date information.\r
\r
  @param  Time                  A pointer to the current time.\r
  @param  Global                For global use inside this module.\r
\r
  @retval EFI_SUCCESS           The operation completed successfully.\r
  @retval EFI_INVALID_PARAMETER A time field is out of range.\r
  @retval EFI_DEVICE_ERROR      The time could not be set due due to hardware error.\r
\r
**/\r
EFI_STATUS\r
PcRtcSetTime (\r
  IN EFI_TIME               *Time,\r
  IN PC_RTC_MODULE_GLOBALS  *Global\r
  );\r
\r
/**\r
  Returns the current time and date information, and the time-keeping capabilities\r
  of the hardware platform.\r
\r
  @param  Time          A pointer to storage to receive a snapshot of the current time.\r
  @param  Capabilities  An optional pointer to a buffer to receive the real time clock\r
                        device's capabilities.\r
  @param  Global        For global use inside this module.\r
\r
  @retval EFI_SUCCESS            The operation completed successfully.\r
  @retval EFI_INVALID_PARAMETER  Time is NULL.\r
  @retval EFI_DEVICE_ERROR       The time could not be retrieved due to hardware error.\r
\r
**/\r
EFI_STATUS\r
PcRtcGetTime (\r
  OUT EFI_TIME              *Time,\r
  OUT EFI_TIME_CAPABILITIES *Capabilities, OPTIONAL\r
  IN  PC_RTC_MODULE_GLOBALS *Global\r
  );\r
\r
/**\r
  Sets the system wakeup alarm clock time.\r
\r
  @param  Enabled  Enable or disable the wakeup alarm.\r
  @param  Time     If Enable is TRUE, the time to set the wakeup alarm for.\r
                   If Enable is FALSE, then this parameter is optional, and may be NULL.\r
  @param  Global   For global use inside this module.\r
\r
  @retval EFI_SUCCESS           If Enable is TRUE, then the wakeup alarm was enabled.\r
                                If Enable is FALSE, then the wakeup alarm was disabled.\r
  @retval EFI_INVALID_PARAMETER A time field is out of range.\r
  @retval EFI_DEVICE_ERROR      The wakeup time could not be set due to a hardware error.\r
  @retval EFI_UNSUPPORTED       A wakeup timer is not supported on this platform.\r
\r
**/\r
EFI_STATUS\r
PcRtcSetWakeupTime (\r
  IN BOOLEAN                Enable,\r
  IN EFI_TIME               *Time,  OPTIONAL\r
  IN PC_RTC_MODULE_GLOBALS  *Global\r
  );\r
\r
/**\r
  Returns the current wakeup alarm clock setting.\r
\r
  @param  Enabled  Indicates if the alarm is currently enabled or disabled.\r
  @param  Pending  Indicates if the alarm signal is pending and requires acknowledgement.\r
  @param  Time     The current alarm setting.\r
  @param  Global   For global use inside this module.\r
\r
  @retval EFI_SUCCESS           The alarm settings were returned.\r
  @retval EFI_INVALID_PARAMETER Enabled is NULL.\r
  @retval EFI_INVALID_PARAMETER Pending is NULL.\r
  @retval EFI_INVALID_PARAMETER Time is NULL.\r
  @retval EFI_DEVICE_ERROR      The wakeup time could not be retrieved due to a hardware error.\r
  @retval EFI_UNSUPPORTED       A wakeup timer is not supported on this platform.\r
\r
**/\r
EFI_STATUS\r
PcRtcGetWakeupTime (\r
  OUT BOOLEAN               *Enabled,\r
  OUT BOOLEAN               *Pending,\r
  OUT EFI_TIME              *Time,\r
  IN  PC_RTC_MODULE_GLOBALS *Global\r
  );\r
\r
/**\r
  The user Entry Point for PcRTC module.\r
\r
  This is the entrhy point for PcRTC module. It installs the UEFI runtime service\r
  including GetTime(),SetTime(),GetWakeupTime(),and SetWakeupTime().\r
\r
  @param  ImageHandle    The firmware allocated handle for the EFI image.\r
  @param  SystemTable    A pointer to the EFI System Table.\r
\r
  @retval EFI_SUCCESS    The entry point is executed successfully.\r
  @retval Others         Some error occurs when executing this entry point.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
InitializePcRtc (\r
  IN EFI_HANDLE                            ImageHandle,\r
  IN EFI_SYSTEM_TABLE                      *SystemTable\r
  );\r
\r
/**\r
  See if all fields of a variable of EFI_TIME type is correct.\r
\r
  @param   Time   The time to be checked.\r
\r
  @retval  EFI_INVALID_PARAMETER  Some fields of Time are not correct.\r
  @retval  EFI_SUCCESS            Time is a valid EFI_TIME variable.\r
\r
**/\r
EFI_STATUS\r
RtcTimeFieldsValid (\r
  IN EFI_TIME *Time\r
  );\r
\r
/**\r
  Converts time from EFI_TIME format defined by UEFI spec to RTC's.\r
\r
  This function converts time from EFI_TIME format defined by UEFI spec to RTC's.\r
  If data mode of RTC is BCD, then converts EFI_TIME to it.\r
  If RTC is in 12-hour format, then converts EFI_TIME to it.\r
\r
  @param   Time       On input, the time data read from UEFI to convert\r
                      On output, the time converted to RTC format\r
  @param   RegisterB  Value of Register B of RTC, indicating data mode\r
  @param   Century    It is set according to EFI_TIME Time.\r
\r
**/\r
VOID\r
ConvertEfiTimeToRtcTime (\r
  IN OUT EFI_TIME        *Time,\r
  IN     RTC_REGISTER_B  RegisterB,\r
  OUT    UINT8           *Century\r
  );\r
\r
\r
/**\r
  Converts time read from RTC to EFI_TIME format defined by UEFI spec.\r
\r
  This function converts raw time data read from RTC to the EFI_TIME format\r
  defined by UEFI spec.\r
  If data mode of RTC is BCD, then converts it to decimal,\r
  If RTC is in 12-hour format, then converts it to 24-hour format.\r
\r
  @param   Time       On input, the time data read from RTC to convert\r
                      On output, the time converted to UEFI format\r
  @param   Century    Value of century read from RTC.\r
  @param   RegisterB  Value of Register B of RTC, indicating data mode\r
                      and hour format.\r
\r
  @retval  EFI_INVALID_PARAMETER  Parameters passed in are invalid.\r
  @retval  EFI_SUCCESS            Convert RTC time to EFI time successfully.\r
\r
**/\r
EFI_STATUS\r
ConvertRtcTimeToEfiTime (\r
  IN OUT EFI_TIME        *Time,\r
  IN     UINT8           Century,\r
  IN     RTC_REGISTER_B  RegisterB\r
  );\r
\r
/**\r
  Wait for a period for the RTC to be ready.\r
\r
  @param    Timeout  Tell how long it should take to wait.\r
\r
  @retval   EFI_DEVICE_ERROR   RTC device error.\r
  @retval   EFI_SUCCESS        RTC is updated and ready.  \r
**/\r
EFI_STATUS\r
RtcWaitToUpdate (\r
  UINTN Timeout\r
  );\r
\r
/**\r
  See if field Day of an EFI_TIME is correct.\r
\r
  @param    Time   Its Day field is to be checked.\r
\r
  @retval   TRUE   Day field of Time is correct.\r
  @retval   FALSE  Day field of Time is NOT correct.\r
**/\r
BOOLEAN\r
DayValid (\r
  IN  EFI_TIME  *Time\r
  );\r
\r
/**\r
  Check if it is a leapyear.\r
\r
  @param    Time   The time to be checked.\r
\r
  @retval   TRUE   It is a leapyear.\r
  @retval   FALSE  It is NOT a leapyear.\r
**/\r
BOOLEAN\r
IsLeapYear (\r
  IN EFI_TIME   *Time\r
  );\r
\r
#endif\r
Commit	Line	Data
fb0b259e	1	/** @file\r
fb0b259e	2	Header file for real time clock driver.\r
8cd4d17c	3	\r
95d48e82 HT	4	Copyright (c) 2006 - 2007, Intel Corporation. All rights reserved.<BR>\r
95d48e82 HT	5	This program and the accompanying materials\r
3cfb790c	6	are licensed and made available under the terms and conditions of the BSD License\r
	7	which accompanies this distribution. The full text of the license may be found at\r
	8	http://opensource.org/licenses/bsd-license.php\r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
8cd4d17c	12	\r
fb0b259e	13	**/\r
8cd4d17c	14	\r
8cd4d17c	15	\r
	16	#ifndef _RTC_H_\r
	17	#define _RTC_H_\r
	18	\r
ed7748fe	19	\r
60c93673	20	#include <Uefi.h>\r
ed7748fe	21	\r
8cd4d17c	22	#include <Protocol/RealTimeClock.h>\r
ed7748fe	23	\r
8cd4d17c	24	#include <Library/BaseLib.h>\r
	25	#include <Library/DebugLib.h>\r
	26	#include <Library/UefiLib.h>\r
	27	#include <Library/BaseMemoryLib.h>\r
	28	#include <Library/IoLib.h>\r
	29	#include <Library/TimerLib.h>\r
	30	#include <Library/UefiDriverEntryPoint.h>\r
	31	#include <Library/UefiBootServicesTableLib.h>\r
	32	#include <Library/UefiRuntimeLib.h>\r
	33	#include <Library/UefiRuntimeServicesTableLib.h>\r
835e5a5f	34	#include <Library/PcdLib.h>\r
8cd4d17c	35	\r
	36	\r
	37	typedef struct {\r
	38	EFI_LOCK RtcLock;\r
ec35e997	39	INT16 SavedTimeZone;\r
8cd4d17c	40	UINT8 Daylight;\r
	41	} PC_RTC_MODULE_GLOBALS;\r
	42	\r
	43	#define PCAT_RTC_ADDRESS_REGISTER 0x70\r
	44	#define PCAT_RTC_DATA_REGISTER 0x71\r
	45	\r
	46	//\r
	47	// Dallas DS12C887 Real Time Clock\r
	48	//\r
	49	#define RTC_ADDRESS_SECONDS 0 // R/W Range 0..59\r
	50	#define RTC_ADDRESS_SECONDS_ALARM 1 // R/W Range 0..59\r
	51	#define RTC_ADDRESS_MINUTES 2 // R/W Range 0..59\r
	52	#define RTC_ADDRESS_MINUTES_ALARM 3 // R/W Range 0..59\r
	53	#define RTC_ADDRESS_HOURS 4 // R/W Range 1..12 or 0..23 Bit 7 is AM/PM\r
	54	#define RTC_ADDRESS_HOURS_ALARM 5 // R/W Range 1..12 or 0..23 Bit 7 is AM/PM\r
	55	#define RTC_ADDRESS_DAY_OF_THE_WEEK 6 // R/W Range 1..7\r
	56	#define RTC_ADDRESS_DAY_OF_THE_MONTH 7 // R/W Range 1..31\r
	57	#define RTC_ADDRESS_MONTH 8 // R/W Range 1..12\r
	58	#define RTC_ADDRESS_YEAR 9 // R/W Range 0..99\r
	59	#define RTC_ADDRESS_REGISTER_A 10 // R/W[0..6] R0[7]\r
	60	#define RTC_ADDRESS_REGISTER_B 11 // R/W\r
	61	#define RTC_ADDRESS_REGISTER_C 12 // RO\r
	62	#define RTC_ADDRESS_REGISTER_D 13 // RO\r
	63	#define RTC_ADDRESS_CENTURY 50 // R/W Range 19..20 Bit 8 is R/W\r
	64	//\r
	65	// Date and time initial values.\r
	66	// They are used if the RTC values are invalid during driver initialization\r
	67	//\r
	68	#define RTC_INIT_SECOND 0\r
	69	#define RTC_INIT_MINUTE 0\r
	70	#define RTC_INIT_HOUR 0\r
	71	#define RTC_INIT_DAY 1\r
	72	#define RTC_INIT_MONTH 1\r
	73	#define RTC_INIT_YEAR 2001\r
	74	\r
	75	//\r
	76	// Register initial values\r
	77	//\r
	78	#define RTC_INIT_REGISTER_A 0x26\r
	79	#define RTC_INIT_REGISTER_B 0x02\r
	80	#define RTC_INIT_REGISTER_D 0x0\r
	81	\r
	82	#pragma pack(1)\r
	83	//\r
	84	// Register A\r
	85	//\r
	86	typedef struct {\r
	87	UINT8 RS : 4; // Rate Selection Bits\r
	88	UINT8 DV : 3; // Divisor\r
	89	UINT8 UIP : 1; // Update in progress\r
	90	} RTC_REGISTER_A_BITS;\r
	91	\r
	92	typedef union {\r
	93	RTC_REGISTER_A_BITS Bits;\r
	94	UINT8 Data;\r
	95	} RTC_REGISTER_A;\r
	96	\r
	97	//\r
	98	// Register B\r
	99	//\r
	100	typedef struct {\r
	101	UINT8 DSE : 1; // 0 - Daylight saving disabled 1 - Daylight savings enabled\r
	102	UINT8 MIL : 1; // 0 - 12 hour mode 1 - 24 hour mode\r
	103	UINT8 DM : 1; // 0 - BCD Format 1 - Binary Format\r
104	UINT8 SQWE : 1; // 0 - Disable SQWE output 1 - Enable SQWE output\r
105	UINT8 UIE : 1; // 0 - Update INT disabled 1 - Update INT enabled\r
106	UINT8 AIE : 1; // 0 - Alarm INT disabled 1 - Alarm INT Enabled\r
107	UINT8 PIE : 1; // 0 - Periodic INT disabled 1 - Periodic INT Enabled\r
108	UINT8 SET : 1; // 0 - Normal operation. 1 - Updates inhibited\r
109	} RTC_REGISTER_B_BITS;\r
110	\r
111	typedef union {\r
112	RTC_REGISTER_B_BITS Bits;\r
113	UINT8 Data;\r
114	} RTC_REGISTER_B;\r
115	\r
116	//\r
117	// Register C\r
118	//\r
119	typedef struct {\r
120	UINT8 Reserved : 4; // Read as zero. Can not be written.\r
121	UINT8 UF : 1; // Update End Interrupt Flag\r
122	UINT8 AF : 1; // Alarm Interrupt Flag\r
123	UINT8 PF : 1; // Periodic Interrupt Flag\r
124	UINT8 IRQF : 1; // Iterrupt Request Flag = PF & PIE \| AF & AIE \| UF & UIE\r
125	} RTC_REGISTER_C_BITS;\r
126	\r
127	typedef union {\r
128	RTC_REGISTER_C_BITS Bits;\r
129	UINT8 Data;\r
130	} RTC_REGISTER_C;\r
131	\r
132	//\r
133	// Register D\r
134	//\r
135	typedef struct {\r
136	UINT8 Reserved : 7; // Read as zero. Can not be written.\r
137	UINT8 VRT : 1; // Valid RAM and Time\r
138	} RTC_REGISTER_D_BITS;\r
139	\r
140	typedef union {\r
141	RTC_REGISTER_D_BITS Bits;\r
142	UINT8 Data;\r
143	} RTC_REGISTER_D;\r
144	\r
145	#pragma pack()\r
146	\r
8d85dc31	147	/**\r
	148	Initialize RTC.\r
	149	\r
	150	@param Global For global use inside this module.\r
	151	\r
	152	@retval EFI_DEVICE_ERROR Initialization failed due to device error.\r
	153	@retval EFI_SUCCESS Initialization successful.\r
	154	\r
	155	**/\r
8cd4d17c	156	EFI_STATUS\r
	157	PcRtcInit (\r
	158	IN PC_RTC_MODULE_GLOBALS *Global\r
21176834	159	);\r
8cd4d17c	160	\r
8d85dc31	161	/**\r
8d85dc31	162	Sets the current local time and date information.\r
8cd4d17c	163	\r
8d85dc31	164	@param Time A pointer to the current time.\r
8d85dc31	165	@param Global For global use inside this module.\r
8cd4d17c	166	\r
8d85dc31	167	@retval EFI_SUCCESS The operation completed successfully.\r
	168	@retval EFI_INVALID_PARAMETER A time field is out of range.\r
	169	@retval EFI_DEVICE_ERROR The time could not be set due due to hardware error.\r
8cd4d17c	170	\r
8d85dc31	171	**/\r
8cd4d17c	172	EFI_STATUS\r
	173	PcRtcSetTime (\r
	174	IN EFI_TIME *Time,\r
	175	IN PC_RTC_MODULE_GLOBALS *Global\r
21176834	176	);\r
8cd4d17c	177	\r
8d85dc31	178	/**\r
	179	Returns the current time and date information, and the time-keeping capabilities\r
	180	of the hardware platform.\r
8cd4d17c	181	\r
8d85dc31	182	@param Time A pointer to storage to receive a snapshot of the current time.\r
	183	@param Capabilities An optional pointer to a buffer to receive the real time clock\r
	184	device's capabilities.\r
	185	@param Global For global use inside this module.\r
8cd4d17c	186	\r
8d85dc31	187	@retval EFI_SUCCESS The operation completed successfully.\r
	188	@retval EFI_INVALID_PARAMETER Time is NULL.\r
	189	@retval EFI_DEVICE_ERROR The time could not be retrieved due to hardware error.\r
8cd4d17c	190	\r
8d85dc31	191	**/\r
8cd4d17c	192	EFI_STATUS\r
	193	PcRtcGetTime (\r
	194	OUT EFI_TIME *Time,\r
8d85dc31	195	OUT EFI_TIME_CAPABILITIES *Capabilities, OPTIONAL\r
8cd4d17c	196	IN PC_RTC_MODULE_GLOBALS *Global\r
21176834	197	);\r
8cd4d17c	198	\r
8d85dc31	199	/**\r
8d85dc31	200	Sets the system wakeup alarm clock time.\r
8cd4d17c	201	\r
8d85dc31	202	@param Enabled Enable or disable the wakeup alarm.\r
	203	@param Time If Enable is TRUE, the time to set the wakeup alarm for.\r
	204	If Enable is FALSE, then this parameter is optional, and may be NULL.\r
	205	@param Global For global use inside this module.\r
8cd4d17c	206	\r
8d85dc31	207	@retval EFI_SUCCESS If Enable is TRUE, then the wakeup alarm was enabled.\r
	208	If Enable is FALSE, then the wakeup alarm was disabled.\r
	209	@retval EFI_INVALID_PARAMETER A time field is out of range.\r
	210	@retval EFI_DEVICE_ERROR The wakeup time could not be set due to a hardware error.\r
	211	@retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.\r
8cd4d17c	212	\r
8d85dc31	213	**/\r
8cd4d17c	214	EFI_STATUS\r
	215	PcRtcSetWakeupTime (\r
	216	IN BOOLEAN Enable,\r
8d85dc31	217	IN EFI_TIME *Time, OPTIONAL\r
8d85dc31	218	IN PC_RTC_MODULE_GLOBALS *Global\r
21176834	219	);\r
8cd4d17c	220	\r
8d85dc31	221	/**\r
8d85dc31	222	Returns the current wakeup alarm clock setting.\r
8cd4d17c	223	\r
8d85dc31	224	@param Enabled Indicates if the alarm is currently enabled or disabled.\r
	225	@param Pending Indicates if the alarm signal is pending and requires acknowledgement.\r
	226	@param Time The current alarm setting.\r
	227	@param Global For global use inside this module.\r
8cd4d17c	228	\r
8d85dc31	229	@retval EFI_SUCCESS The alarm settings were returned.\r
	230	@retval EFI_INVALID_PARAMETER Enabled is NULL.\r
	231	@retval EFI_INVALID_PARAMETER Pending is NULL.\r
	232	@retval EFI_INVALID_PARAMETER Time is NULL.\r
	233	@retval EFI_DEVICE_ERROR The wakeup time could not be retrieved due to a hardware error.\r
	234	@retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.\r
8cd4d17c	235	\r
8d85dc31	236	**/\r
8cd4d17c	237	EFI_STATUS\r
	238	PcRtcGetWakeupTime (\r
	239	OUT BOOLEAN *Enabled,\r
	240	OUT BOOLEAN *Pending,\r
	241	OUT EFI_TIME *Time,\r
	242	IN PC_RTC_MODULE_GLOBALS *Global\r
21176834	243	);\r
8cd4d17c	244	\r
8d85dc31	245	/**\r
8d85dc31	246	The user Entry Point for PcRTC module.\r
8cd4d17c	247	\r
8d85dc31	248	This is the entrhy point for PcRTC module. It installs the UEFI runtime service\r
8d85dc31	249	including GetTime(),SetTime(),GetWakeupTime(),and SetWakeupTime().\r
8cd4d17c	250	\r
8d85dc31	251	@param ImageHandle The firmware allocated handle for the EFI image.\r
8d85dc31	252	@param SystemTable A pointer to the EFI System Table.\r
8cd4d17c	253	\r
8d85dc31	254	@retval EFI_SUCCESS The entry point is executed successfully.\r
8d85dc31	255	@retval Others Some error occurs when executing this entry point.\r
8cd4d17c	256	\r
8d85dc31	257	**/\r
8cd4d17c	258	EFI_STATUS\r
	259	EFIAPI\r
	260	InitializePcRtc (\r
	261	IN EFI_HANDLE ImageHandle,\r
	262	IN EFI_SYSTEM_TABLE *SystemTable\r
21176834	263	);\r
8cd4d17c	264	\r
8d85dc31	265	/**\r
8d85dc31	266	See if all fields of a variable of EFI_TIME type is correct.\r
8cd4d17c	267	\r
8d85dc31	268	@param Time The time to be checked.\r
8cd4d17c	269	\r
8d85dc31	270	@retval EFI_INVALID_PARAMETER Some fields of Time are not correct.\r
8d85dc31	271	@retval EFI_SUCCESS Time is a valid EFI_TIME variable.\r
8cd4d17c	272	\r
8d85dc31	273	**/\r
8cd4d17c	274	EFI_STATUS\r
	275	RtcTimeFieldsValid (\r
	276	IN EFI_TIME *Time\r
21176834	277	);\r
8cd4d17c	278	\r
8d85dc31	279	/**\r
8d85dc31	280	Converts time from EFI_TIME format defined by UEFI spec to RTC's.\r
8cd4d17c	281	\r
8d85dc31	282	This function converts time from EFI_TIME format defined by UEFI spec to RTC's.\r
	283	If data mode of RTC is BCD, then converts EFI_TIME to it.\r
	284	If RTC is in 12-hour format, then converts EFI_TIME to it.\r
8cd4d17c	285	\r
8d85dc31	286	@param Time On input, the time data read from UEFI to convert\r
	287	On output, the time converted to RTC format\r
	288	@param RegisterB Value of Register B of RTC, indicating data mode\r
	289	@param Century It is set according to EFI_TIME Time.\r
8cd4d17c	290	\r
8d85dc31	291	**/\r
8cd4d17c	292	VOID\r
8cd4d17c	293	ConvertEfiTimeToRtcTime (\r
8d85dc31	294	IN OUT EFI_TIME *Time,\r
	295	IN RTC_REGISTER_B RegisterB,\r
	296	OUT UINT8 *Century\r
21176834	297	);\r
8cd4d17c	298	\r
8cd4d17c	299	\r
254ba247	300	/**\r
254ba247	301	Converts time read from RTC to EFI_TIME format defined by UEFI spec.\r
8cd4d17c	302	\r
254ba247	303	This function converts raw time data read from RTC to the EFI_TIME format\r
	304	defined by UEFI spec.\r
	305	If data mode of RTC is BCD, then converts it to decimal,\r
	306	If RTC is in 12-hour format, then converts it to 24-hour format.\r
8cd4d17c	307	\r
254ba247	308	@param Time On input, the time data read from RTC to convert\r
	309	On output, the time converted to UEFI format\r
	310	@param Century Value of century read from RTC.\r
	311	@param RegisterB Value of Register B of RTC, indicating data mode\r
	312	and hour format.\r
8cd4d17c	313	\r
8d85dc31	314	@retval EFI_INVALID_PARAMETER Parameters passed in are invalid.\r
	315	@retval EFI_SUCCESS Convert RTC time to EFI time successfully.\r
	316	\r
254ba247	317	**/\r
	318	EFI_STATUS\r
	319	ConvertRtcTimeToEfiTime (\r
	320	IN OUT EFI_TIME *Time,\r
	321	IN UINT8 Century,\r
	322	IN RTC_REGISTER_B RegisterB\r
ed66e1bc	323	);\r
8cd4d17c	324	\r
8d85dc31	325	/**\r
	326	Wait for a period for the RTC to be ready.\r
	327	\r
	328	@param Timeout Tell how long it should take to wait.\r
	329	\r
	330	@retval EFI_DEVICE_ERROR RTC device error.\r
	331	@retval EFI_SUCCESS RTC is updated and ready. \r
	332	**/\r
8cd4d17c	333	EFI_STATUS\r
	334	RtcWaitToUpdate (\r
	335	UINTN Timeout\r
21176834	336	);\r
8cd4d17c	337	\r
8d85dc31	338	/**\r
8d85dc31	339	See if field Day of an EFI_TIME is correct.\r
8cd4d17c	340	\r
8d85dc31	341	@param Time Its Day field is to be checked.\r
8cd4d17c	342	\r
8d85dc31	343	@retval TRUE Day field of Time is correct.\r
	344	@retval FALSE Day field of Time is NOT correct.\r
	345	**/\r
8cd4d17c	346	BOOLEAN\r
	347	DayValid (\r
	348	IN EFI_TIME *Time\r
	349	);\r
	350	\r
8d85dc31	351	/**\r
	352	Check if it is a leapyear.\r
	353	\r
	354	@param Time The time to be checked.\r
	355	\r
	356	@retval TRUE It is a leapyear.\r
	357	@retval FALSE It is NOT a leapyear.\r
	358	**/\r
8cd4d17c	359	BOOLEAN\r
	360	IsLeapYear (\r
	361	IN EFI_TIME *Time\r
	362	);\r
	363	\r
	364	#endif\r