]>
Commit | Line | Data |
---|---|---|
fb0b259e | 1 | /** @file\r |
2 | Header file for real time clock driver.\r | |
8cd4d17c | 3 | \r |
fb0b259e | 4 | Copyright (c) 2006 - 2007, Intel Corporation\r |
3cfb790c | 5 | All rights reserved. This program and the accompanying materials\r |
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 |
ec35e997 | 23 | #include <Guid/GenericPlatformVariable.h>\r |
ed7748fe | 24 | \r |
8cd4d17c | 25 | #include <Library/BaseLib.h>\r |
26 | #include <Library/DebugLib.h>\r | |
27 | #include <Library/UefiLib.h>\r | |
28 | #include <Library/BaseMemoryLib.h>\r | |
29 | #include <Library/IoLib.h>\r | |
30 | #include <Library/TimerLib.h>\r | |
31 | #include <Library/UefiDriverEntryPoint.h>\r | |
32 | #include <Library/UefiBootServicesTableLib.h>\r | |
33 | #include <Library/UefiRuntimeLib.h>\r | |
34 | #include <Library/UefiRuntimeServicesTableLib.h>\r | |
835e5a5f | 35 | #include <Library/PcdLib.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 | |
88 | UINT8 RS : 4; // Rate Selection Bits\r | |
89 | UINT8 DV : 3; // Divisor\r | |
90 | UINT8 UIP : 1; // Update in progress\r | |
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 | |
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 | |
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 | |
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 | |
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 | |
138 | UINT8 VRT : 1; // Valid RAM and Time\r | |
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 |
163 | Sets the current local time and date information.\r | |
8cd4d17c | 164 | \r |
8d85dc31 | 165 | @param Time A pointer to the current time.\r |
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 |
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 |
219 | IN PC_RTC_MODULE_GLOBALS *Global\r | |
21176834 | 220 | );\r |
8cd4d17c | 221 | \r |
8d85dc31 | 222 | /**\r |
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 |
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 |
250 | including GetTime(),SetTime(),GetWakeupTime(),and SetWakeupTime().\r | |
8cd4d17c | 251 | \r |
8d85dc31 | 252 | @param ImageHandle The firmware allocated handle for the EFI image.\r |
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 |
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 |
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 |
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 |
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 |
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 |
8d85dc31 | 300 | /**\r |
301 | See if centry register of RTC is valid.\r | |
302 | \r | |
303 | @retval EFI_SUCCESS Century register is valid.\r | |
304 | @retval EFI_DEVICE_ERROR Century register is NOT valid.\r | |
305 | **/\r | |
8cd4d17c | 306 | EFI_STATUS\r |
307 | RtcTestCenturyRegister (\r | |
308 | VOID\r | |
21176834 | 309 | );\r |
8cd4d17c | 310 | \r |
254ba247 | 311 | /**\r |
312 | Converts time read from RTC to EFI_TIME format defined by UEFI spec.\r | |
8cd4d17c | 313 | \r |
254ba247 | 314 | This function converts raw time data read from RTC to the EFI_TIME format\r |
315 | defined by UEFI spec.\r | |
316 | If data mode of RTC is BCD, then converts it to decimal,\r | |
317 | If RTC is in 12-hour format, then converts it to 24-hour format.\r | |
8cd4d17c | 318 | \r |
254ba247 | 319 | @param Time On input, the time data read from RTC to convert\r |
320 | On output, the time converted to UEFI format\r | |
321 | @param Century Value of century read from RTC.\r | |
322 | @param RegisterB Value of Register B of RTC, indicating data mode\r | |
323 | and hour format.\r | |
8cd4d17c | 324 | \r |
8d85dc31 | 325 | @retval EFI_INVALID_PARAMETER Parameters passed in are invalid.\r |
326 | @retval EFI_SUCCESS Convert RTC time to EFI time successfully.\r | |
327 | \r | |
254ba247 | 328 | **/\r |
329 | EFI_STATUS\r | |
330 | ConvertRtcTimeToEfiTime (\r | |
331 | IN OUT EFI_TIME *Time,\r | |
332 | IN UINT8 Century,\r | |
333 | IN RTC_REGISTER_B RegisterB\r | |
ed66e1bc | 334 | );\r |
8cd4d17c | 335 | \r |
8d85dc31 | 336 | /**\r |
337 | Wait for a period for the RTC to be ready.\r | |
338 | \r | |
339 | @param Timeout Tell how long it should take to wait.\r | |
340 | \r | |
341 | @retval EFI_DEVICE_ERROR RTC device error.\r | |
342 | @retval EFI_SUCCESS RTC is updated and ready. \r | |
343 | **/\r | |
8cd4d17c | 344 | EFI_STATUS\r |
345 | RtcWaitToUpdate (\r | |
346 | UINTN Timeout\r | |
21176834 | 347 | );\r |
8cd4d17c | 348 | \r |
8d85dc31 | 349 | /**\r |
350 | See if field Day of an EFI_TIME is correct.\r | |
8cd4d17c | 351 | \r |
8d85dc31 | 352 | @param Time Its Day field is to be checked.\r |
8cd4d17c | 353 | \r |
8d85dc31 | 354 | @retval TRUE Day field of Time is correct.\r |
355 | @retval FALSE Day field of Time is NOT correct.\r | |
356 | **/\r | |
8cd4d17c | 357 | BOOLEAN\r |
358 | DayValid (\r | |
359 | IN EFI_TIME *Time\r | |
360 | );\r | |
361 | \r | |
8d85dc31 | 362 | /**\r |
363 | Check if it is a leapyear.\r | |
364 | \r | |
365 | @param Time The time to be checked.\r | |
366 | \r | |
367 | @retval TRUE It is a leapyear.\r | |
368 | @retval FALSE It is NOT a leapyear.\r | |
369 | **/\r | |
8cd4d17c | 370 | BOOLEAN\r |
371 | IsLeapYear (\r | |
372 | IN EFI_TIME *Time\r | |
373 | );\r | |
374 | \r | |
375 | #endif\r |