]>
Commit | Line | Data |
---|---|---|
42eedea9 | 1 | /** @file\r |
60c93673 | 2 | UEFI Runtime Library implementation for non IPF processor types.\r |
ebcc8fb7 | 3 | \r |
363bb1b5 | 4 | This library hides the global variable for the EFI Runtime Services so the\r |
5 | caller does not need to deal with the possibility of being called from an\r | |
9095d37b | 6 | OS virtual address space. All pointer values are different for a virtual\r |
363bb1b5 | 7 | mapping than from the normal physical mapping at boot services time.\r |
8 | \r | |
9095d37b | 9 | Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r |
9344f092 | 10 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
ebcc8fb7 | 11 | \r |
12 | **/\r | |
13 | \r | |
363bb1b5 | 14 | #include <Uefi.h>\r |
15 | #include <Library/UefiRuntimeLib.h>\r | |
16 | #include <Library/DebugLib.h>\r | |
17 | #include <Library/UefiBootServicesTableLib.h>\r | |
18 | #include <Library/UefiRuntimeServicesTableLib.h>\r | |
19 | #include <Guid/EventGroup.h>\r | |
ebcc8fb7 | 20 | \r |
21 | ///\r | |
22 | /// Driver Lib Module Globals\r | |
23 | ///\r | |
2f88bd3a MK |
24 | EFI_EVENT mEfiVirtualNotifyEvent;\r |
25 | EFI_EVENT mEfiExitBootServicesEvent;\r | |
26 | BOOLEAN mEfiGoneVirtual = FALSE;\r | |
27 | BOOLEAN mEfiAtRuntime = FALSE;\r | |
28 | EFI_RUNTIME_SERVICES *mInternalRT;\r | |
ebcc8fb7 | 29 | \r |
30 | /**\r | |
42eedea9 | 31 | Set AtRuntime flag as TRUE after ExitBootServices.\r |
ebcc8fb7 | 32 | \r |
58380e9c | 33 | @param[in] Event The Event that is being processed.\r |
34 | @param[in] Context The Event Context.\r | |
363bb1b5 | 35 | \r |
ebcc8fb7 | 36 | **/\r |
37 | VOID\r | |
38 | EFIAPI\r | |
21998b67 | 39 | RuntimeLibExitBootServicesEvent (\r |
2f88bd3a MK |
40 | IN EFI_EVENT Event,\r |
41 | IN VOID *Context\r | |
ebcc8fb7 | 42 | )\r |
43 | {\r | |
ebcc8fb7 | 44 | mEfiAtRuntime = TRUE;\r |
45 | }\r | |
46 | \r | |
47 | /**\r | |
48 | Fixup internal data so that EFI can be call in virtual mode.\r | |
49 | Call the passed in Child Notify event and convert any pointers in\r | |
50 | lib to virtual mode.\r | |
51 | \r | |
58380e9c | 52 | @param[in] Event The Event that is being processed.\r |
53 | @param[in] Context The Event Context.\r | |
ebcc8fb7 | 54 | **/\r |
ebcc8fb7 | 55 | VOID\r |
56 | EFIAPI\r | |
57 | RuntimeLibVirtualNotifyEvent (\r | |
2f88bd3a MK |
58 | IN EFI_EVENT Event,\r |
59 | IN VOID *Context\r | |
ebcc8fb7 | 60 | )\r |
61 | {\r | |
ebcc8fb7 | 62 | //\r |
63 | // Update global for Runtime Services Table and IO\r | |
64 | //\r | |
2f88bd3a | 65 | EfiConvertPointer (0, (VOID **)&mInternalRT);\r |
ebcc8fb7 | 66 | \r |
67 | mEfiGoneVirtual = TRUE;\r | |
68 | }\r | |
69 | \r | |
70 | /**\r | |
a9b896f4 | 71 | Initialize runtime Driver Lib if it has not yet been initialized.\r |
60c93673 LG |
72 | It will ASSERT() if gRT is NULL or gBS is NULL.\r |
73 | It will ASSERT() if that operation fails.\r | |
ebcc8fb7 | 74 | \r |
75 | @param[in] ImageHandle The firmware allocated handle for the EFI image.\r | |
76 | @param[in] SystemTable A pointer to the EFI System Table.\r | |
77 | \r | |
78 | @return EFI_STATUS always returns EFI_SUCCESS except EFI_ALREADY_STARTED if already started.\r | |
79 | **/\r | |
80 | EFI_STATUS\r | |
81 | EFIAPI\r | |
82 | RuntimeDriverLibConstruct (\r | |
2f88bd3a MK |
83 | IN EFI_HANDLE ImageHandle,\r |
84 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
ebcc8fb7 | 85 | )\r |
86 | {\r | |
87 | EFI_STATUS Status;\r | |
88 | \r | |
60c93673 LG |
89 | ASSERT (gRT != NULL);\r |
90 | ASSERT (gBS != NULL);\r | |
91 | \r | |
363bb1b5 | 92 | mInternalRT = gRT;\r |
ebcc8fb7 | 93 | //\r |
94 | // Register SetVirtualAddressMap () notify function\r | |
95 | //\r | |
df851da3 VC |
96 | Status = gBS->CreateEvent (\r |
97 | EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE,\r | |
ebcc8fb7 | 98 | TPL_NOTIFY,\r |
99 | RuntimeLibVirtualNotifyEvent,\r | |
100 | NULL,\r | |
101 | &mEfiVirtualNotifyEvent\r | |
102 | );\r | |
103 | \r | |
104 | ASSERT_EFI_ERROR (Status);\r | |
105 | \r | |
df851da3 VC |
106 | Status = gBS->CreateEvent (\r |
107 | EVT_SIGNAL_EXIT_BOOT_SERVICES,\r | |
21998b67 | 108 | TPL_NOTIFY,\r |
109 | RuntimeLibExitBootServicesEvent,\r | |
110 | NULL,\r | |
111 | &mEfiExitBootServicesEvent\r | |
112 | );\r | |
113 | \r | |
114 | ASSERT_EFI_ERROR (Status);\r | |
115 | \r | |
ebcc8fb7 | 116 | return Status;\r |
117 | }\r | |
118 | \r | |
119 | /**\r | |
9095d37b | 120 | If a runtime driver exits with an error, it must call this routine\r |
60c93673 LG |
121 | to free the allocated resource before the exiting.\r |
122 | It will ASSERT() if gBS is NULL.\r | |
123 | It will ASSERT() if that operation fails.\r | |
ebcc8fb7 | 124 | \r |
42eedea9 | 125 | @param[in] ImageHandle The firmware allocated handle for the EFI image.\r |
126 | @param[in] SystemTable A pointer to the EFI System Table.\r | |
127 | \r | |
58380e9c | 128 | @retval EFI_SUCCESS The Runtime Driver Lib shutdown successfully.\r |
129 | @retval EFI_UNSUPPORTED Runtime Driver lib was not initialized.\r | |
ebcc8fb7 | 130 | **/\r |
131 | EFI_STATUS\r | |
132 | EFIAPI\r | |
133 | RuntimeDriverLibDeconstruct (\r | |
134 | IN EFI_HANDLE ImageHandle,\r | |
135 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
136 | )\r | |
137 | {\r | |
138 | EFI_STATUS Status;\r | |
139 | \r | |
140 | //\r | |
141 | // Close SetVirtualAddressMap () notify function\r | |
142 | //\r | |
143 | ASSERT (gBS != NULL);\r | |
144 | Status = gBS->CloseEvent (mEfiVirtualNotifyEvent);\r | |
145 | ASSERT_EFI_ERROR (Status);\r | |
146 | \r | |
21998b67 | 147 | Status = gBS->CloseEvent (mEfiExitBootServicesEvent);\r |
148 | ASSERT_EFI_ERROR (Status);\r | |
149 | \r | |
ebcc8fb7 | 150 | return Status;\r |
151 | }\r | |
152 | \r | |
153 | /**\r | |
1d37ab9f | 154 | This function allows the caller to determine if UEFI ExitBootServices() has been called.\r |
155 | \r | |
156 | This function returns TRUE after all the EVT_SIGNAL_EXIT_BOOT_SERVICES functions have\r | |
157 | executed as a result of the OS calling ExitBootServices(). Prior to this time FALSE\r | |
158 | is returned. This function is used by runtime code to decide it is legal to access\r | |
159 | services that go away after ExitBootServices().\r | |
160 | \r | |
161 | @retval TRUE The system has finished executing the EVT_SIGNAL_EXIT_BOOT_SERVICES event.\r | |
162 | @retval FALSE The system has not finished executing the EVT_SIGNAL_EXIT_BOOT_SERVICES event.\r | |
ebcc8fb7 | 163 | \r |
ebcc8fb7 | 164 | **/\r |
165 | BOOLEAN\r | |
166 | EFIAPI\r | |
167 | EfiAtRuntime (\r | |
168 | VOID\r | |
169 | )\r | |
170 | {\r | |
171 | return mEfiAtRuntime;\r | |
172 | }\r | |
173 | \r | |
174 | /**\r | |
9095d37b | 175 | This function allows the caller to determine if UEFI SetVirtualAddressMap() has been called.\r |
1d37ab9f | 176 | \r |
177 | This function returns TRUE after all the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE functions have\r | |
178 | executed as a result of the OS calling SetVirtualAddressMap(). Prior to this time FALSE\r | |
179 | is returned. This function is used by runtime code to decide it is legal to access services\r | |
180 | that go away after SetVirtualAddressMap().\r | |
181 | \r | |
182 | @retval TRUE The system has finished executing the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.\r | |
183 | @retval FALSE The system has not finished executing the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.\r | |
ebcc8fb7 | 184 | \r |
ebcc8fb7 | 185 | **/\r |
186 | BOOLEAN\r | |
187 | EFIAPI\r | |
188 | EfiGoneVirtual (\r | |
189 | VOID\r | |
190 | )\r | |
191 | {\r | |
192 | return mEfiGoneVirtual;\r | |
193 | }\r | |
194 | \r | |
363bb1b5 | 195 | /**\r |
196 | This service is a wrapper for the UEFI Runtime Service ResetSystem().\r | |
197 | \r | |
198 | The ResetSystem()function resets the entire platform, including all processors and devices,and reboots the system.\r | |
199 | Calling this interface with ResetType of EfiResetCold causes a system-wide reset. This sets all circuitry within\r | |
200 | the system to its initial state. This type of reset is asynchronous to system operation and operates without regard\r | |
201 | to cycle boundaries. EfiResetCold is tantamount to a system power cycle.\r | |
202 | Calling this interface with ResetType of EfiResetWarm causes a system-wide initialization. The processors are set to\r | |
203 | their initial state, and pending cycles are not corrupted. If the system does not support this reset type, then an\r | |
204 | EfiResetCold must be performed.\r | |
205 | Calling this interface with ResetType of EfiResetShutdown causes the system to enter a power state equivalent to the\r | |
206 | ACPI G2/S5 or G3 states. If the system does not support this reset type, then when the system is rebooted, it should\r | |
207 | exhibit the EfiResetCold attributes.\r | |
208 | The platform may optionally log the parameters from any non-normal reset that occurs.\r | |
209 | The ResetSystem() function does not return.\r | |
210 | \r | |
211 | @param ResetType The type of reset to perform.\r | |
212 | @param ResetStatus The status code for the reset. If the system reset is part of a normal operation, the status code\r | |
213 | would be EFI_SUCCESS. If the system reset is due to some type of failure the most appropriate EFI\r | |
214 | Status code would be used.\r | |
215 | @param DataSizeThe size, in bytes, of ResetData.\r | |
216 | @param ResetData For a ResetType of EfiResetCold, EfiResetWarm, or EfiResetShutdown the data buffer starts with a\r | |
217 | Null-terminated Unicode string, optionally followed by additional binary data. The string is a\r | |
218 | description that the caller may use to further indicate the reason for the system reset. ResetData\r | |
219 | is only valid if ResetStatus is something other then EFI_SUCCESS. This pointer must be a physical\r | |
220 | address. For a ResetType of EfiRestUpdate the data buffer also starts with a Null-terminated string\r | |
221 | that is followed by a physical VOID * to an EFI_CAPSULE_HEADER.\r | |
222 | \r | |
223 | **/\r | |
224 | VOID\r | |
225 | EFIAPI\r | |
226 | EfiResetSystem (\r | |
2f88bd3a MK |
227 | IN EFI_RESET_TYPE ResetType,\r |
228 | IN EFI_STATUS ResetStatus,\r | |
229 | IN UINTN DataSize,\r | |
230 | IN VOID *ResetData OPTIONAL\r | |
363bb1b5 | 231 | )\r |
232 | {\r | |
233 | mInternalRT->ResetSystem (ResetType, ResetStatus, DataSize, ResetData);\r | |
234 | }\r | |
235 | \r | |
363bb1b5 | 236 | /**\r |
237 | This service is a wrapper for the UEFI Runtime Service GetTime().\r | |
238 | \r | |
239 | The GetTime() function returns a time that was valid sometime during the call to the function.\r | |
240 | While the returned EFI_TIME structure contains TimeZone and Daylight savings time information,\r | |
241 | the actual clock does not maintain these values. The current time zone and daylight saving time\r | |
242 | information returned by GetTime() are the values that were last set via SetTime().\r | |
243 | The GetTime() function should take approximately the same amount of time to read the time each\r | |
244 | time it is called. All reported device capabilities are to be rounded up.\r | |
245 | During runtime, if a PC-AT CMOS device is present in the platform the caller must synchronize\r | |
246 | access to the device before calling GetTime().\r | |
247 | \r | |
248 | @param Time A pointer to storage to receive a snapshot of the current time.\r | |
249 | @param Capabilities An optional pointer to a buffer to receive the real time clock device's\r | |
250 | capabilities.\r | |
251 | \r | |
252 | @retval EFI_SUCCESS The operation completed successfully.\r | |
253 | @retval EFI_INVALID_PARAMETER Time is NULL.\r | |
254 | @retval EFI_DEVICE_ERROR The time could not be retrieved due to a hardware error.\r | |
255 | \r | |
256 | **/\r | |
257 | EFI_STATUS\r | |
258 | EFIAPI\r | |
259 | EfiGetTime (\r | |
2f88bd3a MK |
260 | OUT EFI_TIME *Time,\r |
261 | OUT EFI_TIME_CAPABILITIES *Capabilities OPTIONAL\r | |
363bb1b5 | 262 | )\r |
263 | {\r | |
264 | return mInternalRT->GetTime (Time, Capabilities);\r | |
265 | }\r | |
266 | \r | |
363bb1b5 | 267 | /**\r |
268 | This service is a wrapper for the UEFI Runtime Service SetTime().\r | |
269 | \r | |
270 | The SetTime() function sets the real time clock device to the supplied time, and records the\r | |
271 | current time zone and daylight savings time information. The SetTime() function is not allowed\r | |
272 | to loop based on the current time. For example, if the device does not support a hardware reset\r | |
273 | for the sub-resolution time, the code is not to implement the feature by waiting for the time to\r | |
274 | wrap.\r | |
275 | During runtime, if a PC-AT CMOS device is present in the platform the caller must synchronize\r | |
276 | access to the device before calling SetTime().\r | |
277 | \r | |
278 | @param Time A pointer to the current time. Type EFI_TIME is defined in the GetTime()\r | |
279 | function description. Full error checking is performed on the different\r | |
280 | fields of the EFI_TIME structure (refer to the EFI_TIME definition in the\r | |
281 | GetTime() function description for full details), and EFI_INVALID_PARAMETER\r | |
282 | is returned if any field is out of range.\r | |
283 | \r | |
284 | @retval EFI_SUCCESS The operation completed successfully.\r | |
285 | @retval EFI_INVALID_PARAMETER A time field is out of range.\r | |
286 | @retval EFI_DEVICE_ERROR The time could not be set due to a hardware error.\r | |
287 | \r | |
288 | **/\r | |
289 | EFI_STATUS\r | |
290 | EFIAPI\r | |
291 | EfiSetTime (\r | |
2f88bd3a | 292 | IN EFI_TIME *Time\r |
363bb1b5 | 293 | )\r |
294 | {\r | |
295 | return mInternalRT->SetTime (Time);\r | |
296 | }\r | |
297 | \r | |
363bb1b5 | 298 | /**\r |
299 | This service is a wrapper for the UEFI Runtime Service GetWakeupTime().\r | |
300 | \r | |
301 | The alarm clock time may be rounded from the set alarm clock time to be within the resolution\r | |
302 | of the alarm clock device. The resolution of the alarm clock device is defined to be one second.\r | |
303 | During runtime, if a PC-AT CMOS device is present in the platform the caller must synchronize\r | |
304 | access to the device before calling GetWakeupTime().\r | |
305 | \r | |
306 | @param Enabled Indicates if the alarm is currently enabled or disabled.\r | |
307 | @param Pending Indicates if the alarm signal is pending and requires acknowledgement.\r | |
308 | @param Time The current alarm setting. Type EFI_TIME is defined in the GetTime()\r | |
309 | function description.\r | |
310 | \r | |
58380e9c | 311 | @retval EFI_SUCCESS The alarm settings were returned.\r |
363bb1b5 | 312 | @retval EFI_INVALID_PARAMETER Enabled is NULL.\r |
313 | @retval EFI_INVALID_PARAMETER Pending is NULL.\r | |
314 | @retval EFI_INVALID_PARAMETER Time is NULL.\r | |
315 | @retval EFI_DEVICE_ERROR The wakeup time could not be retrieved due to a hardware error.\r | |
316 | @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.\r | |
317 | \r | |
318 | **/\r | |
319 | EFI_STATUS\r | |
320 | EFIAPI\r | |
321 | EfiGetWakeupTime (\r | |
2f88bd3a MK |
322 | OUT BOOLEAN *Enabled,\r |
323 | OUT BOOLEAN *Pending,\r | |
324 | OUT EFI_TIME *Time\r | |
363bb1b5 | 325 | )\r |
326 | {\r | |
327 | return mInternalRT->GetWakeupTime (Enabled, Pending, Time);\r | |
328 | }\r | |
329 | \r | |
363bb1b5 | 330 | /**\r |
331 | This service is a wrapper for the UEFI Runtime Service SetWakeupTime()\r | |
332 | \r | |
333 | Setting a system wakeup alarm causes the system to wake up or power on at the set time.\r | |
334 | When the alarm fires, the alarm signal is latched until it is acknowledged by calling SetWakeupTime()\r | |
335 | to disable the alarm. If the alarm fires before the system is put into a sleeping or off state,\r | |
336 | since the alarm signal is latched the system will immediately wake up. If the alarm fires while\r | |
337 | the system is off and there is insufficient power to power on the system, the system is powered\r | |
338 | on when power is restored.\r | |
339 | \r | |
340 | @param Enable Enable or disable the wakeup alarm.\r | |
341 | @param Time If Enable is TRUE, the time to set the wakeup alarm for. Type EFI_TIME\r | |
342 | is defined in the GetTime() function description. If Enable is FALSE,\r | |
343 | then this parameter is optional, and may be NULL.\r | |
344 | \r | |
345 | @retval EFI_SUCCESS If Enable is TRUE, then the wakeup alarm was enabled.\r | |
346 | If Enable is FALSE, then the wakeup alarm was disabled.\r | |
347 | @retval EFI_INVALID_PARAMETER A time field is out of range.\r | |
348 | @retval EFI_DEVICE_ERROR The wakeup time could not be set due to a hardware error.\r | |
349 | @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.\r | |
350 | \r | |
351 | **/\r | |
352 | EFI_STATUS\r | |
353 | EFIAPI\r | |
354 | EfiSetWakeupTime (\r | |
2f88bd3a MK |
355 | IN BOOLEAN Enable,\r |
356 | IN EFI_TIME *Time OPTIONAL\r | |
363bb1b5 | 357 | )\r |
358 | {\r | |
359 | return mInternalRT->SetWakeupTime (Enable, Time);\r | |
360 | }\r | |
361 | \r | |
363bb1b5 | 362 | /**\r |
363 | This service is a wrapper for the UEFI Runtime Service GetVariable().\r | |
364 | \r | |
365 | Each vendor may create and manage its own variables without the risk of name conflicts by\r | |
366 | using a unique VendorGuid. When a variable is set its Attributes are supplied to indicate\r | |
367 | how the data variable should be stored and maintained by the system. The attributes affect\r | |
368 | when the variable may be accessed and volatility of the data. Any attempts to access a variable\r | |
369 | that does not have the attribute set for runtime access will yield the EFI_NOT_FOUND error.\r | |
370 | If the Data buffer is too small to hold the contents of the variable, the error EFI_BUFFER_TOO_SMALL\r | |
371 | is returned and DataSize is set to the required buffer size to obtain the data.\r | |
372 | \r | |
373 | @param VariableName the name of the vendor's variable, it's a Null-Terminated Unicode String\r | |
374 | @param VendorGuid Unify identifier for vendor.\r | |
375 | @param Attributes Point to memory location to return the attributes of variable. If the point\r | |
376 | is NULL, the parameter would be ignored.\r | |
377 | @param DataSize As input, point to the maximum size of return Data-Buffer.\r | |
378 | As output, point to the actual size of the returned Data-Buffer.\r | |
379 | @param Data Point to return Data-Buffer.\r | |
380 | \r | |
381 | @retval EFI_SUCCESS The function completed successfully.\r | |
382 | @retval EFI_NOT_FOUND The variable was not found.\r | |
383 | @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result. DataSize has\r | |
384 | been updated with the size needed to complete the request.\r | |
385 | @retval EFI_INVALID_PARAMETER VariableName is NULL.\r | |
386 | @retval EFI_INVALID_PARAMETER VendorGuid is NULL.\r | |
387 | @retval EFI_INVALID_PARAMETER DataSize is NULL.\r | |
388 | @retval EFI_INVALID_PARAMETER The DataSize is not too small and Data is NULL.\r | |
389 | @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.\r | |
390 | @retval EFI_SECURITY_VIOLATION The variable could not be retrieved due to an authentication failure.\r | |
391 | **/\r | |
392 | EFI_STATUS\r | |
393 | EFIAPI\r | |
394 | EfiGetVariable (\r | |
2f88bd3a MK |
395 | IN CHAR16 *VariableName,\r |
396 | IN EFI_GUID *VendorGuid,\r | |
397 | OUT UINT32 *Attributes OPTIONAL,\r | |
398 | IN OUT UINTN *DataSize,\r | |
399 | OUT VOID *Data\r | |
363bb1b5 | 400 | )\r |
401 | {\r | |
402 | return mInternalRT->GetVariable (VariableName, VendorGuid, Attributes, DataSize, Data);\r | |
403 | }\r | |
404 | \r | |
363bb1b5 | 405 | /**\r |
406 | This service is a wrapper for the UEFI Runtime Service GetNextVariableName().\r | |
407 | \r | |
408 | GetNextVariableName() is called multiple times to retrieve the VariableName and VendorGuid of\r | |
409 | all variables currently available in the system. On each call to GetNextVariableName() the\r | |
410 | previous results are passed into the interface, and on output the interface returns the next\r | |
411 | variable name data. When the entire variable list has been returned, the error EFI_NOT_FOUND\r | |
412 | is returned.\r | |
413 | \r | |
414 | @param VariableNameSize As input, point to maximum size of variable name.\r | |
415 | As output, point to actual size of variable name.\r | |
416 | @param VariableName As input, supplies the last VariableName that was returned by\r | |
417 | GetNextVariableName().\r | |
418 | As output, returns the name of variable. The name\r | |
419 | string is Null-Terminated Unicode string.\r | |
420 | @param VendorGuid As input, supplies the last VendorGuid that was returned by\r | |
421 | GetNextVriableName().\r | |
422 | As output, returns the VendorGuid of the current variable.\r | |
423 | \r | |
424 | @retval EFI_SUCCESS The function completed successfully.\r | |
425 | @retval EFI_NOT_FOUND The next variable was not found.\r | |
426 | @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.\r | |
427 | VariableNameSize has been updated with the size needed\r | |
428 | to complete the request.\r | |
429 | @retval EFI_INVALID_PARAMETER VariableNameSize is NULL.\r | |
430 | @retval EFI_INVALID_PARAMETER VariableName is NULL.\r | |
431 | @retval EFI_INVALID_PARAMETER VendorGuid is NULL.\r | |
432 | @retval EFI_DEVICE_ERROR The variable name could not be retrieved due to a hardware error.\r | |
433 | \r | |
434 | **/\r | |
435 | EFI_STATUS\r | |
436 | EFIAPI\r | |
437 | EfiGetNextVariableName (\r | |
2f88bd3a MK |
438 | IN OUT UINTN *VariableNameSize,\r |
439 | IN OUT CHAR16 *VariableName,\r | |
440 | IN OUT EFI_GUID *VendorGuid\r | |
363bb1b5 | 441 | )\r |
442 | {\r | |
443 | return mInternalRT->GetNextVariableName (VariableNameSize, VariableName, VendorGuid);\r | |
444 | }\r | |
445 | \r | |
363bb1b5 | 446 | /**\r |
447 | This service is a wrapper for the UEFI Runtime Service GetNextVariableName()\r | |
448 | \r | |
449 | Variables are stored by the firmware and may maintain their values across power cycles. Each vendor\r | |
450 | may create and manage its own variables without the risk of name conflicts by using a unique VendorGuid.\r | |
451 | \r | |
9095d37b | 452 | @param VariableName The name of the vendor's variable; it's a Null-Terminated\r |
58380e9c | 453 | Unicode String\r |
363bb1b5 | 454 | @param VendorGuid Unify identifier for vendor.\r |
58380e9c | 455 | @param Attributes Points to a memory location to return the attributes of variable. If the point\r |
363bb1b5 | 456 | is NULL, the parameter would be ignored.\r |
457 | @param DataSize The size in bytes of Data-Buffer.\r | |
58380e9c | 458 | @param Data Points to the content of the variable.\r |
363bb1b5 | 459 | \r |
460 | @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as\r | |
461 | defined by the Attributes.\r | |
462 | @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied, or the\r | |
463 | DataSize exceeds the maximum allowed.\r | |
464 | @retval EFI_INVALID_PARAMETER VariableName is an empty Unicode string.\r | |
465 | @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.\r | |
466 | @retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure.\r | |
467 | @retval EFI_WRITE_PROTECTED The variable in question is read-only.\r | |
468 | @retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.\r | |
403170bb | 469 | @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS\r |
363bb1b5 | 470 | set but the AuthInfo does NOT pass the validation check carried\r |
471 | out by the firmware.\r | |
472 | @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.\r | |
473 | \r | |
474 | **/\r | |
475 | EFI_STATUS\r | |
476 | EFIAPI\r | |
477 | EfiSetVariable (\r | |
2f88bd3a MK |
478 | IN CHAR16 *VariableName,\r |
479 | IN EFI_GUID *VendorGuid,\r | |
480 | IN UINT32 Attributes,\r | |
481 | IN UINTN DataSize,\r | |
482 | IN VOID *Data\r | |
363bb1b5 | 483 | )\r |
484 | {\r | |
485 | return mInternalRT->SetVariable (VariableName, VendorGuid, Attributes, DataSize, Data);\r | |
486 | }\r | |
487 | \r | |
363bb1b5 | 488 | /**\r |
489 | This service is a wrapper for the UEFI Runtime Service GetNextHighMonotonicCount().\r | |
490 | \r | |
491 | The platform's monotonic counter is comprised of two 32-bit quantities: the high 32 bits and\r | |
492 | the low 32 bits. During boot service time the low 32-bit value is volatile: it is reset to zero\r | |
493 | on every system reset and is increased by 1 on every call to GetNextMonotonicCount(). The high\r | |
494 | 32-bit value is nonvolatile and is increased by 1 whenever the system resets or whenever the low\r | |
495 | 32-bit count (returned by GetNextMonoticCount()) overflows.\r | |
496 | \r | |
2fc59a00 | 497 | @param HighCount The pointer to returned value.\r |
363bb1b5 | 498 | \r |
499 | @retval EFI_SUCCESS The next high monotonic count was returned.\r | |
500 | @retval EFI_DEVICE_ERROR The device is not functioning properly.\r | |
501 | @retval EFI_INVALID_PARAMETER HighCount is NULL.\r | |
502 | \r | |
503 | **/\r | |
504 | EFI_STATUS\r | |
505 | EFIAPI\r | |
506 | EfiGetNextHighMonotonicCount (\r | |
2f88bd3a | 507 | OUT UINT32 *HighCount\r |
363bb1b5 | 508 | )\r |
509 | {\r | |
510 | return mInternalRT->GetNextHighMonotonicCount (HighCount);\r | |
511 | }\r | |
512 | \r | |
363bb1b5 | 513 | /**\r |
9095d37b | 514 | This service is a wrapper for the UEFI Runtime Service ConvertPointer().\r |
363bb1b5 | 515 | \r |
516 | The ConvertPointer() function is used by an EFI component during the SetVirtualAddressMap() operation.\r | |
517 | ConvertPointer()must be called using physical address pointers during the execution of SetVirtualAddressMap().\r | |
518 | \r | |
519 | @param DebugDisposition Supplies type information for the pointer being converted.\r | |
520 | @param Address The pointer to a pointer that is to be fixed to be the\r | |
521 | value needed for the new virtual address mapping being\r | |
522 | applied.\r | |
523 | \r | |
524 | @retval EFI_SUCCESS The pointer pointed to by Address was modified.\r | |
525 | @retval EFI_NOT_FOUND The pointer pointed to by Address was not found to be part of\r | |
526 | the current memory map. This is normally fatal.\r | |
527 | @retval EFI_INVALID_PARAMETER Address is NULL.\r | |
528 | @retval EFI_INVALID_PARAMETER *Address is NULL and DebugDispositio\r | |
529 | \r | |
530 | **/\r | |
531 | EFI_STATUS\r | |
532 | EFIAPI\r | |
533 | EfiConvertPointer (\r | |
2f88bd3a MK |
534 | IN UINTN DebugDisposition,\r |
535 | IN OUT VOID **Address\r | |
363bb1b5 | 536 | )\r |
537 | {\r | |
538 | return gRT->ConvertPointer (DebugDisposition, Address);\r | |
539 | }\r | |
540 | \r | |
363bb1b5 | 541 | /**\r |
542 | Determines the new virtual address that is to be used on subsequent memory accesses.\r | |
543 | \r | |
544 | For IA32, x64, and EBC, this service is a wrapper for the UEFI Runtime Service\r | |
9095d37b | 545 | ConvertPointer(). See the UEFI Specification for details.\r |
363bb1b5 | 546 | For IPF, this function interprets Address as a pointer to an EFI_PLABEL structure\r |
547 | and both the EntryPoint and GP fields of an EFI_PLABEL are converted from physical\r | |
548 | to virtiual addressing. Since IPF allows the GP to point to an address outside\r | |
549 | a PE/COFF image, the physical to virtual offset for the EntryPoint field is used\r | |
550 | to adjust the GP field. The UEFI Runtime Service ConvertPointer() is used to convert\r | |
551 | EntryPoint and the status code for this conversion is always returned. If the convertion\r | |
552 | of EntryPoint fails, then neither EntryPoint nor GP are modified. See the UEFI\r | |
553 | Specification for details on the UEFI Runtime Service ConvertPointer().\r | |
554 | \r | |
555 | @param DebugDisposition Supplies type information for the pointer being converted.\r | |
556 | @param Address The pointer to a pointer that is to be fixed to be the\r | |
557 | value needed for the new virtual address mapping being\r | |
558 | applied.\r | |
559 | \r | |
560 | @return EFI_STATUS value from EfiConvertPointer().\r | |
561 | \r | |
562 | **/\r | |
563 | EFI_STATUS\r | |
564 | EFIAPI\r | |
565 | EfiConvertFunctionPointer (\r | |
2f88bd3a MK |
566 | IN UINTN DebugDisposition,\r |
567 | IN OUT VOID **Address\r | |
363bb1b5 | 568 | )\r |
569 | {\r | |
570 | return EfiConvertPointer (DebugDisposition, Address);\r | |
571 | }\r | |
572 | \r | |
363bb1b5 | 573 | /**\r |
574 | Convert the standard Lib double linked list to a virtual mapping.\r | |
575 | \r | |
576 | This service uses EfiConvertPointer() to walk a double linked list and convert all the link\r | |
577 | pointers to their virtual mappings. This function is only guaranteed to work during the\r | |
578 | EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event and calling it at other times has undefined results.\r | |
579 | \r | |
580 | @param DebugDisposition Supplies type information for the pointer being converted.\r | |
581 | @param ListHead Head of linked list to convert.\r | |
582 | \r | |
583 | @retval EFI_SUCCESS Success to execute the function.\r | |
584 | @retval !EFI_SUCCESS Failed to e3xecute the function.\r | |
585 | \r | |
586 | **/\r | |
587 | EFI_STATUS\r | |
588 | EFIAPI\r | |
589 | EfiConvertList (\r | |
2f88bd3a MK |
590 | IN UINTN DebugDisposition,\r |
591 | IN OUT LIST_ENTRY *ListHead\r | |
363bb1b5 | 592 | )\r |
593 | {\r | |
594 | LIST_ENTRY *Link;\r | |
595 | LIST_ENTRY *NextLink;\r | |
9095d37b | 596 | \r |
363bb1b5 | 597 | //\r |
598 | // For NULL List, return EFI_SUCCESS\r | |
599 | //\r | |
600 | if (ListHead == NULL) {\r | |
601 | return EFI_SUCCESS;\r | |
602 | }\r | |
603 | \r | |
604 | //\r | |
605 | // Convert all the ForwardLink & BackLink pointers in the list\r | |
606 | //\r | |
607 | Link = ListHead;\r | |
608 | do {\r | |
609 | NextLink = Link->ForwardLink;\r | |
610 | \r | |
611 | EfiConvertPointer (\r | |
612 | Link->ForwardLink == ListHead ? DebugDisposition : 0,\r | |
2f88bd3a | 613 | (VOID **)&Link->ForwardLink\r |
363bb1b5 | 614 | );\r |
615 | \r | |
616 | EfiConvertPointer (\r | |
617 | Link->BackLink == ListHead ? DebugDisposition : 0,\r | |
2f88bd3a | 618 | (VOID **)&Link->BackLink\r |
363bb1b5 | 619 | );\r |
620 | \r | |
621 | Link = NextLink;\r | |
622 | } while (Link != ListHead);\r | |
2f88bd3a | 623 | \r |
363bb1b5 | 624 | return EFI_SUCCESS;\r |
625 | }\r | |
626 | \r | |
363bb1b5 | 627 | /**\r |
628 | This service is a wrapper for the UEFI Runtime Service SetVirtualAddressMap().\r | |
629 | \r | |
630 | The SetVirtualAddressMap() function is used by the OS loader. The function can only be called\r | |
631 | at runtime, and is called by the owner of the system's memory map. I.e., the component which\r | |
632 | called ExitBootServices(). All events of type EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE must be signaled\r | |
633 | before SetVirtualAddressMap() returns.\r | |
634 | \r | |
635 | @param MemoryMapSize The size in bytes of VirtualMap.\r | |
636 | @param DescriptorSize The size in bytes of an entry in the VirtualMap.\r | |
637 | @param DescriptorVersion The version of the structure entries in VirtualMap.\r | |
638 | @param VirtualMap An array of memory descriptors which contain new virtual\r | |
639 | address mapping information for all runtime ranges. Type\r | |
640 | EFI_MEMORY_DESCRIPTOR is defined in the\r | |
641 | GetMemoryMap() function description.\r | |
642 | \r | |
643 | @retval EFI_SUCCESS The virtual address map has been applied.\r | |
644 | @retval EFI_UNSUPPORTED EFI firmware is not at runtime, or the EFI firmware is already in\r | |
645 | virtual address mapped mode.\r | |
646 | @retval EFI_INVALID_PARAMETER DescriptorSize or DescriptorVersion is\r | |
647 | invalid.\r | |
648 | @retval EFI_NO_MAPPING A virtual address was not supplied for a range in the memory\r | |
649 | map that requires a mapping.\r | |
650 | @retval EFI_NOT_FOUND A virtual address was supplied for an address that is not found\r | |
651 | in the memory map.\r | |
652 | **/\r | |
653 | EFI_STATUS\r | |
654 | EFIAPI\r | |
655 | EfiSetVirtualAddressMap (\r | |
2f88bd3a MK |
656 | IN UINTN MemoryMapSize,\r |
657 | IN UINTN DescriptorSize,\r | |
658 | IN UINT32 DescriptorVersion,\r | |
659 | IN CONST EFI_MEMORY_DESCRIPTOR *VirtualMap\r | |
363bb1b5 | 660 | )\r |
661 | {\r | |
662 | return mInternalRT->SetVirtualAddressMap (\r | |
663 | MemoryMapSize,\r | |
664 | DescriptorSize,\r | |
665 | DescriptorVersion,\r | |
2f88bd3a | 666 | (EFI_MEMORY_DESCRIPTOR *)VirtualMap\r |
363bb1b5 | 667 | );\r |
668 | }\r | |
669 | \r | |
363bb1b5 | 670 | /**\r |
671 | This service is a wrapper for the UEFI Runtime Service UpdateCapsule().\r | |
672 | \r | |
673 | Passes capsules to the firmware with both virtual and physical mapping. Depending on the intended\r | |
674 | consumption, the firmware may process the capsule immediately. If the payload should persist across a\r | |
675 | system reset, the reset value returned from EFI_QueryCapsuleCapabilities must be passed into ResetSystem()\r | |
676 | and will cause the capsule to be processed by the firmware as part of the reset process.\r | |
677 | \r | |
678 | @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules\r | |
679 | being passed into update capsule. Each capsules is assumed to\r | |
680 | stored in contiguous virtual memory. The capsules in the\r | |
681 | CapsuleHeaderArray must be the same capsules as the\r | |
682 | ScatterGatherList. The CapsuleHeaderArray must\r | |
683 | have the capsules in the same order as the ScatterGatherList.\r | |
2fc59a00 | 684 | @param CapsuleCount The number of pointers to EFI_CAPSULE_HEADER in\r |
363bb1b5 | 685 | CaspuleHeaderArray.\r |
686 | @param ScatterGatherList Physical pointer to a set of\r | |
687 | EFI_CAPSULE_BLOCK_DESCRIPTOR that describes the\r | |
688 | location in physical memory of a set of capsules. See Related\r | |
689 | Definitions for an explanation of how more than one capsule is\r | |
690 | passed via this interface. The capsules in the\r | |
691 | ScatterGatherList must be in the same order as the\r | |
692 | CapsuleHeaderArray. This parameter is only referenced if\r | |
693 | the capsules are defined to persist across system reset.\r | |
694 | \r | |
695 | @retval EFI_SUCCESS Valid capsule was passed. If CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set,\r | |
696 | the capsule has been successfully processed by the firmware.\r | |
697 | @retval EFI_INVALID_PARAMETER CapsuleSize or HeaderSize is NULL.\r | |
698 | @retval EFI_INVALID_PARAMETER CapsuleCount is 0\r | |
699 | @retval EFI_DEVICE_ERROR The capsule update was started, but failed due to a device error.\r | |
700 | @retval EFI_UNSUPPORTED The capsule type is not supported on this platform.\r | |
701 | @retval EFI_OUT_OF_RESOURCES There were insufficient resources to process the capsule.\r | |
702 | \r | |
703 | **/\r | |
704 | EFI_STATUS\r | |
705 | EFIAPI\r | |
706 | EfiUpdateCapsule (\r | |
2f88bd3a MK |
707 | IN EFI_CAPSULE_HEADER **CapsuleHeaderArray,\r |
708 | IN UINTN CapsuleCount,\r | |
709 | IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL\r | |
363bb1b5 | 710 | )\r |
711 | {\r | |
712 | return mInternalRT->UpdateCapsule (\r | |
713 | CapsuleHeaderArray,\r | |
714 | CapsuleCount,\r | |
715 | ScatterGatherList\r | |
716 | );\r | |
717 | }\r | |
718 | \r | |
363bb1b5 | 719 | /**\r |
720 | This service is a wrapper for the UEFI Runtime Service QueryCapsuleCapabilities().\r | |
721 | \r | |
722 | The QueryCapsuleCapabilities() function allows a caller to test to see if a capsule or\r | |
723 | capsules can be updated via UpdateCapsule(). The Flags values in the capsule header and\r | |
724 | size of the entire capsule is checked.\r | |
725 | If the caller needs to query for generic capsule capability a fake EFI_CAPSULE_HEADER can be\r | |
726 | constructed where CapsuleImageSize is equal to HeaderSize that is equal to sizeof\r | |
727 | (EFI_CAPSULE_HEADER). To determine reset requirements,\r | |
728 | CAPSULE_FLAGS_PERSIST_ACROSS_RESET should be set in the Flags field of the\r | |
729 | EFI_CAPSULE_HEADER.\r | |
730 | The firmware must support any capsule that has the\r | |
731 | CAPSULE_FLAGS_PERSIST_ACROSS_RESET flag set in EFI_CAPSULE_HEADER. The\r | |
732 | firmware sets the policy for what capsules are supported that do not have the\r | |
733 | CAPSULE_FLAGS_PERSIST_ACROSS_RESET flag set.\r | |
734 | \r | |
735 | @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules\r | |
736 | being passed into update capsule. The capsules are assumed to\r | |
737 | stored in contiguous virtual memory.\r | |
2fc59a00 | 738 | @param CapsuleCount The number of pointers to EFI_CAPSULE_HEADER in\r |
363bb1b5 | 739 | CaspuleHeaderArray.\r |
740 | @param MaximumCapsuleSize On output the maximum size that UpdateCapsule() can\r | |
741 | support as an argument to UpdateCapsule() via\r | |
742 | CapsuleHeaderArray and ScatterGatherList.\r | |
743 | Undefined on input.\r | |
744 | @param ResetType Returns the type of reset required for the capsule update.\r | |
745 | \r | |
58380e9c | 746 | @retval EFI_SUCCESS A valid answer was returned.\r |
363bb1b5 | 747 | @retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.\r |
748 | @retval EFI_UNSUPPORTED The capsule type is not supported on this platform, and\r | |
749 | MaximumCapsuleSize and ResetType are undefined.\r | |
750 | @retval EFI_OUT_OF_RESOURCES There were insufficient resources to process the query request.\r | |
751 | \r | |
752 | **/\r | |
753 | EFI_STATUS\r | |
754 | EFIAPI\r | |
755 | EfiQueryCapsuleCapabilities (\r | |
2f88bd3a MK |
756 | IN EFI_CAPSULE_HEADER **CapsuleHeaderArray,\r |
757 | IN UINTN CapsuleCount,\r | |
758 | OUT UINT64 *MaximumCapsuleSize,\r | |
759 | OUT EFI_RESET_TYPE *ResetType\r | |
363bb1b5 | 760 | )\r |
761 | {\r | |
762 | return mInternalRT->QueryCapsuleCapabilities (\r | |
763 | CapsuleHeaderArray,\r | |
764 | CapsuleCount,\r | |
765 | MaximumCapsuleSize,\r | |
766 | ResetType\r | |
767 | );\r | |
768 | }\r | |
769 | \r | |
363bb1b5 | 770 | /**\r |
771 | This service is a wrapper for the UEFI Runtime Service QueryVariableInfo().\r | |
772 | \r | |
773 | The QueryVariableInfo() function allows a caller to obtain the information about the\r | |
774 | maximum size of the storage space available for the EFI variables, the remaining size of the storage\r | |
775 | space available for the EFI variables and the maximum size of each individual EFI variable,\r | |
776 | associated with the attributes specified.\r | |
777 | The returned MaximumVariableStorageSize, RemainingVariableStorageSize,\r | |
778 | MaximumVariableSize information may change immediately after the call based on other\r | |
779 | runtime activities including asynchronous error events. Also, these values associated with different\r | |
780 | attributes are not additive in nature.\r | |
781 | \r | |
782 | @param Attributes Attributes bitmask to specify the type of variables on\r | |
783 | which to return information. Refer to the\r | |
784 | GetVariable() function description.\r | |
785 | @param MaximumVariableStorageSize\r | |
786 | On output the maximum size of the storage space\r | |
787 | available for the EFI variables associated with the\r | |
788 | attributes specified.\r | |
789 | @param RemainingVariableStorageSize\r | |
790 | Returns the remaining size of the storage space\r | |
791 | available for the EFI variables associated with the\r | |
792 | attributes specified..\r | |
793 | @param MaximumVariableSize Returns the maximum size of the individual EFI\r | |
794 | variables associated with the attributes specified.\r | |
795 | \r | |
58380e9c | 796 | @retval EFI_SUCCESS A valid answer was returned.\r |
363bb1b5 | 797 | @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied.\r |
798 | @retval EFI_UNSUPPORTED EFI_UNSUPPORTED The attribute is not supported on this platform, and the\r | |
799 | MaximumVariableStorageSize,\r | |
800 | RemainingVariableStorageSize, MaximumVariableSize\r | |
801 | are undefined.\r | |
802 | \r | |
803 | **/\r | |
804 | EFI_STATUS\r | |
805 | EFIAPI\r | |
806 | EfiQueryVariableInfo (\r | |
807 | IN UINT32 Attributes,\r | |
808 | OUT UINT64 *MaximumVariableStorageSize,\r | |
809 | OUT UINT64 *RemainingVariableStorageSize,\r | |
810 | OUT UINT64 *MaximumVariableSize\r | |
811 | )\r | |
812 | {\r | |
813 | return mInternalRT->QueryVariableInfo (\r | |
814 | Attributes,\r | |
815 | MaximumVariableStorageSize,\r | |
816 | RemainingVariableStorageSize,\r | |
817 | MaximumVariableSize\r | |
818 | );\r | |
819 | }\r |