]>
Commit | Line | Data |
---|---|---|
1 | /** @file\r | |
2 | Provides library functions for each of the UEFI Runtime Services.\r | |
3 | Only available to DXE and UEFI module types.\r | |
4 | \r | |
5 | Copyright (c) 2006 - 2008, Intel Corporation<BR>\r | |
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 | |
10 | \r | |
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 | |
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 | |
24 | This function allows the caller to determine if UEFI ExitBootServices() has been called.\r | |
25 | \r | |
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 | |
30 | \r | |
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 | |
33 | \r | |
34 | **/\r | |
35 | BOOLEAN\r | |
36 | EFIAPI\r | |
37 | EfiAtRuntime (\r | |
38 | VOID\r | |
39 | );\r | |
40 | \r | |
41 | /**\r | |
42 | This function allows the caller to determine if UEFI SetVirtualAddressMap() has been called. \r | |
43 | \r | |
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 | |
51 | \r | |
52 | **/\r | |
53 | BOOLEAN\r | |
54 | EFIAPI\r | |
55 | EfiGoneVirtual (\r | |
56 | VOID\r | |
57 | );\r | |
58 | \r | |
59 | /**\r | |
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 | |
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 | |
74 | \r | |
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 | |
78 | \r | |
79 | **/\r | |
80 | EFI_STATUS\r | |
81 | EFIAPI\r | |
82 | EfiGetTime (\r | |
83 | OUT EFI_TIME *Time,\r | |
84 | OUT EFI_TIME_CAPABILITIES *Capabilities OPTIONAL\r | |
85 | );\r | |
86 | \r | |
87 | /**\r | |
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 | |
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 | |
116 | Returns the current wakeup alarm clock setting.\r | |
117 | \r | |
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 | |
122 | \r | |
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 | |
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 | |
145 | Sets the system wakeup alarm clock time.\r | |
146 | \r | |
147 | @param Enable Enable or disable the wakeup alarm.\r | |
148 | @param Time If Enable is TRUE, the time to set the wakeup alarm for. Type EFI_TIME\r | |
149 | is defined in the GetTime() function description. If Enable is FALSE,\r | |
150 | then this parameter is optional, and may be NULL.\r | |
151 | \r | |
152 | @retval EFI_SUCCESS If Enable is TRUE, then the wakeup alarm was enabled.\r | |
153 | If Enable is FALSE, then the wakeup alarm was disabled.\r | |
154 | @retval EFI_INVALID_PARAMETER A time field is out of range.\r | |
155 | @retval EFI_DEVICE_ERROR The wakeup time could not be set due to a hardware error.\r | |
156 | @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.\r | |
157 | \r | |
158 | **/\r | |
159 | EFI_STATUS\r | |
160 | EFIAPI\r | |
161 | EfiSetWakeupTime (\r | |
162 | IN BOOLEAN Enable,\r | |
163 | IN EFI_TIME *Time OPTIONAL\r | |
164 | );\r | |
165 | \r | |
166 | /**\r | |
167 | Return value of variable.\r | |
168 | \r | |
169 | @param VariableName the name of the vendor's variable, it's a\r | |
170 | Null-Terminated Unicode String\r | |
171 | @param VendorGuid Unify identifier for vendor.\r | |
172 | @param Attributes Point to memory location to return the attributes of variable. If the point\r | |
173 | is NULL, the parameter would be ignored.\r | |
174 | @param DataSize As input, point to the maxinum size of return Data-Buffer.\r | |
175 | As output, point to the actual size of the returned Data-Buffer.\r | |
176 | @param Data Point to return Data-Buffer.\r | |
177 | \r | |
178 | @retval EFI_SUCCESS The function completed successfully.\r | |
179 | @retval EFI_NOT_FOUND The variable was not found.\r | |
180 | @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result. DataSize has\r | |
181 | been updated with the size needed to complete the request.\r | |
182 | @retval EFI_INVALID_PARAMETER VariableName is NULL.\r | |
183 | @retval EFI_INVALID_PARAMETER VendorGuid is NULL.\r | |
184 | @retval EFI_INVALID_PARAMETER DataSize is NULL.\r | |
185 | @retval EFI_INVALID_PARAMETER The DataSize is not too small and Data is NULL.\r | |
186 | @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.\r | |
187 | @retval EFI_SECURITY_VIOLATION The variable could not be retrieved due to an authentication failure.\r | |
188 | **/\r | |
189 | EFI_STATUS\r | |
190 | EFIAPI\r | |
191 | EfiGetVariable (\r | |
192 | IN CHAR16 *VariableName,\r | |
193 | IN EFI_GUID *VendorGuid,\r | |
194 | OUT UINT32 *Attributes OPTIONAL,\r | |
195 | IN OUT UINTN *DataSize,\r | |
196 | OUT VOID *Data\r | |
197 | );\r | |
198 | \r | |
199 | /**\r | |
200 | Enumerates variable's name.\r | |
201 | \r | |
202 | @param VariableNameSize As input, point to maxinum size of variable name.\r | |
203 | As output, point to actual size of varaible name.\r | |
204 | @param VariableName As input, supplies the last VariableName that was returned by\r | |
205 | GetNextVariableName().\r | |
206 | As output, returns the name of variable. The name\r | |
207 | string is Null-Terminated Unicode string.\r | |
208 | @param VendorGuid As input, supplies the last VendorGuid that was returned by\r | |
209 | GetNextVriableName().\r | |
210 | As output, returns the VendorGuid of the current variable.\r | |
211 | \r | |
212 | @retval EFI_SUCCESS The function completed successfully.\r | |
213 | @retval EFI_NOT_FOUND The next variable was not found.\r | |
214 | @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.\r | |
215 | VariableNameSize has been updated with the size needed\r | |
216 | to complete the request.\r | |
217 | @retval EFI_INVALID_PARAMETER VariableNameSize is NULL.\r | |
218 | @retval EFI_INVALID_PARAMETER VariableName is NULL.\r | |
219 | @retval EFI_INVALID_PARAMETER VendorGuid is NULL.\r | |
220 | @retval EFI_DEVICE_ERROR The variable name could not be retrieved due to a hardware error.\r | |
221 | \r | |
222 | **/\r | |
223 | EFI_STATUS\r | |
224 | EFIAPI\r | |
225 | EfiGetNextVariableName (\r | |
226 | IN OUT UINTN *VariableNameSize,\r | |
227 | IN OUT CHAR16 *VariableName,\r | |
228 | IN OUT EFI_GUID *VendorGuid\r | |
229 | );\r | |
230 | \r | |
231 | /**\r | |
232 | Sets value of variable.\r | |
233 | \r | |
234 | @param VariableName the name of the vendor's variable, it's a\r | |
235 | Null-Terminated Unicode String\r | |
236 | @param VendorGuid Unify identifier for vendor.\r | |
237 | @param Attributes Point to memory location to return the attributes of variable. If the point\r | |
238 | is NULL, the parameter would be ignored.\r | |
239 | @param DataSize The size in bytes of Data-Buffer.\r | |
240 | @param Data Point to the content of the variable.\r | |
241 | \r | |
242 | @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as\r | |
243 | defined by the Attributes.\r | |
244 | @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied, or the\r | |
245 | DataSize exceeds the maximum allowed.\r | |
246 | @retval EFI_INVALID_PARAMETER VariableName is an empty Unicode string.\r | |
247 | @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.\r | |
248 | @retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure.\r | |
249 | @retval EFI_WRITE_PROTECTED The variable in question is read-only.\r | |
250 | @retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.\r | |
251 | @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS\r | |
252 | set but the AuthInfo does NOT pass the validation check carried\r | |
253 | out by the firmware.\r | |
254 | @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.\r | |
255 | \r | |
256 | **/\r | |
257 | EFI_STATUS\r | |
258 | EFIAPI\r | |
259 | EfiSetVariable (\r | |
260 | IN CHAR16 *VariableName,\r | |
261 | IN EFI_GUID *VendorGuid,\r | |
262 | IN UINT32 Attributes,\r | |
263 | IN UINTN DataSize,\r | |
264 | IN VOID *Data\r | |
265 | );\r | |
266 | \r | |
267 | /**\r | |
268 | Returns the next high 32 bits of platform's monotonic counter.\r | |
269 | \r | |
270 | @param HighCount Pointer to returned value.\r | |
271 | \r | |
272 | @retval EFI_SUCCESS The next high monotonic count was returned.\r | |
273 | @retval EFI_DEVICE_ERROR The device is not functioning properly.\r | |
274 | @retval EFI_INVALID_PARAMETER HighCount is NULL.\r | |
275 | \r | |
276 | **/\r | |
277 | EFI_STATUS\r | |
278 | EFIAPI\r | |
279 | EfiGetNextHighMonotonicCount (\r | |
280 | OUT UINT32 *HighCount\r | |
281 | );\r | |
282 | \r | |
283 | /**\r | |
284 | Resets the entire platform.\r | |
285 | \r | |
286 | @param ResetType The type of reset to perform.\r | |
287 | @param ResetStatus The status code for the reset. If the system reset is part of a\r | |
288 | normal operation, the status code would be EFI_SUCCESS. If the system\r | |
289 | reset is due to some type of failure the most appropriate EFI Status\r | |
290 | code would be used.\r | |
291 | @param DataSizeThe size, in bytes, of ResetData.\r | |
292 | @param ResetData For a ResetType of EfiResetCold, EfiResetWarm, or EfiResetShutdown\r | |
293 | the data buffer starts with a Null-terminated Unicode string, optionally\r | |
294 | followed by additional binary data. The string is a description that the\r | |
295 | caller may use to further indicate the reason for the system reset. ResetData\r | |
296 | is only valid if ResetStatus is something other then EFI_SUCCESS. This\r | |
297 | pointer must be a physical address. For a ResetType of EfiRestUpdate the\r | |
298 | data buffer also starts with a Null-terminated string that is followed by\r | |
299 | a physical VOID * to an EFI_CAPSULE_HEADER.\r | |
300 | \r | |
301 | **/\r | |
302 | VOID\r | |
303 | EFIAPI\r | |
304 | EfiResetSystem (\r | |
305 | IN EFI_RESET_TYPE ResetType,\r | |
306 | IN EFI_STATUS ResetStatus,\r | |
307 | IN UINTN DataSize,\r | |
308 | IN CHAR16 *ResetData\r | |
309 | );\r | |
310 | \r | |
311 | /**\r | |
312 | This service converts a function pointer from physical to virtual addressing. \r | |
313 | \r | |
314 | @param DebugDisposition Supplies type information for the pointer being converted.\r | |
315 | @param Address The pointer to a pointer that is to be fixed to be the\r | |
316 | value needed for the new virtual address mapping being\r | |
317 | applied.\r | |
318 | \r | |
319 | @retval EFI_SUCCESS The pointer pointed to by Address was modified.\r | |
320 | @retval EFI_NOT_FOUND The pointer pointed to by Address was not found to be part of\r | |
321 | the current memory map. This is normally fatal.\r | |
322 | @retval EFI_INVALID_PARAMETER Address is NULL.\r | |
323 | @retval EFI_INVALID_PARAMETER *Address is NULL and DebugDispositio\r | |
324 | \r | |
325 | **/\r | |
326 | EFI_STATUS\r | |
327 | EFIAPI\r | |
328 | EfiConvertPointer (\r | |
329 | IN UINTN DebugDisposition,\r | |
330 | IN OUT VOID **Address\r | |
331 | );\r | |
332 | \r | |
333 | /**\r | |
334 | Determines the new virtual address that is to be used on subsequent memory accesses.\r | |
335 | \r | |
336 | For IA32, X64, and EBC, this service is a wrapper for the UEFI Runtime Service\r | |
337 | ConvertPointer(). See the UEFI Specification for details. \r | |
338 | For IPF, this function interprets Address as a pointer to an EFI_PLABEL structure\r | |
339 | and both the EntryPoint and GP fields of an EFI_PLABEL are converted from physical\r | |
340 | to virtiual addressing. Since IPF allows the GP to point to an address outside\r | |
341 | a PE/COFF image, the physical to virtual offset for the EntryPoint field is used\r | |
342 | to adjust the GP field. The UEFI Runtime Service ConvertPointer() is used to convert\r | |
343 | EntryPoint and the status code for this conversion is always returned. If the convertion\r | |
344 | of EntryPoint fails, then neither EntryPoint nor GP are modified. See the UEFI\r | |
345 | Specification for details on the UEFI Runtime Service ConvertPointer().\r | |
346 | \r | |
347 | @param DebugDisposition Supplies type information for the pointer being converted.\r | |
348 | @param Address The pointer to a pointer that is to be fixed to be the\r | |
349 | value needed for the new virtual address mapping being\r | |
350 | applied.\r | |
351 | \r | |
352 | @return EFI_STATUS value from EfiConvertPointer().\r | |
353 | \r | |
354 | **/\r | |
355 | EFI_STATUS\r | |
356 | EFIAPI\r | |
357 | EfiConvertFunctionPointer (\r | |
358 | IN UINTN DebugDisposition,\r | |
359 | IN OUT VOID **Address\r | |
360 | );\r | |
361 | \r | |
362 | /**\r | |
363 | Change the runtime addressing mode of EFI firmware from physical to virtual.\r | |
364 | \r | |
365 | @param MemoryMapSize The size in bytes of VirtualMap.\r | |
366 | @param DescriptorSize The size in bytes of an entry in the VirtualMap.\r | |
367 | @param DescriptorVersion The version of the structure entries in VirtualMap.\r | |
368 | @param VirtualMap An array of memory descriptors which contain new virtual\r | |
369 | address mapping information for all runtime ranges. Type\r | |
370 | EFI_MEMORY_DESCRIPTOR is defined in the\r | |
371 | GetMemoryMap() function description.\r | |
372 | \r | |
373 | @retval EFI_SUCCESS The virtual address map has been applied.\r | |
374 | @retval EFI_UNSUPPORTED EFI firmware is not at runtime, or the EFI firmware is already in\r | |
375 | virtual address mapped mode.\r | |
376 | @retval EFI_INVALID_PARAMETER DescriptorSize or DescriptorVersion is\r | |
377 | invalid.\r | |
378 | @retval EFI_NO_MAPPING A virtual address was not supplied for a range in the memory\r | |
379 | map that requires a mapping.\r | |
380 | @retval EFI_NOT_FOUND A virtual address was supplied for an address that is not found\r | |
381 | in the memory map.\r | |
382 | **/\r | |
383 | EFI_STATUS\r | |
384 | EFIAPI\r | |
385 | EfiSetVirtualAddressMap (\r | |
386 | IN UINTN MemoryMapSize,\r | |
387 | IN UINTN DescriptorSize,\r | |
388 | IN UINT32 DescriptorVersion,\r | |
389 | IN CONST EFI_MEMORY_DESCRIPTOR *VirtualMap\r | |
390 | );\r | |
391 | \r | |
392 | \r | |
393 | /**\r | |
394 | Convert the standard Lib double linked list to a virtual mapping.\r | |
395 | \r | |
396 | This service uses EfiConvertPointer() to walk a double linked list and convert all the link\r | |
397 | pointers to their virtual mappings. This function is only guaranteed to work during the\r | |
398 | EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event and calling it at other times has undefined results.\r | |
399 | \r | |
400 | @param DebugDisposition Supplies type information for the pointer being converted.\r | |
401 | @param ListHead Head of linked list to convert.\r | |
402 | \r | |
403 | @retval EFI_SUCCESS Success to execute the function.\r | |
404 | @retval !EFI_SUCCESS Failed to e3xecute the function.\r | |
405 | \r | |
406 | **/\r | |
407 | EFI_STATUS\r | |
408 | EFIAPI\r | |
409 | EfiConvertList (\r | |
410 | IN UINTN DebugDisposition,\r | |
411 | IN OUT LIST_ENTRY *ListHead\r | |
412 | );\r | |
413 | \r | |
414 | /**\r | |
415 | Passes capsules to the firmware with both virtual and physical mapping.\r | |
416 | Depending on the intended consumption, the firmware may\r | |
417 | process the capsule immediately. If the payload should persist across a\r | |
418 | system reset, the reset value returned from EFI_QueryCapsuleCapabilities must\r | |
419 | be passed into ResetSystem() and will cause the capsule to be processed by\r | |
420 | the firmware as part of the reset process.\r | |
421 | \r | |
422 | @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules\r | |
423 | being passed into update capsule. Each capsules is assumed to\r | |
424 | stored in contiguous virtual memory. The capsules in the\r | |
425 | CapsuleHeaderArray must be the same capsules as the\r | |
426 | ScatterGatherList. The CapsuleHeaderArray must\r | |
427 | have the capsules in the same order as the ScatterGatherList.\r | |
428 | @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in\r | |
429 | CaspuleHeaderArray.\r | |
430 | @param ScatterGatherList Physical pointer to a set of\r | |
431 | EFI_CAPSULE_BLOCK_DESCRIPTOR that describes the\r | |
432 | location in physical memory of a set of capsules. See Related\r | |
433 | Definitions for an explanation of how more than one capsule is\r | |
434 | passed via this interface. The capsules in the\r | |
435 | ScatterGatherList must be in the same order as the\r | |
436 | CapsuleHeaderArray. This parameter is only referenced if\r | |
437 | the capsules are defined to persist across system reset.\r | |
438 | \r | |
439 | @retval EFI_SUCCESS Valid capsule was passed. If CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set,\r | |
440 | the capsule has been successfully processed by the firmware.\r | |
441 | @retval EFI_INVALID_PARAMETER CapsuleSize or HeaderSize is NULL.\r | |
442 | @retval EFI_INVALID_PARAMETER CapsuleCount is 0\r | |
443 | @retval EFI_DEVICE_ERROR The capsule update was started, but failed due to a device error.\r | |
444 | @retval EFI_UNSUPPORTED The capsule type is not supported on this platform.\r | |
445 | @retval EFI_OUT_OF_RESOURCES There were insufficient resources to process the capsule.\r | |
446 | \r | |
447 | **/\r | |
448 | EFI_STATUS\r | |
449 | EFIAPI\r | |
450 | EfiUpdateCapsule (\r | |
451 | IN EFI_CAPSULE_HEADER **CapsuleHeaderArray,\r | |
452 | IN UINTN CapsuleCount,\r | |
453 | IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL\r | |
454 | );\r | |
455 | \r | |
456 | \r | |
457 | /**\r | |
458 | The QueryCapsuleCapabilities() function allows a caller to test to see if a capsule or\r | |
459 | capsules can be updated via UpdateCapsule(). The Flags values in the capsule header and\r | |
460 | size of the entire capsule is checked.\r | |
461 | If the caller needs to query for generic capsule capability a fake EFI_CAPSULE_HEADER can be\r | |
462 | constructed where CapsuleImageSize is equal to HeaderSize that is equal to sizeof\r | |
463 | (EFI_CAPSULE_HEADER). To determine reset requirements,\r | |
464 | CAPSULE_FLAGS_PERSIST_ACROSS_RESET should be set in the Flags field of the\r | |
465 | EFI_CAPSULE_HEADER.\r | |
466 | The firmware must support any capsule that has the\r | |
467 | CAPSULE_FLAGS_PERSIST_ACROSS_RESET flag set in EFI_CAPSULE_HEADER. The\r | |
468 | firmware sets the policy for what capsules are supported that do not have the\r | |
469 | CAPSULE_FLAGS_PERSIST_ACROSS_RESET flag set.\r | |
470 | \r | |
471 | @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules\r | |
472 | being passed into update capsule. The capsules are assumed to\r | |
473 | stored in contiguous virtual memory.\r | |
474 | @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in\r | |
475 | CaspuleHeaderArray.\r | |
476 | @param MaximumCapsuleSize On output the maximum size that UpdateCapsule() can\r | |
477 | support as an argument to UpdateCapsule() via\r | |
478 | CapsuleHeaderArray and ScatterGatherList.\r | |
479 | Undefined on input.\r | |
480 | @param ResetType Returns the type of reset required for the capsule update.\r | |
481 | \r | |
482 | @retval EFI_SUCCESS Valid answer returned.\r | |
483 | @retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.\r | |
484 | @retval EFI_UNSUPPORTED The capsule type is not supported on this platform, and\r | |
485 | MaximumCapsuleSize and ResetType are undefined.\r | |
486 | @retval EFI_OUT_OF_RESOURCES There were insufficient resources to process the query request.\r | |
487 | \r | |
488 | **/\r | |
489 | EFI_STATUS\r | |
490 | EFIAPI\r | |
491 | EfiQueryCapsuleCapabilities (\r | |
492 | IN EFI_CAPSULE_HEADER **CapsuleHeaderArray,\r | |
493 | IN UINTN CapsuleCount,\r | |
494 | OUT UINT64 *MaximumCapsuleSize,\r | |
495 | OUT EFI_RESET_TYPE *ResetType\r | |
496 | );\r | |
497 | \r | |
498 | \r | |
499 | /**\r | |
500 | Returns information about the EFI variables.\r | |
501 | \r | |
502 | The QueryVariableInfo() function allows a caller to obtain the information about the\r | |
503 | maximum size of the storage space available for the EFI variables, the remaining size of the storage\r | |
504 | space available for the EFI variables and the maximum size of each individual EFI variable,\r | |
505 | associated with the attributes specified.\r | |
506 | The returned MaximumVariableStorageSize, RemainingVariableStorageSize,\r | |
507 | MaximumVariableSize information may change immediately after the call based on other\r | |
508 | runtime activities including asynchronous error events. Also, these values associated with different\r | |
509 | attributes are not additive in nature.\r | |
510 | \r | |
511 | @param Attributes Attributes bitmask to specify the type of variables on\r | |
512 | which to return information. Refer to the\r | |
513 | GetVariable() function description.\r | |
514 | @param MaximumVariableStorageSize\r | |
515 | On output the maximum size of the storage space\r | |
516 | available for the EFI variables associated with the\r | |
517 | attributes specified.\r | |
518 | @param RemainingVariableStorageSize\r | |
519 | Returns the remaining size of the storage space\r | |
520 | available for the EFI variables associated with the\r | |
521 | attributes specified..\r | |
522 | @param MaximumVariableSize Returns the maximum size of the individual EFI\r | |
523 | variables associated with the attributes specified.\r | |
524 | \r | |
525 | @retval EFI_SUCCESS Valid answer returned.\r | |
526 | @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied.\r | |
527 | @retval EFI_UNSUPPORTED EFI_UNSUPPORTED The attribute is not supported on this platform, and the\r | |
528 | MaximumVariableStorageSize,\r | |
529 | RemainingVariableStorageSize, MaximumVariableSize\r | |
530 | are undefined.\r | |
531 | **/\r | |
532 | EFI_STATUS\r | |
533 | EFIAPI\r | |
534 | EfiQueryVariableInfo (\r | |
535 | IN UINT32 Attributes,\r | |
536 | OUT UINT64 *MaximumVariableStorageSize,\r | |
537 | OUT UINT64 *RemainingVariableStorageSize,\r | |
538 | OUT UINT64 *MaximumVariableSize\r | |
539 | );\r | |
540 | \r | |
541 | #endif\r | |
542 | \r |