]>
Commit | Line | Data |
---|---|---|
fb3df220 | 1 | /** @file\r |
50a64e5b | 2 | Provides library functions for each of the UEFI Runtime Services.\r |
3 | Only available to DXE and UEFI module types.\r | |
fb3df220 | 4 | \r |
22d9510d | 5 | Copyright (c) 2006 - 2008, Intel Corporation<BR>\r |
50a64e5b | 6 | All rights reserved. This program and the accompanying materials\r |
7 | are licensed and made available under the terms and conditions of the BSD License\r | |
8 | which accompanies this distribution. The full text of the license may be found at\r | |
9 | http://opensource.org/licenses/bsd-license.php\r | |
fb3df220 | 10 | \r |
50a64e5b | 11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
fb3df220 | 13 | **/\r |
14 | \r | |
15 | #ifndef __UEFI_RUNTIME_LIB__\r | |
16 | #define __UEFI_RUNTIME_LIB__\r | |
17 | \r | |
18 | \r | |
19 | extern const EFI_EVENT_NOTIFY _gDriverExitBootServicesEvent[];\r | |
20 | \r | |
21 | extern const EFI_EVENT_NOTIFY _gDriverSetVirtualAddressMapEvent[];\r | |
22 | \r | |
23 | /**\r | |
22d9510d | 24 | This function allows the caller to determine if UEFI ExitBootServices() has been called.\r |
fb3df220 | 25 | \r |
22d9510d | 26 | This function returns TRUE after all the EVT_SIGNAL_EXIT_BOOT_SERVICES functions have\r |
27 | executed as a result of the OS calling ExitBootServices(). Prior to this time FALSE\r | |
28 | is returned. This function is used by runtime code to decide it is legal to access\r | |
29 | services that go away after ExitBootServices().\r | |
fb3df220 | 30 | \r |
22d9510d | 31 | @retval TRUE The system has finished executing the EVT_SIGNAL_EXIT_BOOT_SERVICES event.\r |
32 | @retval FALSE The system has not finished executing the EVT_SIGNAL_EXIT_BOOT_SERVICES event.\r | |
fb3df220 | 33 | \r |
34 | **/\r | |
35 | BOOLEAN\r | |
36 | EFIAPI\r | |
37 | EfiAtRuntime (\r | |
3b89de63 | 38 | VOID\r |
fb3df220 | 39 | );\r |
40 | \r | |
41 | /**\r | |
22d9510d | 42 | This function allows the caller to determine if UEFI SetVirtualAddressMap() has been called. \r |
fb3df220 | 43 | \r |
22d9510d | 44 | This function returns TRUE after all the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE functions have\r |
45 | executed as a result of the OS calling SetVirtualAddressMap(). Prior to this time FALSE\r | |
46 | is returned. This function is used by runtime code to decide it is legal to access services\r | |
47 | that go away after SetVirtualAddressMap().\r | |
48 | \r | |
49 | @retval TRUE The system has finished executing the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.\r | |
50 | @retval FALSE The system has not finished executing the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.\r | |
fb3df220 | 51 | \r |
52 | **/\r | |
53 | BOOLEAN\r | |
54 | EFIAPI\r | |
55 | EfiGoneVirtual (\r | |
3b89de63 | 56 | VOID\r |
fb3df220 | 57 | );\r |
58 | \r | |
59 | /**\r | |
22d9510d | 60 | This service is a wrapper for the UEFI Runtime Service GetTime().\r |
61 | \r | |
62 | The GetTime() function returns a time that was valid sometime during the call to the function.\r | |
63 | While the returned EFI_TIME structure contains TimeZone and Daylight savings time information,\r | |
64 | the actual clock does not maintain these values. The current time zone and daylight saving time\r | |
65 | information returned by GetTime() are the values that were last set via SetTime().\r | |
66 | The GetTime() function should take approximately the same amount of time to read the time each\r | |
67 | time it is called. All reported device capabilities are to be rounded up.\r | |
68 | During runtime, if a PC-AT CMOS device is present in the platform the caller must synchronize\r | |
69 | access to the device before calling GetTime().\r | |
fb3df220 | 70 | \r |
71 | @param Time A pointer to storage to receive a snapshot of the current time.\r | |
72 | @param Capabilities An optional pointer to a buffer to receive the real time clock device's\r | |
73 | capabilities.\r | |
3b89de63 | 74 | \r |
22d9510d | 75 | @retval EFI_SUCCESS The operation completed successfully.\r |
76 | @retval EFI_INVALID_PARAMETER Time is NULL.\r | |
77 | @retval EFI_DEVICE_ERROR The time could not be retrieved due to a hardware error.\r | |
fb3df220 | 78 | \r |
79 | **/\r | |
80 | EFI_STATUS\r | |
81 | EFIAPI\r | |
82 | EfiGetTime (\r | |
83 | OUT EFI_TIME *Time,\r | |
22d9510d | 84 | OUT EFI_TIME_CAPABILITIES *Capabilities OPTIONAL\r |
fb3df220 | 85 | );\r |
86 | \r | |
87 | /**\r | |
22d9510d | 88 | This service is a wrapper for the UEFI Runtime Service SetTime().\r |
89 | \r | |
90 | The SetTime() function sets the real time clock device to the supplied time, and records the\r | |
91 | current time zone and daylight savings time information. The SetTime() function is not allowed\r | |
92 | to loop based on the current time. For example, if the device does not support a hardware reset\r | |
93 | for the sub-resolution time, the code is not to implement the feature by waiting for the time to\r | |
94 | wrap.\r | |
95 | During runtime, if a PC-AT CMOS device is present in the platform the caller must synchronize\r | |
96 | access to the device before calling SetTime().\r | |
97 | \r | |
98 | @param Time A pointer to the current time. Type EFI_TIME is defined in the GetTime()\r | |
99 | function description. Full error checking is performed on the different\r | |
100 | fields of the EFI_TIME structure (refer to the EFI_TIME definition in the\r | |
101 | GetTime() function description for full details), and EFI_INVALID_PARAMETER\r | |
102 | is returned if any field is out of range.\r | |
103 | \r | |
104 | @retval EFI_SUCCESS The operation completed successfully.\r | |
105 | @retval EFI_INVALID_PARAMETER A time field is out of range.\r | |
106 | @retval EFI_DEVICE_ERROR The time could not be set due to a hardware error.\r | |
fb3df220 | 107 | \r |
108 | **/\r | |
109 | EFI_STATUS\r | |
110 | EFIAPI\r | |
111 | EfiSetTime (\r | |
112 | IN EFI_TIME *Time\r | |
113 | );\r | |
114 | \r | |
115 | /**\r | |
cf8ae2f6 | 116 | This service is a wrapper for the UEFI Runtime Service GetWakeupTime().\r |
fb3df220 | 117 | \r |
22d9510d | 118 | The alarm clock time may be rounded from the set alarm clock time to be within the resolution\r |
119 | of the alarm clock device. The resolution of the alarm clock device is defined to be one second.\r | |
120 | During runtime, if a PC-AT CMOS device is present in the platform the caller must synchronize\r | |
121 | access to the device before calling GetWakeupTime().\r | |
3b89de63 | 122 | \r |
22d9510d | 123 | @param Enabled Indicates if the alarm is currently enabled or disabled.\r |
124 | @param Pending Indicates if the alarm signal is pending and requires acknowledgement.\r | |
125 | @param Time The current alarm setting. Type EFI_TIME is defined in the GetTime()\r | |
126 | function description.\r | |
127 | \r | |
128 | @retval EFI_SUCCESS The alarm settings were returned.\r | |
129 | @retval EFI_INVALID_PARAMETER Enabled is NULL.\r | |
130 | @retval EFI_INVALID_PARAMETER Pending is NULL.\r | |
131 | @retval EFI_INVALID_PARAMETER Time is NULL.\r | |
132 | @retval EFI_DEVICE_ERROR The wakeup time could not be retrieved due to a hardware error.\r | |
133 | @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.\r | |
fb3df220 | 134 | \r |
135 | **/\r | |
136 | EFI_STATUS\r | |
137 | EFIAPI\r | |
138 | EfiGetWakeupTime (\r | |
139 | OUT BOOLEAN *Enabled,\r | |
140 | OUT BOOLEAN *Pending,\r | |
141 | OUT EFI_TIME *Time\r | |
142 | );\r | |
143 | \r | |
144 | /**\r | |
cf8ae2f6 | 145 | This service is a wrapper for the UEFI Runtime Service SetWakeupTime()\r |
146 | \r | |
147 | Setting a system wakeup alarm causes the system to wake up or power on at the set time.\r | |
148 | When the alarm fires, the alarm signal is latched until it is acknowledged by calling SetWakeupTime()\r | |
149 | to disable the alarm. If the alarm fires before the system is put into a sleeping or off state,\r | |
150 | since the alarm signal is latched the system will immediately wake up. If the alarm fires while\r | |
151 | the system is off and there is insufficient power to power on the system, the system is powered\r | |
152 | on when power is restored.\r | |
fb3df220 | 153 | \r |
22d9510d | 154 | @param Enable Enable or disable the wakeup alarm.\r |
155 | @param Time If Enable is TRUE, the time to set the wakeup alarm for. Type EFI_TIME\r | |
156 | is defined in the GetTime() function description. If Enable is FALSE,\r | |
157 | then this parameter is optional, and may be NULL.\r | |
3b89de63 | 158 | \r |
22d9510d | 159 | @retval EFI_SUCCESS If Enable is TRUE, then the wakeup alarm was enabled.\r |
160 | If Enable is FALSE, then the wakeup alarm was disabled.\r | |
161 | @retval EFI_INVALID_PARAMETER A time field is out of range.\r | |
162 | @retval EFI_DEVICE_ERROR The wakeup time could not be set due to a hardware error.\r | |
163 | @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.\r | |
fb3df220 | 164 | \r |
165 | **/\r | |
166 | EFI_STATUS\r | |
167 | EFIAPI\r | |
168 | EfiSetWakeupTime (\r | |
169 | IN BOOLEAN Enable,\r | |
22d9510d | 170 | IN EFI_TIME *Time OPTIONAL\r |
fb3df220 | 171 | );\r |
172 | \r | |
173 | /**\r | |
cf8ae2f6 | 174 | This service is a wrapper for the UEFI Runtime Service GetVariable().\r |
fb3df220 | 175 | \r |
cf8ae2f6 | 176 | Each vendor may create and manage its own variables without the risk of name conflicts by\r |
177 | using a unique VendorGuid. When a variable is set its Attributes are supplied to indicate\r | |
178 | how the data variable should be stored and maintained by the system. The attributes affect\r | |
179 | when the variable may be accessed and volatility of the data. Any attempts to access a variable\r | |
180 | that does not have the attribute set for runtime access will yield the EFI_NOT_FOUND error.\r | |
181 | If the Data buffer is too small to hold the contents of the variable, the error EFI_BUFFER_TOO_SMALL\r | |
182 | is returned and DataSize is set to the required buffer size to obtain the data.\r | |
183 | \r | |
184 | @param VariableName the name of the vendor's variable, it's a Null-Terminated Unicode String\r | |
fb3df220 | 185 | @param VendorGuid Unify identifier for vendor.\r |
3b89de63 | 186 | @param Attributes Point to memory location to return the attributes of variable. If the point\r |
fb3df220 | 187 | is NULL, the parameter would be ignored.\r |
188 | @param DataSize As input, point to the maxinum size of return Data-Buffer.\r | |
189 | As output, point to the actual size of the returned Data-Buffer.\r | |
190 | @param Data Point to return Data-Buffer.\r | |
3b89de63 | 191 | \r |
22d9510d | 192 | @retval EFI_SUCCESS The function completed successfully.\r |
193 | @retval EFI_NOT_FOUND The variable was not found.\r | |
194 | @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result. DataSize has\r | |
195 | been updated with the size needed to complete the request.\r | |
196 | @retval EFI_INVALID_PARAMETER VariableName is NULL.\r | |
197 | @retval EFI_INVALID_PARAMETER VendorGuid is NULL.\r | |
198 | @retval EFI_INVALID_PARAMETER DataSize is NULL.\r | |
199 | @retval EFI_INVALID_PARAMETER The DataSize is not too small and Data is NULL.\r | |
200 | @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.\r | |
201 | @retval EFI_SECURITY_VIOLATION The variable could not be retrieved due to an authentication failure.\r | |
fb3df220 | 202 | **/\r |
203 | EFI_STATUS\r | |
204 | EFIAPI\r | |
205 | EfiGetVariable (\r | |
206 | IN CHAR16 *VariableName,\r | |
207 | IN EFI_GUID *VendorGuid,\r | |
201c7668 | 208 | OUT UINT32 *Attributes OPTIONAL,\r |
fb3df220 | 209 | IN OUT UINTN *DataSize,\r |
210 | OUT VOID *Data\r | |
bf231ea6 | 211 | );\r |
fb3df220 | 212 | \r |
213 | /**\r | |
cf8ae2f6 | 214 | This service is a wrapper for the UEFI Runtime Service GetNextVariableName().\r |
215 | \r | |
216 | GetNextVariableName() is called multiple times to retrieve the VariableName and VendorGuid of\r | |
217 | all variables currently available in the system. On each call to GetNextVariableName() the\r | |
218 | previous results are passed into the interface, and on output the interface returns the next\r | |
219 | variable name data. When the entire variable list has been returned, the error EFI_NOT_FOUND\r | |
220 | is returned.\r | |
fb3df220 | 221 | \r |
222 | @param VariableNameSize As input, point to maxinum size of variable name.\r | |
223 | As output, point to actual size of varaible name.\r | |
3b89de63 | 224 | @param VariableName As input, supplies the last VariableName that was returned by\r |
fb3df220 | 225 | GetNextVariableName().\r |
3b89de63 | 226 | As output, returns the name of variable. The name\r |
fb3df220 | 227 | string is Null-Terminated Unicode string.\r |
3b89de63 | 228 | @param VendorGuid As input, supplies the last VendorGuid that was returned by\r |
fb3df220 | 229 | GetNextVriableName().\r |
230 | As output, returns the VendorGuid of the current variable.\r | |
3b89de63 | 231 | \r |
22d9510d | 232 | @retval EFI_SUCCESS The function completed successfully.\r |
233 | @retval EFI_NOT_FOUND The next variable was not found.\r | |
234 | @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.\r | |
235 | VariableNameSize has been updated with the size needed\r | |
236 | to complete the request.\r | |
237 | @retval EFI_INVALID_PARAMETER VariableNameSize is NULL.\r | |
238 | @retval EFI_INVALID_PARAMETER VariableName is NULL.\r | |
239 | @retval EFI_INVALID_PARAMETER VendorGuid is NULL.\r | |
240 | @retval EFI_DEVICE_ERROR The variable name could not be retrieved due to a hardware error.\r | |
fb3df220 | 241 | \r |
242 | **/\r | |
243 | EFI_STATUS\r | |
244 | EFIAPI\r | |
245 | EfiGetNextVariableName (\r | |
246 | IN OUT UINTN *VariableNameSize,\r | |
247 | IN OUT CHAR16 *VariableName,\r | |
248 | IN OUT EFI_GUID *VendorGuid\r | |
249 | );\r | |
250 | \r | |
251 | /**\r | |
cf8ae2f6 | 252 | This service is a wrapper for the UEFI Runtime Service GetNextVariableName()\r |
253 | \r | |
254 | Variables are stored by the firmware and may maintain their values across power cycles. Each vendor\r | |
255 | may create and manage its own variables without the risk of name conflicts by using a unique VendorGuid.\r | |
fb3df220 | 256 | \r |
3b89de63 | 257 | @param VariableName the name of the vendor's variable, it's a\r |
fb3df220 | 258 | Null-Terminated Unicode String\r |
259 | @param VendorGuid Unify identifier for vendor.\r | |
3b89de63 | 260 | @param Attributes Point to memory location to return the attributes of variable. If the point\r |
fb3df220 | 261 | is NULL, the parameter would be ignored.\r |
262 | @param DataSize The size in bytes of Data-Buffer.\r | |
263 | @param Data Point to the content of the variable.\r | |
264 | \r | |
22d9510d | 265 | @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as\r |
266 | defined by the Attributes.\r | |
267 | @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied, or the\r | |
268 | DataSize exceeds the maximum allowed.\r | |
269 | @retval EFI_INVALID_PARAMETER VariableName is an empty Unicode string.\r | |
270 | @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.\r | |
271 | @retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure.\r | |
272 | @retval EFI_WRITE_PROTECTED The variable in question is read-only.\r | |
273 | @retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.\r | |
274 | @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS\r | |
275 | set but the AuthInfo does NOT pass the validation check carried\r | |
276 | out by the firmware.\r | |
277 | @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.\r | |
fb3df220 | 278 | \r |
279 | **/\r | |
280 | EFI_STATUS\r | |
281 | EFIAPI\r | |
282 | EfiSetVariable (\r | |
283 | IN CHAR16 *VariableName,\r | |
284 | IN EFI_GUID *VendorGuid,\r | |
285 | IN UINT32 Attributes,\r | |
286 | IN UINTN DataSize,\r | |
287 | IN VOID *Data\r | |
288 | );\r | |
289 | \r | |
290 | /**\r | |
cf8ae2f6 | 291 | This service is a wrapper for the UEFI Runtime Service GetNextHighMonotonicCount().\r |
292 | \r | |
293 |