2 UEFI Runtime Library implementation for non IPF processor types.
4 This library hides the global variable for the EFI Runtime Services so the
5 caller does not need to deal with the possibility of being called from an
6 OS virtual address space. All pointer values are different for a virtual
7 mapping than from the normal physical mapping at boot services time.
9 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
10 SPDX-License-Identifier: BSD-2-Clause-Patent
15 #include <Library/UefiRuntimeLib.h>
16 #include <Library/DebugLib.h>
17 #include <Library/UefiBootServicesTableLib.h>
18 #include <Library/UefiRuntimeServicesTableLib.h>
19 #include <Guid/EventGroup.h>
22 /// Driver Lib Module Globals
24 EFI_EVENT mEfiVirtualNotifyEvent
;
25 EFI_EVENT mEfiExitBootServicesEvent
;
26 BOOLEAN mEfiGoneVirtual
= FALSE
;
27 BOOLEAN mEfiAtRuntime
= FALSE
;
28 EFI_RUNTIME_SERVICES
*mInternalRT
;
31 Set AtRuntime flag as TRUE after ExitBootServices.
33 @param[in] Event The Event that is being processed.
34 @param[in] Context The Event Context.
39 RuntimeLibExitBootServicesEvent (
48 Fixup internal data so that EFI can be call in virtual mode.
49 Call the passed in Child Notify event and convert any pointers in
52 @param[in] Event The Event that is being processed.
53 @param[in] Context The Event Context.
57 RuntimeLibVirtualNotifyEvent (
63 // Update global for Runtime Services Table and IO
65 EfiConvertPointer (0, (VOID
**)&mInternalRT
);
67 mEfiGoneVirtual
= TRUE
;
71 Initialize runtime Driver Lib if it has not yet been initialized.
72 It will ASSERT() if gRT is NULL or gBS is NULL.
73 It will ASSERT() if that operation fails.
75 @param[in] ImageHandle The firmware allocated handle for the EFI image.
76 @param[in] SystemTable A pointer to the EFI System Table.
78 @return EFI_STATUS always returns EFI_SUCCESS except EFI_ALREADY_STARTED if already started.
82 RuntimeDriverLibConstruct (
83 IN EFI_HANDLE ImageHandle
,
84 IN EFI_SYSTEM_TABLE
*SystemTable
94 // Register SetVirtualAddressMap () notify function
96 Status
= gBS
->CreateEvent (
97 EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE
,
99 RuntimeLibVirtualNotifyEvent
,
101 &mEfiVirtualNotifyEvent
104 ASSERT_EFI_ERROR (Status
);
106 Status
= gBS
->CreateEvent (
107 EVT_SIGNAL_EXIT_BOOT_SERVICES
,
109 RuntimeLibExitBootServicesEvent
,
111 &mEfiExitBootServicesEvent
114 ASSERT_EFI_ERROR (Status
);
120 If a runtime driver exits with an error, it must call this routine
121 to free the allocated resource before the exiting.
122 It will ASSERT() if gBS is NULL.
123 It will ASSERT() if that operation fails.
125 @param[in] ImageHandle The firmware allocated handle for the EFI image.
126 @param[in] SystemTable A pointer to the EFI System Table.
128 @retval EFI_SUCCESS The Runtime Driver Lib shutdown successfully.
129 @retval EFI_UNSUPPORTED Runtime Driver lib was not initialized.
133 RuntimeDriverLibDeconstruct (
134 IN EFI_HANDLE ImageHandle
,
135 IN EFI_SYSTEM_TABLE
*SystemTable
141 // Close SetVirtualAddressMap () notify function
143 ASSERT (gBS
!= NULL
);
144 Status
= gBS
->CloseEvent (mEfiVirtualNotifyEvent
);
145 ASSERT_EFI_ERROR (Status
);
147 Status
= gBS
->CloseEvent (mEfiExitBootServicesEvent
);
148 ASSERT_EFI_ERROR (Status
);
154 This function allows the caller to determine if UEFI ExitBootServices() has been called.
156 This function returns TRUE after all the EVT_SIGNAL_EXIT_BOOT_SERVICES functions have
157 executed as a result of the OS calling ExitBootServices(). Prior to this time FALSE
158 is returned. This function is used by runtime code to decide it is legal to access
159 services that go away after ExitBootServices().
161 @retval TRUE The system has finished executing the EVT_SIGNAL_EXIT_BOOT_SERVICES event.
162 @retval FALSE The system has not finished executing the EVT_SIGNAL_EXIT_BOOT_SERVICES event.
171 return mEfiAtRuntime
;
175 This function allows the caller to determine if UEFI SetVirtualAddressMap() has been called.
177 This function returns TRUE after all the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE functions have
178 executed as a result of the OS calling SetVirtualAddressMap(). Prior to this time FALSE
179 is returned. This function is used by runtime code to decide it is legal to access services
180 that go away after SetVirtualAddressMap().
182 @retval TRUE The system has finished executing the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.
183 @retval FALSE The system has not finished executing the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.
192 return mEfiGoneVirtual
;
196 This service is a wrapper for the UEFI Runtime Service ResetSystem().
198 The ResetSystem()function resets the entire platform, including all processors and devices,and reboots the system.
199 Calling this interface with ResetType of EfiResetCold causes a system-wide reset. This sets all circuitry within
200 the system to its initial state. This type of reset is asynchronous to system operation and operates without regard
201 to cycle boundaries. EfiResetCold is tantamount to a system power cycle.
202 Calling this interface with ResetType of EfiResetWarm causes a system-wide initialization. The processors are set to
203 their initial state, and pending cycles are not corrupted. If the system does not support this reset type, then an
204 EfiResetCold must be performed.
205 Calling this interface with ResetType of EfiResetShutdown causes the system to enter a power state equivalent to the
206 ACPI G2/S5 or G3 states. If the system does not support this reset type, then when the system is rebooted, it should
207 exhibit the EfiResetCold attributes.
208 The platform may optionally log the parameters from any non-normal reset that occurs.
209 The ResetSystem() function does not return.
211 @param ResetType The type of reset to perform.
212 @param ResetStatus The status code for the reset. If the system reset is part of a normal operation, the status code
213 would be EFI_SUCCESS. If the system reset is due to some type of failure the most appropriate EFI
214 Status code would be used.
215 @param DataSizeThe size, in bytes, of ResetData.
216 @param ResetData For a ResetType of EfiResetCold, EfiResetWarm, or EfiResetShutdown the data buffer starts with a
217 Null-terminated Unicode string, optionally followed by additional binary data. The string is a
218 description that the caller may use to further indicate the reason for the system reset. ResetData
219 is only valid if ResetStatus is something other then EFI_SUCCESS. This pointer must be a physical
220 address. For a ResetType of EfiRestUpdate the data buffer also starts with a Null-terminated string
221 that is followed by a physical VOID * to an EFI_CAPSULE_HEADER.
227 IN EFI_RESET_TYPE ResetType
,
228 IN EFI_STATUS ResetStatus
,
230 IN VOID
*ResetData OPTIONAL
233 mInternalRT
->ResetSystem (ResetType
, ResetStatus
, DataSize
, ResetData
);
237 This service is a wrapper for the UEFI Runtime Service GetTime().
239 The GetTime() function returns a time that was valid sometime during the call to the function.
240 While the returned EFI_TIME structure contains TimeZone and Daylight savings time information,
241 the actual clock does not maintain these values. The current time zone and daylight saving time
242 information returned by GetTime() are the values that were last set via SetTime().
243 The GetTime() function should take approximately the same amount of time to read the time each
244 time it is called. All reported device capabilities are to be rounded up.
245 During runtime, if a PC-AT CMOS device is present in the platform the caller must synchronize
246 access to the device before calling GetTime().
248 @param Time A pointer to storage to receive a snapshot of the current time.
249 @param Capabilities An optional pointer to a buffer to receive the real time clock device's
252 @retval EFI_SUCCESS The operation completed successfully.
253 @retval EFI_INVALID_PARAMETER Time is NULL.
254 @retval EFI_DEVICE_ERROR The time could not be retrieved due to a hardware error.
261 OUT EFI_TIME_CAPABILITIES
*Capabilities OPTIONAL
264 return mInternalRT
->GetTime (Time
, Capabilities
);
268 This service is a wrapper for the UEFI Runtime Service SetTime().
270 The SetTime() function sets the real time clock device to the supplied time, and records the
271 current time zone and daylight savings time information. The SetTime() function is not allowed
272 to loop based on the current time. For example, if the device does not support a hardware reset
273 for the sub-resolution time, the code is not to implement the feature by waiting for the time to
275 During runtime, if a PC-AT CMOS device is present in the platform the caller must synchronize
276 access to the device before calling SetTime().
278 @param Time A pointer to the current time. Type EFI_TIME is defined in the GetTime()
279 function description. Full error checking is performed on the different
280 fields of the EFI_TIME structure (refer to the EFI_TIME definition in the
281 GetTime() function description for full details), and EFI_INVALID_PARAMETER
282 is returned if any field is out of range.
284 @retval EFI_SUCCESS The operation completed successfully.
285 @retval EFI_INVALID_PARAMETER A time field is out of range.
286 @retval EFI_DEVICE_ERROR The time could not be set due to a hardware error.
295 return mInternalRT
->SetTime (Time
);
299 This service is a wrapper for the UEFI Runtime Service GetWakeupTime().
301 The alarm clock time may be rounded from the set alarm clock time to be within the resolution
302 of the alarm clock device. The resolution of the alarm clock device is defined to be one second.
303 During runtime, if a PC-AT CMOS device is present in the platform the caller must synchronize
304 access to the device before calling GetWakeupTime().
306 @param Enabled Indicates if the alarm is currently enabled or disabled.
307 @param Pending Indicates if the alarm signal is pending and requires acknowledgement.
308 @param Time The current alarm setting. Type EFI_TIME is defined in the GetTime()
309 function description.
311 @retval EFI_SUCCESS The alarm settings were returned.
312 @retval EFI_INVALID_PARAMETER Enabled is NULL.
313 @retval EFI_INVALID_PARAMETER Pending is NULL.
314 @retval EFI_INVALID_PARAMETER Time is NULL.
315 @retval EFI_DEVICE_ERROR The wakeup time could not be retrieved due to a hardware error.
316 @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
322 OUT BOOLEAN
*Enabled
,
323 OUT BOOLEAN
*Pending
,
327 return mInternalRT
->GetWakeupTime (Enabled
, Pending
, Time
);
331 This service is a wrapper for the UEFI Runtime Service SetWakeupTime()
333 Setting a system wakeup alarm causes the system to wake up or power on at the set time.
334 When the alarm fires, the alarm signal is latched until it is acknowledged by calling SetWakeupTime()
335 to disable the alarm. If the alarm fires before the system is put into a sleeping or off state,
336 since the alarm signal is latched the system will immediately wake up. If the alarm fires while
337 the system is off and there is insufficient power to power on the system, the system is powered
338 on when power is restored.
340 @param Enable Enable or disable the wakeup alarm.
341 @param Time If Enable is TRUE, the time to set the wakeup alarm for. Type EFI_TIME
342 is defined in the GetTime() function description. If Enable is FALSE,
343 then this parameter is optional, and may be NULL.
345 @retval EFI_SUCCESS If Enable is TRUE, then the wakeup alarm was enabled.
346 If Enable is FALSE, then the wakeup alarm was disabled.
347 @retval EFI_INVALID_PARAMETER A time field is out of range.
348 @retval EFI_DEVICE_ERROR The wakeup time could not be set due to a hardware error.
349 @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
356 IN EFI_TIME
*Time OPTIONAL
359 return mInternalRT
->SetWakeupTime (Enable
, Time
);
363 This service is a wrapper for the UEFI Runtime Service GetVariable().
365 Each vendor may create and manage its own variables without the risk of name conflicts by
366 using a unique VendorGuid. When a variable is set its Attributes are supplied to indicate
367 how the data variable should be stored and maintained by the system. The attributes affect
368 when the variable may be accessed and volatility of the data. Any attempts to access a variable
369 that does not have the attribute set for runtime access will yield the EFI_NOT_FOUND error.
370 If the Data buffer is too small to hold the contents of the variable, the error EFI_BUFFER_TOO_SMALL
371 is returned and DataSize is set to the required buffer size to obtain the data.
373 @param VariableName the name of the vendor's variable, it's a Null-Terminated Unicode String
374 @param VendorGuid Unify identifier for vendor.
375 @param Attributes Point to memory location to return the attributes of variable. If the point
376 is NULL, the parameter would be ignored.
377 @param DataSize As input, point to the maximum size of return Data-Buffer.
378 As output, point to the actual size of the returned Data-Buffer.
379 @param Data Point to return Data-Buffer.
381 @retval EFI_SUCCESS The function completed successfully.
382 @retval EFI_NOT_FOUND The variable was not found.
383 @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result. DataSize has
384 been updated with the size needed to complete the request.
385 @retval EFI_INVALID_PARAMETER VariableName is NULL.
386 @retval EFI_INVALID_PARAMETER VendorGuid is NULL.
387 @retval EFI_INVALID_PARAMETER DataSize is NULL.
388 @retval EFI_INVALID_PARAMETER The DataSize is not too small and Data is NULL.
389 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
390 @retval EFI_SECURITY_VIOLATION The variable could not be retrieved due to an authentication failure.
395 IN CHAR16
*VariableName
,
396 IN EFI_GUID
*VendorGuid
,
397 OUT UINT32
*Attributes OPTIONAL
,
398 IN OUT UINTN
*DataSize
,
402 return mInternalRT
->GetVariable (VariableName
, VendorGuid
, Attributes
, DataSize
, Data
);
406 This service is a wrapper for the UEFI Runtime Service GetNextVariableName().
408 GetNextVariableName() is called multiple times to retrieve the VariableName and VendorGuid of
409 all variables currently available in the system. On each call to GetNextVariableName() the
410 previous results are passed into the interface, and on output the interface returns the next
411 variable name data. When the entire variable list has been returned, the error EFI_NOT_FOUND
414 @param VariableNameSize As input, point to maximum size of variable name.
415 As output, point to actual size of variable name.
416 @param VariableName As input, supplies the last VariableName that was returned by
417 GetNextVariableName().
418 As output, returns the name of variable. The name
419 string is Null-Terminated Unicode string.
420 @param VendorGuid As input, supplies the last VendorGuid that was returned by
421 GetNextVriableName().
422 As output, returns the VendorGuid of the current variable.
424 @retval EFI_SUCCESS The function completed successfully.
425 @retval EFI_NOT_FOUND The next variable was not found.
426 @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.
427 VariableNameSize has been updated with the size needed
428 to complete the request.
429 @retval EFI_INVALID_PARAMETER VariableNameSize is NULL.
430 @retval EFI_INVALID_PARAMETER VariableName is NULL.
431 @retval EFI_INVALID_PARAMETER VendorGuid is NULL.
432 @retval EFI_DEVICE_ERROR The variable name could not be retrieved due to a hardware error.
437 EfiGetNextVariableName (
438 IN OUT UINTN
*VariableNameSize
,
439 IN OUT CHAR16
*VariableName
,
440 IN OUT EFI_GUID
*VendorGuid
443 return mInternalRT
->GetNextVariableName (VariableNameSize
, VariableName
, VendorGuid
);
447 This service is a wrapper for the UEFI Runtime Service GetNextVariableName()
449 Variables are stored by the firmware and may maintain their values across power cycles. Each vendor
450 may create and manage its own variables without the risk of name conflicts by using a unique VendorGuid.
452 @param VariableName The name of the vendor's variable; it's a Null-Terminated
454 @param VendorGuid Unify identifier for vendor.
455 @param Attributes Points to a memory location to return the attributes of variable. If the point
456 is NULL, the parameter would be ignored.
457 @param DataSize The size in bytes of Data-Buffer.
458 @param Data Points to the content of the variable.
460 @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as
461 defined by the Attributes.
462 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied, or the
463 DataSize exceeds the maximum allowed.
464 @retval EFI_INVALID_PARAMETER VariableName is an empty Unicode string.
465 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
466 @retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure.
467 @retval EFI_WRITE_PROTECTED The variable in question is read-only.
468 @retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.
469 @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
470 set but the AuthInfo does NOT pass the validation check carried
472 @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.
478 IN CHAR16
*VariableName
,
479 IN EFI_GUID
*VendorGuid
,
480 IN UINT32 Attributes
,
485 return mInternalRT
->SetVariable (VariableName
, VendorGuid
, Attributes
, DataSize
, Data
);
489 This service is a wrapper for the UEFI Runtime Service GetNextHighMonotonicCount().
491 The platform's monotonic counter is comprised of two 32-bit quantities: the high 32 bits and
492 the low 32 bits. During boot service time the low 32-bit value is volatile: it is reset to zero
493 on every system reset and is increased by 1 on every call to GetNextMonotonicCount(). The high
494 32-bit value is nonvolatile and is increased by 1 whenever the system resets or whenever the low
495 32-bit count (returned by GetNextMonoticCount()) overflows.
497 @param HighCount The pointer to returned value.
499 @retval EFI_SUCCESS The next high monotonic count was returned.
500 @retval EFI_DEVICE_ERROR The device is not functioning properly.
501 @retval EFI_INVALID_PARAMETER HighCount is NULL.
506 EfiGetNextHighMonotonicCount (
507 OUT UINT32
*HighCount
510 return mInternalRT
->GetNextHighMonotonicCount (HighCount
);
514 This service is a wrapper for the UEFI Runtime Service ConvertPointer().
516 The ConvertPointer() function is used by an EFI component during the SetVirtualAddressMap() operation.
517 ConvertPointer()must be called using physical address pointers during the execution of SetVirtualAddressMap().
519 @param DebugDisposition Supplies type information for the pointer being converted.
520 @param Address The pointer to a pointer that is to be fixed to be the
521 value needed for the new virtual address mapping being
524 @retval EFI_SUCCESS The pointer pointed to by Address was modified.
525 @retval EFI_NOT_FOUND The pointer pointed to by Address was not found to be part of
526 the current memory map. This is normally fatal.
527 @retval EFI_INVALID_PARAMETER Address is NULL.
528 @retval EFI_INVALID_PARAMETER *Address is NULL and DebugDispositio
534 IN UINTN DebugDisposition
,
535 IN OUT VOID
**Address
538 return gRT
->ConvertPointer (DebugDisposition
, Address
);
542 Determines the new virtual address that is to be used on subsequent memory accesses.
544 For IA32, x64, and EBC, this service is a wrapper for the UEFI Runtime Service
545 ConvertPointer(). See the UEFI Specification for details.
546 For IPF, this function interprets Address as a pointer to an EFI_PLABEL structure
547 and both the EntryPoint and GP fields of an EFI_PLABEL are converted from physical
548 to virtiual addressing. Since IPF allows the GP to point to an address outside
549 a PE/COFF image, the physical to virtual offset for the EntryPoint field is used
550 to adjust the GP field. The UEFI Runtime Service ConvertPointer() is used to convert
551 EntryPoint and the status code for this conversion is always returned. If the convertion
552 of EntryPoint fails, then neither EntryPoint nor GP are modified. See the UEFI
553 Specification for details on the UEFI Runtime Service ConvertPointer().
555 @param DebugDisposition Supplies type information for the pointer being converted.
556 @param Address The pointer to a pointer that is to be fixed to be the
557 value needed for the new virtual address mapping being
560 @return EFI_STATUS value from EfiConvertPointer().
565 EfiConvertFunctionPointer (
566 IN UINTN DebugDisposition
,
567 IN OUT VOID
**Address
570 return EfiConvertPointer (DebugDisposition
, Address
);
574 Convert the standard Lib double linked list to a virtual mapping.
576 This service uses EfiConvertPointer() to walk a double linked list and convert all the link
577 pointers to their virtual mappings. This function is only guaranteed to work during the
578 EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event and calling it at other times has undefined results.
580 @param DebugDisposition Supplies type information for the pointer being converted.
581 @param ListHead Head of linked list to convert.
583 @retval EFI_SUCCESS Success to execute the function.
584 @retval !EFI_SUCCESS Failed to e3xecute the function.
590 IN UINTN DebugDisposition
,
591 IN OUT LIST_ENTRY
*ListHead
595 LIST_ENTRY
*NextLink
;
598 // For NULL List, return EFI_SUCCESS
600 if (ListHead
== NULL
) {
605 // Convert all the ForwardLink & BackLink pointers in the list
609 NextLink
= Link
->ForwardLink
;
612 Link
->ForwardLink
== ListHead
? DebugDisposition
: 0,
613 (VOID
**)&Link
->ForwardLink
617 Link
->BackLink
== ListHead
? DebugDisposition
: 0,
618 (VOID
**)&Link
->BackLink
622 } while (Link
!= ListHead
);
628 This service is a wrapper for the UEFI Runtime Service SetVirtualAddressMap().
630 The SetVirtualAddressMap() function is used by the OS loader. The function can only be called
631 at runtime, and is called by the owner of the system's memory map. I.e., the component which
632 called ExitBootServices(). All events of type EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE must be signaled
633 before SetVirtualAddressMap() returns.
635 @param MemoryMapSize The size in bytes of VirtualMap.
636 @param DescriptorSize The size in bytes of an entry in the VirtualMap.
637 @param DescriptorVersion The version of the structure entries in VirtualMap.
638 @param VirtualMap An array of memory descriptors which contain new virtual
639 address mapping information for all runtime ranges. Type
640 EFI_MEMORY_DESCRIPTOR is defined in the
641 GetMemoryMap() function description.
643 @retval EFI_SUCCESS The virtual address map has been applied.
644 @retval EFI_UNSUPPORTED EFI firmware is not at runtime, or the EFI firmware is already in
645 virtual address mapped mode.
646 @retval EFI_INVALID_PARAMETER DescriptorSize or DescriptorVersion is
648 @retval EFI_NO_MAPPING A virtual address was not supplied for a range in the memory
649 map that requires a mapping.
650 @retval EFI_NOT_FOUND A virtual address was supplied for an address that is not found
655 EfiSetVirtualAddressMap (
656 IN UINTN MemoryMapSize
,
657 IN UINTN DescriptorSize
,
658 IN UINT32 DescriptorVersion
,
659 IN CONST EFI_MEMORY_DESCRIPTOR
*VirtualMap
662 return mInternalRT
->SetVirtualAddressMap (
666 (EFI_MEMORY_DESCRIPTOR
*)VirtualMap
671 This service is a wrapper for the UEFI Runtime Service UpdateCapsule().
673 Passes capsules to the firmware with both virtual and physical mapping. Depending on the intended
674 consumption, the firmware may process the capsule immediately. If the payload should persist across a
675 system reset, the reset value returned from EFI_QueryCapsuleCapabilities must be passed into ResetSystem()
676 and will cause the capsule to be processed by the firmware as part of the reset process.
678 @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
679 being passed into update capsule. Each capsules is assumed to
680 stored in contiguous virtual memory. The capsules in the
681 CapsuleHeaderArray must be the same capsules as the
682 ScatterGatherList. The CapsuleHeaderArray must
683 have the capsules in the same order as the ScatterGatherList.
684 @param CapsuleCount The number of pointers to EFI_CAPSULE_HEADER in
686 @param ScatterGatherList Physical pointer to a set of
687 EFI_CAPSULE_BLOCK_DESCRIPTOR that describes the
688 location in physical memory of a set of capsules. See Related
689 Definitions for an explanation of how more than one capsule is
690 passed via this interface. The capsules in the
691 ScatterGatherList must be in the same order as the
692 CapsuleHeaderArray. This parameter is only referenced if
693 the capsules are defined to persist across system reset.
695 @retval EFI_SUCCESS Valid capsule was passed. If CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set,
696 the capsule has been successfully processed by the firmware.
697 @retval EFI_INVALID_PARAMETER CapsuleSize or HeaderSize is NULL.
698 @retval EFI_INVALID_PARAMETER CapsuleCount is 0
699 @retval EFI_DEVICE_ERROR The capsule update was started, but failed due to a device error.
700 @retval EFI_UNSUPPORTED The capsule type is not supported on this platform.
701 @retval EFI_OUT_OF_RESOURCES There were insufficient resources to process the capsule.
707 IN EFI_CAPSULE_HEADER
**CapsuleHeaderArray
,
708 IN UINTN CapsuleCount
,
709 IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL
712 return mInternalRT
->UpdateCapsule (
720 This service is a wrapper for the UEFI Runtime Service QueryCapsuleCapabilities().
722 The QueryCapsuleCapabilities() function allows a caller to test to see if a capsule or
723 capsules can be updated via UpdateCapsule(). The Flags values in the capsule header and
724 size of the entire capsule is checked.
725 If the caller needs to query for generic capsule capability a fake EFI_CAPSULE_HEADER can be
726 constructed where CapsuleImageSize is equal to HeaderSize that is equal to sizeof
727 (EFI_CAPSULE_HEADER). To determine reset requirements,
728 CAPSULE_FLAGS_PERSIST_ACROSS_RESET should be set in the Flags field of the
730 The firmware must support any capsule that has the
731 CAPSULE_FLAGS_PERSIST_ACROSS_RESET flag set in EFI_CAPSULE_HEADER. The
732 firmware sets the policy for what capsules are supported that do not have the
733 CAPSULE_FLAGS_PERSIST_ACROSS_RESET flag set.
735 @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
736 being passed into update capsule. The capsules are assumed to
737 stored in contiguous virtual memory.
738 @param CapsuleCount The number of pointers to EFI_CAPSULE_HEADER in
740 @param MaximumCapsuleSize On output the maximum size that UpdateCapsule() can
741 support as an argument to UpdateCapsule() via
742 CapsuleHeaderArray and ScatterGatherList.
744 @param ResetType Returns the type of reset required for the capsule update.
746 @retval EFI_SUCCESS A valid answer was returned.
747 @retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.
748 @retval EFI_UNSUPPORTED The capsule type is not supported on this platform, and
749 MaximumCapsuleSize and ResetType are undefined.
750 @retval EFI_OUT_OF_RESOURCES There were insufficient resources to process the query request.
755 EfiQueryCapsuleCapabilities (
756 IN EFI_CAPSULE_HEADER
**CapsuleHeaderArray
,
757 IN UINTN CapsuleCount
,
758 OUT UINT64
*MaximumCapsuleSize
,
759 OUT EFI_RESET_TYPE
*ResetType
762 return mInternalRT
->QueryCapsuleCapabilities (
771 This service is a wrapper for the UEFI Runtime Service QueryVariableInfo().
773 The QueryVariableInfo() function allows a caller to obtain the information about the
774 maximum size of the storage space available for the EFI variables, the remaining size of the storage
775 space available for the EFI variables and the maximum size of each individual EFI variable,
776 associated with the attributes specified.
777 The returned MaximumVariableStorageSize, RemainingVariableStorageSize,
778 MaximumVariableSize information may change immediately after the call based on other
779 runtime activities including asynchronous error events. Also, these values associated with different
780 attributes are not additive in nature.
782 @param Attributes Attributes bitmask to specify the type of variables on
783 which to return information. Refer to the
784 GetVariable() function description.
785 @param MaximumVariableStorageSize
786 On output the maximum size of the storage space
787 available for the EFI variables associated with the
788 attributes specified.
789 @param RemainingVariableStorageSize
790 Returns the remaining size of the storage space
791 available for the EFI variables associated with the
792 attributes specified..
793 @param MaximumVariableSize Returns the maximum size of the individual EFI
794 variables associated with the attributes specified.
796 @retval EFI_SUCCESS A valid answer was returned.
797 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied.
798 @retval EFI_UNSUPPORTED EFI_UNSUPPORTED The attribute is not supported on this platform, and the
799 MaximumVariableStorageSize,
800 RemainingVariableStorageSize, MaximumVariableSize
806 EfiQueryVariableInfo (
807 IN UINT32 Attributes
,
808 OUT UINT64
*MaximumVariableStorageSize
,
809 OUT UINT64
*RemainingVariableStorageSize
,
810 OUT UINT64
*MaximumVariableSize
813 return mInternalRT
->QueryVariableInfo (
815 MaximumVariableStorageSize
,
816 RemainingVariableStorageSize
,