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
->CreateEventEx (
99 RuntimeLibVirtualNotifyEvent
,
101 &gEfiEventVirtualAddressChangeGuid
,
102 &mEfiVirtualNotifyEvent
105 ASSERT_EFI_ERROR (Status
);
107 Status
= gBS
->CreateEventEx (
110 RuntimeLibExitBootServicesEvent
,
112 &gEfiEventExitBootServicesGuid
,
113 &mEfiExitBootServicesEvent
116 ASSERT_EFI_ERROR (Status
);
122 If a runtime driver exits with an error, it must call this routine
123 to free the allocated resource before the exiting.
124 It will ASSERT() if gBS is NULL.
125 It will ASSERT() if that operation fails.
127 @param[in] ImageHandle The firmware allocated handle for the EFI image.
128 @param[in] SystemTable A pointer to the EFI System Table.
130 @retval EFI_SUCCESS The Runtime Driver Lib shutdown successfully.
131 @retval EFI_UNSUPPORTED Runtime Driver lib was not initialized.
135 RuntimeDriverLibDeconstruct (
136 IN EFI_HANDLE ImageHandle
,
137 IN EFI_SYSTEM_TABLE
*SystemTable
143 // Close SetVirtualAddressMap () notify function
145 ASSERT (gBS
!= NULL
);
146 Status
= gBS
->CloseEvent (mEfiVirtualNotifyEvent
);
147 ASSERT_EFI_ERROR (Status
);
149 Status
= gBS
->CloseEvent (mEfiExitBootServicesEvent
);
150 ASSERT_EFI_ERROR (Status
);
156 This function allows the caller to determine if UEFI ExitBootServices() has been called.
158 This function returns TRUE after all the EVT_SIGNAL_EXIT_BOOT_SERVICES functions have
159 executed as a result of the OS calling ExitBootServices(). Prior to this time FALSE
160 is returned. This function is used by runtime code to decide it is legal to access
161 services that go away after ExitBootServices().
163 @retval TRUE The system has finished executing the EVT_SIGNAL_EXIT_BOOT_SERVICES event.
164 @retval FALSE The system has not finished executing the EVT_SIGNAL_EXIT_BOOT_SERVICES event.
173 return mEfiAtRuntime
;
177 This function allows the caller to determine if UEFI SetVirtualAddressMap() has been called.
179 This function returns TRUE after all the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE functions have
180 executed as a result of the OS calling SetVirtualAddressMap(). Prior to this time FALSE
181 is returned. This function is used by runtime code to decide it is legal to access services
182 that go away after SetVirtualAddressMap().
184 @retval TRUE The system has finished executing the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.
185 @retval FALSE The system has not finished executing the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.
194 return mEfiGoneVirtual
;
199 This service is a wrapper for the UEFI Runtime Service ResetSystem().
201 The ResetSystem()function resets the entire platform, including all processors and devices,and reboots the system.
202 Calling this interface with ResetType of EfiResetCold causes a system-wide reset. This sets all circuitry within
203 the system to its initial state. This type of reset is asynchronous to system operation and operates without regard
204 to cycle boundaries. EfiResetCold is tantamount to a system power cycle.
205 Calling this interface with ResetType of EfiResetWarm causes a system-wide initialization. The processors are set to
206 their initial state, and pending cycles are not corrupted. If the system does not support this reset type, then an
207 EfiResetCold must be performed.
208 Calling this interface with ResetType of EfiResetShutdown causes the system to enter a power state equivalent to the
209 ACPI G2/S5 or G3 states. If the system does not support this reset type, then when the system is rebooted, it should
210 exhibit the EfiResetCold attributes.
211 The platform may optionally log the parameters from any non-normal reset that occurs.
212 The ResetSystem() function does not return.
214 @param ResetType The type of reset to perform.
215 @param ResetStatus The status code for the reset. If the system reset is part of a normal operation, the status code
216 would be EFI_SUCCESS. If the system reset is due to some type of failure the most appropriate EFI
217 Status code would be used.
218 @param DataSizeThe size, in bytes, of ResetData.
219 @param ResetData For a ResetType of EfiResetCold, EfiResetWarm, or EfiResetShutdown the data buffer starts with a
220 Null-terminated Unicode string, optionally followed by additional binary data. The string is a
221 description that the caller may use to further indicate the reason for the system reset. ResetData
222 is only valid if ResetStatus is something other then EFI_SUCCESS. This pointer must be a physical
223 address. For a ResetType of EfiRestUpdate the data buffer also starts with a Null-terminated string
224 that is followed by a physical VOID * to an EFI_CAPSULE_HEADER.
230 IN EFI_RESET_TYPE ResetType
,
231 IN EFI_STATUS ResetStatus
,
233 IN VOID
*ResetData OPTIONAL
236 mInternalRT
->ResetSystem (ResetType
, ResetStatus
, DataSize
, ResetData
);
241 This service is a wrapper for the UEFI Runtime Service GetTime().
243 The GetTime() function returns a time that was valid sometime during the call to the function.
244 While the returned EFI_TIME structure contains TimeZone and Daylight savings time information,
245 the actual clock does not maintain these values. The current time zone and daylight saving time
246 information returned by GetTime() are the values that were last set via SetTime().
247 The GetTime() function should take approximately the same amount of time to read the time each
248 time it is called. All reported device capabilities are to be rounded up.
249 During runtime, if a PC-AT CMOS device is present in the platform the caller must synchronize
250 access to the device before calling GetTime().
252 @param Time A pointer to storage to receive a snapshot of the current time.
253 @param Capabilities An optional pointer to a buffer to receive the real time clock device's
256 @retval EFI_SUCCESS The operation completed successfully.
257 @retval EFI_INVALID_PARAMETER Time is NULL.
258 @retval EFI_DEVICE_ERROR The time could not be retrieved due to a hardware error.
265 OUT EFI_TIME_CAPABILITIES
*Capabilities OPTIONAL
268 return mInternalRT
->GetTime (Time
, Capabilities
);
273 This service is a wrapper for the UEFI Runtime Service SetTime().
275 The SetTime() function sets the real time clock device to the supplied time, and records the
276 current time zone and daylight savings time information. The SetTime() function is not allowed
277 to loop based on the current time. For example, if the device does not support a hardware reset
278 for the sub-resolution time, the code is not to implement the feature by waiting for the time to
280 During runtime, if a PC-AT CMOS device is present in the platform the caller must synchronize
281 access to the device before calling SetTime().
283 @param Time A pointer to the current time. Type EFI_TIME is defined in the GetTime()
284 function description. Full error checking is performed on the different
285 fields of the EFI_TIME structure (refer to the EFI_TIME definition in the
286 GetTime() function description for full details), and EFI_INVALID_PARAMETER
287 is returned if any field is out of range.
289 @retval EFI_SUCCESS The operation completed successfully.
290 @retval EFI_INVALID_PARAMETER A time field is out of range.
291 @retval EFI_DEVICE_ERROR The time could not be set due to a hardware error.
300 return mInternalRT
->SetTime (Time
);
305 This service is a wrapper for the UEFI Runtime Service GetWakeupTime().
307 The alarm clock time may be rounded from the set alarm clock time to be within the resolution
308 of the alarm clock device. The resolution of the alarm clock device is defined to be one second.
309 During runtime, if a PC-AT CMOS device is present in the platform the caller must synchronize
310 access to the device before calling GetWakeupTime().
312 @param Enabled Indicates if the alarm is currently enabled or disabled.
313 @param Pending Indicates if the alarm signal is pending and requires acknowledgement.
314 @param Time The current alarm setting. Type EFI_TIME is defined in the GetTime()
315 function description.
317 @retval EFI_SUCCESS The alarm settings were returned.
318 @retval EFI_INVALID_PARAMETER Enabled is NULL.
319 @retval EFI_INVALID_PARAMETER Pending is NULL.
320 @retval EFI_INVALID_PARAMETER Time is NULL.
321 @retval EFI_DEVICE_ERROR The wakeup time could not be retrieved due to a hardware error.
322 @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
328 OUT BOOLEAN
*Enabled
,
329 OUT BOOLEAN
*Pending
,
333 return mInternalRT
->GetWakeupTime (Enabled
, Pending
, Time
);
339 This service is a wrapper for the UEFI Runtime Service SetWakeupTime()
341 Setting a system wakeup alarm causes the system to wake up or power on at the set time.
342 When the alarm fires, the alarm signal is latched until it is acknowledged by calling SetWakeupTime()
343 to disable the alarm. If the alarm fires before the system is put into a sleeping or off state,
344 since the alarm signal is latched the system will immediately wake up. If the alarm fires while
345 the system is off and there is insufficient power to power on the system, the system is powered
346 on when power is restored.
348 @param Enable Enable or disable the wakeup alarm.
349 @param Time If Enable is TRUE, the time to set the wakeup alarm for. Type EFI_TIME
350 is defined in the GetTime() function description. If Enable is FALSE,
351 then this parameter is optional, and may be NULL.
353 @retval EFI_SUCCESS If Enable is TRUE, then the wakeup alarm was enabled.
354 If Enable is FALSE, then the wakeup alarm was disabled.
355 @retval EFI_INVALID_PARAMETER A time field is out of range.
356 @retval EFI_DEVICE_ERROR The wakeup time could not be set due to a hardware error.
357 @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
364 IN EFI_TIME
*Time OPTIONAL
367 return mInternalRT
->SetWakeupTime (Enable
, Time
);
372 This service is a wrapper for the UEFI Runtime Service GetVariable().
374 Each vendor may create and manage its own variables without the risk of name conflicts by
375 using a unique VendorGuid. When a variable is set its Attributes are supplied to indicate
376 how the data variable should be stored and maintained by the system. The attributes affect
377 when the variable may be accessed and volatility of the data. Any attempts to access a variable
378 that does not have the attribute set for runtime access will yield the EFI_NOT_FOUND error.
379 If the Data buffer is too small to hold the contents of the variable, the error EFI_BUFFER_TOO_SMALL
380 is returned and DataSize is set to the required buffer size to obtain the data.
382 @param VariableName the name of the vendor's variable, it's a Null-Terminated Unicode String
383 @param VendorGuid Unify identifier for vendor.
384 @param Attributes Point to memory location to return the attributes of variable. If the point
385 is NULL, the parameter would be ignored.
386 @param DataSize As input, point to the maximum size of return Data-Buffer.
387 As output, point to the actual size of the returned Data-Buffer.
388 @param Data Point to return Data-Buffer.
390 @retval EFI_SUCCESS The function completed successfully.
391 @retval EFI_NOT_FOUND The variable was not found.
392 @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result. DataSize has
393 been updated with the size needed to complete the request.
394 @retval EFI_INVALID_PARAMETER VariableName is NULL.
395 @retval EFI_INVALID_PARAMETER VendorGuid is NULL.
396 @retval EFI_INVALID_PARAMETER DataSize is NULL.
397 @retval EFI_INVALID_PARAMETER The DataSize is not too small and Data is NULL.
398 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
399 @retval EFI_SECURITY_VIOLATION The variable could not be retrieved due to an authentication failure.
404 IN CHAR16
*VariableName
,
405 IN EFI_GUID
*VendorGuid
,
406 OUT UINT32
*Attributes OPTIONAL
,
407 IN OUT UINTN
*DataSize
,
411 return mInternalRT
->GetVariable (VariableName
, VendorGuid
, Attributes
, DataSize
, Data
);
416 This service is a wrapper for the UEFI Runtime Service GetNextVariableName().
418 GetNextVariableName() is called multiple times to retrieve the VariableName and VendorGuid of
419 all variables currently available in the system. On each call to GetNextVariableName() the
420 previous results are passed into the interface, and on output the interface returns the next
421 variable name data. When the entire variable list has been returned, the error EFI_NOT_FOUND
424 @param VariableNameSize As input, point to maximum size of variable name.
425 As output, point to actual size of variable name.
426 @param VariableName As input, supplies the last VariableName that was returned by
427 GetNextVariableName().
428 As output, returns the name of variable. The name
429 string is Null-Terminated Unicode string.
430 @param VendorGuid As input, supplies the last VendorGuid that was returned by
431 GetNextVriableName().
432 As output, returns the VendorGuid of the current variable.
434 @retval EFI_SUCCESS The function completed successfully.
435 @retval EFI_NOT_FOUND The next variable was not found.
436 @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.
437 VariableNameSize has been updated with the size needed
438 to complete the request.
439 @retval EFI_INVALID_PARAMETER VariableNameSize is NULL.
440 @retval EFI_INVALID_PARAMETER VariableName is NULL.
441 @retval EFI_INVALID_PARAMETER VendorGuid is NULL.
442 @retval EFI_DEVICE_ERROR The variable name could not be retrieved due to a hardware error.
447 EfiGetNextVariableName (
448 IN OUT UINTN
*VariableNameSize
,
449 IN OUT CHAR16
*VariableName
,
450 IN OUT EFI_GUID
*VendorGuid
453 return mInternalRT
->GetNextVariableName (VariableNameSize
, VariableName
, VendorGuid
);
458 This service is a wrapper for the UEFI Runtime Service GetNextVariableName()
460 Variables are stored by the firmware and may maintain their values across power cycles. Each vendor
461 may create and manage its own variables without the risk of name conflicts by using a unique VendorGuid.
463 @param VariableName The name of the vendor's variable; it's a Null-Terminated
465 @param VendorGuid Unify identifier for vendor.
466 @param Attributes Points to a memory location to return the attributes of variable. If the point
467 is NULL, the parameter would be ignored.
468 @param DataSize The size in bytes of Data-Buffer.
469 @param Data Points to the content of the variable.
471 @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as
472 defined by the Attributes.
473 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied, or the
474 DataSize exceeds the maximum allowed.
475 @retval EFI_INVALID_PARAMETER VariableName is an empty Unicode string.
476 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
477 @retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure.
478 @retval EFI_WRITE_PROTECTED The variable in question is read-only.
479 @retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.
480 @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
481 set but the AuthInfo does NOT pass the validation check carried
483 @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.
489 IN CHAR16
*VariableName
,
490 IN EFI_GUID
*VendorGuid
,
491 IN UINT32 Attributes
,
496 return mInternalRT
->SetVariable (VariableName
, VendorGuid
, Attributes
, DataSize
, Data
);
501 This service is a wrapper for the UEFI Runtime Service GetNextHighMonotonicCount().
503 The platform's monotonic counter is comprised of two 32-bit quantities: the high 32 bits and
504 the low 32 bits. During boot service time the low 32-bit value is volatile: it is reset to zero
505 on every system reset and is increased by 1 on every call to GetNextMonotonicCount(). The high
506 32-bit value is nonvolatile and is increased by 1 whenever the system resets or whenever the low
507 32-bit count (returned by GetNextMonoticCount()) overflows.
509 @param HighCount The pointer to returned value.
511 @retval EFI_SUCCESS The next high monotonic count was returned.
512 @retval EFI_DEVICE_ERROR The device is not functioning properly.
513 @retval EFI_INVALID_PARAMETER HighCount is NULL.
518 EfiGetNextHighMonotonicCount (
519 OUT UINT32
*HighCount
522 return mInternalRT
->GetNextHighMonotonicCount (HighCount
);
527 This service is a wrapper for the UEFI Runtime Service ConvertPointer().
529 The ConvertPointer() function is used by an EFI component during the SetVirtualAddressMap() operation.
530 ConvertPointer()must be called using physical address pointers during the execution of SetVirtualAddressMap().
532 @param DebugDisposition Supplies type information for the pointer being converted.
533 @param Address The pointer to a pointer that is to be fixed to be the
534 value needed for the new virtual address mapping being
537 @retval EFI_SUCCESS The pointer pointed to by Address was modified.
538 @retval EFI_NOT_FOUND The pointer pointed to by Address was not found to be part of
539 the current memory map. This is normally fatal.
540 @retval EFI_INVALID_PARAMETER Address is NULL.
541 @retval EFI_INVALID_PARAMETER *Address is NULL and DebugDispositio
547 IN UINTN DebugDisposition
,
548 IN OUT VOID
**Address
551 return gRT
->ConvertPointer (DebugDisposition
, Address
);
556 Determines the new virtual address that is to be used on subsequent memory accesses.
558 For IA32, x64, and EBC, this service is a wrapper for the UEFI Runtime Service
559 ConvertPointer(). See the UEFI Specification for details.
560 For IPF, this function interprets Address as a pointer to an EFI_PLABEL structure
561 and both the EntryPoint and GP fields of an EFI_PLABEL are converted from physical
562 to virtiual addressing. Since IPF allows the GP to point to an address outside
563 a PE/COFF image, the physical to virtual offset for the EntryPoint field is used
564 to adjust the GP field. The UEFI Runtime Service ConvertPointer() is used to convert
565 EntryPoint and the status code for this conversion is always returned. If the convertion
566 of EntryPoint fails, then neither EntryPoint nor GP are modified. See the UEFI
567 Specification for details on the UEFI Runtime Service ConvertPointer().
569 @param DebugDisposition Supplies type information for the pointer being converted.
570 @param Address The pointer to a pointer that is to be fixed to be the
571 value needed for the new virtual address mapping being
574 @return EFI_STATUS value from EfiConvertPointer().
579 EfiConvertFunctionPointer (
580 IN UINTN DebugDisposition
,
581 IN OUT VOID
**Address
584 return EfiConvertPointer (DebugDisposition
, Address
);
589 Convert the standard Lib double linked list to a virtual mapping.
591 This service uses EfiConvertPointer() to walk a double linked list and convert all the link
592 pointers to their virtual mappings. This function is only guaranteed to work during the
593 EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event and calling it at other times has undefined results.
595 @param DebugDisposition Supplies type information for the pointer being converted.
596 @param ListHead Head of linked list to convert.
598 @retval EFI_SUCCESS Success to execute the function.
599 @retval !EFI_SUCCESS Failed to e3xecute the function.
605 IN UINTN DebugDisposition
,
606 IN OUT LIST_ENTRY
*ListHead
610 LIST_ENTRY
*NextLink
;
613 // For NULL List, return EFI_SUCCESS
615 if (ListHead
== NULL
) {
620 // Convert all the ForwardLink & BackLink pointers in the list
624 NextLink
= Link
->ForwardLink
;
627 Link
->ForwardLink
== ListHead
? DebugDisposition
: 0,
628 (VOID
**) &Link
->ForwardLink
632 Link
->BackLink
== ListHead
? DebugDisposition
: 0,
633 (VOID
**) &Link
->BackLink
637 } while (Link
!= ListHead
);
643 This service is a wrapper for the UEFI Runtime Service SetVirtualAddressMap().
645 The SetVirtualAddressMap() function is used by the OS loader. The function can only be called
646 at runtime, and is called by the owner of the system's memory map. I.e., the component which
647 called ExitBootServices(). All events of type EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE must be signaled
648 before SetVirtualAddressMap() returns.
650 @param MemoryMapSize The size in bytes of VirtualMap.
651 @param DescriptorSize The size in bytes of an entry in the VirtualMap.
652 @param DescriptorVersion The version of the structure entries in VirtualMap.
653 @param VirtualMap An array of memory descriptors which contain new virtual
654 address mapping information for all runtime ranges. Type
655 EFI_MEMORY_DESCRIPTOR is defined in the
656 GetMemoryMap() function description.
658 @retval EFI_SUCCESS The virtual address map has been applied.
659 @retval EFI_UNSUPPORTED EFI firmware is not at runtime, or the EFI firmware is already in
660 virtual address mapped mode.
661 @retval EFI_INVALID_PARAMETER DescriptorSize or DescriptorVersion is
663 @retval EFI_NO_MAPPING A virtual address was not supplied for a range in the memory
664 map that requires a mapping.
665 @retval EFI_NOT_FOUND A virtual address was supplied for an address that is not found
670 EfiSetVirtualAddressMap (
671 IN UINTN MemoryMapSize
,
672 IN UINTN DescriptorSize
,
673 IN UINT32 DescriptorVersion
,
674 IN CONST EFI_MEMORY_DESCRIPTOR
*VirtualMap
677 return mInternalRT
->SetVirtualAddressMap (
681 (EFI_MEMORY_DESCRIPTOR
*) VirtualMap
687 This service is a wrapper for the UEFI Runtime Service UpdateCapsule().
689 Passes capsules to the firmware with both virtual and physical mapping. Depending on the intended
690 consumption, the firmware may process the capsule immediately. If the payload should persist across a
691 system reset, the reset value returned from EFI_QueryCapsuleCapabilities must be passed into ResetSystem()
692 and will cause the capsule to be processed by the firmware as part of the reset process.
694 @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
695 being passed into update capsule. Each capsules is assumed to
696 stored in contiguous virtual memory. The capsules in the
697 CapsuleHeaderArray must be the same capsules as the
698 ScatterGatherList. The CapsuleHeaderArray must
699 have the capsules in the same order as the ScatterGatherList.
700 @param CapsuleCount The number of pointers to EFI_CAPSULE_HEADER in
702 @param ScatterGatherList Physical pointer to a set of
703 EFI_CAPSULE_BLOCK_DESCRIPTOR that describes the
704 location in physical memory of a set of capsules. See Related
705 Definitions for an explanation of how more than one capsule is
706 passed via this interface. The capsules in the
707 ScatterGatherList must be in the same order as the
708 CapsuleHeaderArray. This parameter is only referenced if
709 the capsules are defined to persist across system reset.
711 @retval EFI_SUCCESS Valid capsule was passed. If CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set,
712 the capsule has been successfully processed by the firmware.
713 @retval EFI_INVALID_PARAMETER CapsuleSize or HeaderSize is NULL.
714 @retval EFI_INVALID_PARAMETER CapsuleCount is 0
715 @retval EFI_DEVICE_ERROR The capsule update was started, but failed due to a device error.
716 @retval EFI_UNSUPPORTED The capsule type is not supported on this platform.
717 @retval EFI_OUT_OF_RESOURCES There were insufficient resources to process the capsule.
723 IN EFI_CAPSULE_HEADER
**CapsuleHeaderArray
,
724 IN UINTN CapsuleCount
,
725 IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL
728 return mInternalRT
->UpdateCapsule (
737 This service is a wrapper for the UEFI Runtime Service QueryCapsuleCapabilities().
739 The QueryCapsuleCapabilities() function allows a caller to test to see if a capsule or
740 capsules can be updated via UpdateCapsule(). The Flags values in the capsule header and
741 size of the entire capsule is checked.
742 If the caller needs to query for generic capsule capability a fake EFI_CAPSULE_HEADER can be
743 constructed where CapsuleImageSize is equal to HeaderSize that is equal to sizeof
744 (EFI_CAPSULE_HEADER). To determine reset requirements,
745 CAPSULE_FLAGS_PERSIST_ACROSS_RESET should be set in the Flags field of the
747 The firmware must support any capsule that has the
748 CAPSULE_FLAGS_PERSIST_ACROSS_RESET flag set in EFI_CAPSULE_HEADER. The
749 firmware sets the policy for what capsules are supported that do not have the
750 CAPSULE_FLAGS_PERSIST_ACROSS_RESET flag set.
752 @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
753 being passed into update capsule. The capsules are assumed to
754 stored in contiguous virtual memory.
755 @param CapsuleCount The number of pointers to EFI_CAPSULE_HEADER in
757 @param MaximumCapsuleSize On output the maximum size that UpdateCapsule() can
758 support as an argument to UpdateCapsule() via
759 CapsuleHeaderArray and ScatterGatherList.
761 @param ResetType Returns the type of reset required for the capsule update.
763 @retval EFI_SUCCESS A valid answer was returned.
764 @retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.
765 @retval EFI_UNSUPPORTED The capsule type is not supported on this platform, and
766 MaximumCapsuleSize and ResetType are undefined.
767 @retval EFI_OUT_OF_RESOURCES There were insufficient resources to process the query request.
772 EfiQueryCapsuleCapabilities (
773 IN EFI_CAPSULE_HEADER
**CapsuleHeaderArray
,
774 IN UINTN CapsuleCount
,
775 OUT UINT64
*MaximumCapsuleSize
,
776 OUT EFI_RESET_TYPE
*ResetType
779 return mInternalRT
->QueryCapsuleCapabilities (
789 This service is a wrapper for the UEFI Runtime Service QueryVariableInfo().
791 The QueryVariableInfo() function allows a caller to obtain the information about the
792 maximum size of the storage space available for the EFI variables, the remaining size of the storage
793 space available for the EFI variables and the maximum size of each individual EFI variable,
794 associated with the attributes specified.
795 The returned MaximumVariableStorageSize, RemainingVariableStorageSize,
796 MaximumVariableSize information may change immediately after the call based on other
797 runtime activities including asynchronous error events. Also, these values associated with different
798 attributes are not additive in nature.
800 @param Attributes Attributes bitmask to specify the type of variables on
801 which to return information. Refer to the
802 GetVariable() function description.
803 @param MaximumVariableStorageSize
804 On output the maximum size of the storage space
805 available for the EFI variables associated with the
806 attributes specified.
807 @param RemainingVariableStorageSize
808 Returns the remaining size of the storage space
809 available for the EFI variables associated with the
810 attributes specified..
811 @param MaximumVariableSize Returns the maximum size of the individual EFI
812 variables associated with the attributes specified.
814 @retval EFI_SUCCESS A valid answer was returned.
815 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied.
816 @retval EFI_UNSUPPORTED EFI_UNSUPPORTED The attribute is not supported on this platform, and the
817 MaximumVariableStorageSize,
818 RemainingVariableStorageSize, MaximumVariableSize
824 EfiQueryVariableInfo (
825 IN UINT32 Attributes
,
826 OUT UINT64
*MaximumVariableStorageSize
,
827 OUT UINT64
*RemainingVariableStorageSize
,
828 OUT UINT64
*MaximumVariableSize
831 return mInternalRT
->QueryVariableInfo (
833 MaximumVariableStorageSize
,
834 RemainingVariableStorageSize
,