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