]>
Commit | Line | Data |
---|---|---|
2ef2b01e A |
1 | /** @file\r |
2 | Implement EFI RealTimeClock runtime services via Lib.\r | |
3402aac7 | 3 | \r |
2ef2b01e A |
4 | Currently this driver does not support runtime virtual calling.\r |
5 | \r | |
60274cca | 6 | Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r |
2ef2b01e | 7 | \r |
878b807a | 8 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
2ef2b01e A |
9 | \r |
10 | **/\r | |
11 | \r | |
12 | #ifndef __REAL_TIME_CLOCK_LIB__\r | |
13 | #define __REAL_TIME_CLOCK_LIB__\r | |
14 | \r | |
15 | \r | |
16 | /**\r | |
17 | Returns the current time and date information, and the time-keeping capabilities\r | |
18 | of the hardware platform.\r | |
19 | \r | |
20 | @param Time A pointer to storage to receive a snapshot of the current time.\r | |
21 | @param Capabilities An optional pointer to a buffer to receive the real time clock\r | |
22 | device's capabilities.\r | |
23 | \r | |
24 | @retval EFI_SUCCESS The operation completed successfully.\r | |
25 | @retval EFI_INVALID_PARAMETER Time is NULL.\r | |
26 | @retval EFI_DEVICE_ERROR The time could not be retrieved due to hardware error.\r | |
27 | \r | |
28 | **/\r | |
29 | EFI_STATUS\r | |
30 | EFIAPI\r | |
31 | LibGetTime (\r | |
32 | OUT EFI_TIME *Time,\r | |
33 | OUT EFI_TIME_CAPABILITIES *Capabilities\r | |
34 | );\r | |
35 | \r | |
36 | \r | |
37 | /**\r | |
38 | Sets the current local time and date information.\r | |
39 | \r | |
40 | @param Time A pointer to the current time.\r | |
41 | \r | |
42 | @retval EFI_SUCCESS The operation completed successfully.\r | |
43 | @retval EFI_INVALID_PARAMETER A time field is out of range.\r | |
44 | @retval EFI_DEVICE_ERROR The time could not be set due due to hardware error.\r | |
45 | \r | |
46 | **/\r | |
47 | EFI_STATUS\r | |
48 | EFIAPI\r | |
49 | LibSetTime (\r | |
50 | IN EFI_TIME *Time\r | |
51 | );\r | |
52 | \r | |
53 | \r | |
54 | /**\r | |
55 | Returns the current wakeup alarm clock setting.\r | |
56 | \r | |
57 | @param Enabled Indicates if the alarm is currently enabled or disabled.\r | |
58 | @param Pending Indicates if the alarm signal is pending and requires acknowledgement.\r | |
59 | @param Time The current alarm setting.\r | |
60 | \r | |
61 | @retval EFI_SUCCESS The alarm settings were returned.\r | |
62 | @retval EFI_INVALID_PARAMETER Any parameter is NULL.\r | |
63 | @retval EFI_DEVICE_ERROR The wakeup time could not be retrieved due to a hardware error.\r | |
64 | \r | |
65 | **/\r | |
66 | EFI_STATUS\r | |
67 | EFIAPI\r | |
68 | LibGetWakeupTime (\r | |
69 | OUT BOOLEAN *Enabled,\r | |
70 | OUT BOOLEAN *Pending,\r | |
71 | OUT EFI_TIME *Time\r | |
72 | );\r | |
73 | \r | |
74 | \r | |
75 | /**\r | |
76 | Sets the system wakeup alarm clock time.\r | |
77 | \r | |
78 | @param Enabled Enable or disable the wakeup alarm.\r | |
79 | @param Time If Enable is TRUE, the time to set the wakeup alarm for.\r | |
80 | \r | |
81 | @retval EFI_SUCCESS If Enable is TRUE, then the wakeup alarm was enabled. If\r | |
82 | Enable is FALSE, then the wakeup alarm was disabled.\r | |
83 | @retval EFI_INVALID_PARAMETER A time field is out of range.\r | |
84 | @retval EFI_DEVICE_ERROR The wakeup time could not be set due to a hardware error.\r | |
85 | @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.\r | |
86 | \r | |
87 | **/\r | |
88 | EFI_STATUS\r | |
89 | EFIAPI\r | |
90 | LibSetWakeupTime (\r | |
91 | IN BOOLEAN Enabled,\r | |
92 | OUT EFI_TIME *Time\r | |
93 | );\r | |
94 | \r | |
95 | \r | |
96 | \r | |
97 | /**\r | |
98 | This is the declaration of an EFI image entry point. This can be the entry point to an application\r | |
99 | written to this specification, an EFI boot service driver, or an EFI runtime driver.\r | |
100 | \r | |
101 | @param ImageHandle Handle that identifies the loaded image.\r | |
102 | @param SystemTable System Table for this image.\r | |
103 | \r | |
104 | @retval EFI_SUCCESS The operation completed successfully.\r | |
105 | \r | |
106 | **/\r | |
107 | EFI_STATUS\r | |
108 | EFIAPI\r | |
109 | LibRtcInitialize (\r | |
110 | IN EFI_HANDLE ImageHandle,\r | |
111 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
112 | );\r | |
113 | \r | |
114 | \r | |
115 | /**\r | |
116 | Fixup internal data so that EFI can be call in virtual mode.\r | |
117 | Call the passed in Child Notify event and convert any pointers in\r | |
118 | lib to virtual mode.\r | |
119 | \r | |
120 | @param[in] Event The Event that is being processed\r | |
121 | @param[in] Context Event Context\r | |
122 | **/\r | |
123 | VOID\r | |
124 | EFIAPI\r | |
125 | LibRtcVirtualNotifyEvent (\r | |
126 | IN EFI_EVENT Event,\r | |
127 | IN VOID *Context\r | |
128 | );\r | |
129 | \r | |
130 | \r | |
131 | #endif\r | |
132 | \r |