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 - 2009 Intel Corporation. <BR>
10 All rights reserved. This program and the accompanying materials
11 are licensed and made available under the terms and conditions of the BSD License
12 which accompanies this distribution. The full text of the license may be found at
13 http://opensource.org/licenses/bsd-license.php
15 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
16 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
21 #include <Library/UefiRuntimeLib.h>
22 #include <Library/DebugLib.h>
23 #include <Library/UefiBootServicesTableLib.h>
24 #include <Library/UefiRuntimeServicesTableLib.h>
25 #include <Guid/EventGroup.h>
28 /// Driver Lib Module Globals
30 EFI_EVENT mEfiVirtualNotifyEvent
;
31 EFI_EVENT mEfiExitBootServicesEvent
;
32 BOOLEAN mEfiGoneVirtual
= FALSE
;
33 BOOLEAN mEfiAtRuntime
= FALSE
;
34 EFI_RUNTIME_SERVICES
*mInternalRT
;
37 Set AtRuntime flag as TRUE after ExitBootServices.
39 @param[in] Event The Event that is being processed
40 @param[in] Context Event Context
45 RuntimeLibExitBootServicesEvent (
51 // Clear out BootService globals
59 Fixup internal data so that EFI can be call in virtual mode.
60 Call the passed in Child Notify event and convert any pointers in
63 @param[in] Event The Event that is being processed
64 @param[in] Context Event Context
68 RuntimeLibVirtualNotifyEvent (
74 // Update global for Runtime Services Table and IO
76 EfiConvertPointer (0, (VOID
**) &mInternalRT
);
78 mEfiGoneVirtual
= TRUE
;
82 Initialize runtime Driver Lib if it has not yet been initialized.
83 It will ASSERT() if gRT is NULL or gBS is NULL.
84 It will ASSERT() if that operation fails.
86 @param[in] ImageHandle The firmware allocated handle for the EFI image.
87 @param[in] SystemTable A pointer to the EFI System Table.
89 @return EFI_STATUS always returns EFI_SUCCESS except EFI_ALREADY_STARTED if already started.
93 RuntimeDriverLibConstruct (
94 IN EFI_HANDLE ImageHandle
,
95 IN EFI_SYSTEM_TABLE
*SystemTable
100 ASSERT (gRT
!= NULL
);
101 ASSERT (gBS
!= NULL
);
105 // Register SetVirtualAddressMap () notify function
107 Status
= gBS
->CreateEventEx (
110 RuntimeLibVirtualNotifyEvent
,
112 &gEfiEventVirtualAddressChangeGuid
,
113 &mEfiVirtualNotifyEvent
116 ASSERT_EFI_ERROR (Status
);
118 Status
= gBS
->CreateEventEx (
121 RuntimeLibExitBootServicesEvent
,
123 &gEfiEventExitBootServicesGuid
,
124 &mEfiExitBootServicesEvent
127 ASSERT_EFI_ERROR (Status
);
133 If a runtime driver exits with an error, it must call this routine
134 to free the allocated resource before the exiting.
135 It will ASSERT() if gBS is NULL.
136 It will ASSERT() if that operation fails.
138 @param[in] ImageHandle The firmware allocated handle for the EFI image.
139 @param[in] SystemTable A pointer to the EFI System Table.
141 @retval EFI_SUCCESS Shutdown the Runtime Driver Lib successfully
142 @retval EFI_UNSUPPORTED Runtime Driver lib was not initialized at all
146 RuntimeDriverLibDeconstruct (
147 IN EFI_HANDLE ImageHandle
,
148 IN EFI_SYSTEM_TABLE
*SystemTable
154 // Close SetVirtualAddressMap () notify function
156 ASSERT (gBS
!= NULL
);
157 Status
= gBS
->CloseEvent (mEfiVirtualNotifyEvent
);
158 ASSERT_EFI_ERROR (Status
);
160 Status
= gBS
->CloseEvent (mEfiExitBootServicesEvent
);
161 ASSERT_EFI_ERROR (Status
);
167 This function allows the caller to determine if UEFI ExitBootServices() has been called.
169 This function returns TRUE after all the EVT_SIGNAL_EXIT_BOOT_SERVICES functions have
170 executed as a result of the OS calling ExitBootServices(). Prior to this time FALSE
171 is returned. This function is used by runtime code to decide it is legal to access
172 services that go away after ExitBootServices().
174 @retval TRUE The system has finished executing the EVT_SIGNAL_EXIT_BOOT_SERVICES event.
175 @retval FALSE The system has not finished executing the EVT_SIGNAL_EXIT_BOOT_SERVICES event.
184 return mEfiAtRuntime
;
188 This function allows the caller to determine if UEFI SetVirtualAddressMap() has been called.
190 This function returns TRUE after all the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE functions have
191 executed as a result of the OS calling SetVirtualAddressMap(). Prior to this time FALSE
192 is returned. This function is used by runtime code to decide it is legal to access services
193 that go away after SetVirtualAddressMap().
195 @retval TRUE The system has finished executing the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.
196 @retval FALSE The system has not finished executing the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.
205 return mEfiGoneVirtual
;
210 This service is a wrapper for the UEFI Runtime Service ResetSystem().
212 The ResetSystem()function resets the entire platform, including all processors and devices,and reboots the system.
213 Calling this interface with ResetType of EfiResetCold causes a system-wide reset. This sets all circuitry within
214 the system to its initial state. This type of reset is asynchronous to system operation and operates without regard
215 to cycle boundaries. EfiResetCold is tantamount to a system power cycle.
216 Calling this interface with ResetType of EfiResetWarm causes a system-wide initialization. The processors are set to
217 their initial state, and pending cycles are not corrupted. If the system does not support this reset type, then an
218 EfiResetCold must be performed.
219 Calling this interface with ResetType of EfiResetShutdown causes the system to enter a power state equivalent to the
220 ACPI G2/S5 or G3 states. If the system does not support this reset type, then when the system is rebooted, it should
221 exhibit the EfiResetCold attributes.
222 The platform may optionally log the parameters from any non-normal reset that occurs.
223 The ResetSystem() function does not return.
225 @param ResetType The type of reset to perform.
226 @param ResetStatus The status code for the reset. If the system reset is part of a normal operation, the status code
227 would be EFI_SUCCESS. If the system reset is due to some type of failure the most appropriate EFI
228 Status code would be used.
229 @param DataSizeThe size, in bytes, of ResetData.
230 @param ResetData For a ResetType of EfiResetCold, EfiResetWarm, or EfiResetShutdown the data buffer starts with a
231 Null-terminated Unicode string, optionally followed by additional binary data. The string is a
232 description that the caller may use to further indicate the reason for the system reset. ResetData
233 is only valid if ResetStatus is something other then EFI_SUCCESS. This pointer must be a physical
234 address. For a ResetType of EfiRestUpdate the data buffer also starts with a Null-terminated string
235 that is followed by a physical VOID * to an EFI_CAPSULE_HEADER.
241 IN EFI_RESET_TYPE ResetType
,
242 IN EFI_STATUS ResetStatus
,
244 IN VOID
*ResetData OPTIONAL
247 mInternalRT
->ResetSystem (ResetType
, ResetStatus
, DataSize
, ResetData
);
252 This service is a wrapper for the UEFI Runtime Service GetTime().
254 The GetTime() function returns a time that was valid sometime during the call to the function.
255 While the returned EFI_TIME structure contains TimeZone and Daylight savings time information,
256 the actual clock does not maintain these values. The current time zone and daylight saving time
257 information returned by GetTime() are the values that were last set via SetTime().
258 The GetTime() function should take approximately the same amount of time to read the time each
259 time it is called. All reported device capabilities are to be rounded up.
260 During runtime, if a PC-AT CMOS device is present in the platform the caller must synchronize
261 access to the device before calling GetTime().
263 @param Time A pointer to storage to receive a snapshot of the current time.
264 @param Capabilities An optional pointer to a buffer to receive the real time clock device's
267 @retval EFI_SUCCESS The operation completed successfully.
268 @retval EFI_INVALID_PARAMETER Time is NULL.
269 @retval EFI_DEVICE_ERROR The time could not be retrieved due to a hardware error.
276 OUT EFI_TIME_CAPABILITIES
*Capabilities OPTIONAL
279 return mInternalRT
->GetTime (Time
, Capabilities
);
284 This service is a wrapper for the UEFI Runtime Service SetTime().
286 The SetTime() function sets the real time clock device to the supplied time, and records the
287 current time zone and daylight savings time information. The SetTime() function is not allowed
288 to loop based on the current time. For example, if the device does not support a hardware reset
289 for the sub-resolution time, the code is not to implement the feature by waiting for the time to
291 During runtime, if a PC-AT CMOS device is present in the platform the caller must synchronize
292 access to the device before calling SetTime().
294 @param Time A pointer to the current time. Type EFI_TIME is defined in the GetTime()
295 function description. Full error checking is performed on the different
296 fields of the EFI_TIME structure (refer to the EFI_TIME definition in the
297 GetTime() function description for full details), and EFI_INVALID_PARAMETER
298 is returned if any field is out of range.
300 @retval EFI_SUCCESS The operation completed successfully.
301 @retval EFI_INVALID_PARAMETER A time field is out of range.
302 @retval EFI_DEVICE_ERROR The time could not be set due to a hardware error.
311 return mInternalRT
->SetTime (Time
);
316 This service is a wrapper for the UEFI Runtime Service GetWakeupTime().
318 The alarm clock time may be rounded from the set alarm clock time to be within the resolution
319 of the alarm clock device. The resolution of the alarm clock device is defined to be one second.
320 During runtime, if a PC-AT CMOS device is present in the platform the caller must synchronize
321 access to the device before calling GetWakeupTime().
323 @param Enabled Indicates if the alarm is currently enabled or disabled.
324 @param Pending Indicates if the alarm signal is pending and requires acknowledgement.
325 @param Time The current alarm setting. Type EFI_TIME is defined in the GetTime()
326 function description.
328 @retval EFI_SUCCESS The alarm settings were returned.
329 @retval EFI_INVALID_PARAMETER Enabled is NULL.
330 @retval EFI_INVALID_PARAMETER Pending is NULL.
331 @retval EFI_INVALID_PARAMETER Time is NULL.
332 @retval EFI_DEVICE_ERROR The wakeup time could not be retrieved due to a hardware error.
333 @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
339 OUT BOOLEAN
*Enabled
,
340 OUT BOOLEAN
*Pending
,
344 return mInternalRT
->GetWakeupTime (Enabled
, Pending
, Time
);
350 This service is a wrapper for the UEFI Runtime Service SetWakeupTime()
352 Setting a system wakeup alarm causes the system to wake up or power on at the set time.
353 When the alarm fires, the alarm signal is latched until it is acknowledged by calling SetWakeupTime()
354 to disable the alarm. If the alarm fires before the system is put into a sleeping or off state,
355 since the alarm signal is latched the system will immediately wake up. If the alarm fires while
356 the system is off and there is insufficient power to power on the system, the system is powered
357 on when power is restored.
359 @param Enable Enable or disable the wakeup alarm.
360 @param Time If Enable is TRUE, the time to set the wakeup alarm for. Type EFI_TIME
361 is defined in the GetTime() function description. If Enable is FALSE,
362 then this parameter is optional, and may be NULL.
364 @retval EFI_SUCCESS If Enable is TRUE, then the wakeup alarm was enabled.
365 If Enable is FALSE, then the wakeup alarm was disabled.
366 @retval EFI_INVALID_PARAMETER A time field is out of range.
367 @retval EFI_DEVICE_ERROR The wakeup time could not be set due to a hardware error.
368 @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.
375 IN EFI_TIME
*Time OPTIONAL
378 return mInternalRT
->SetWakeupTime (Enable
, Time
);
383 This service is a wrapper for the UEFI Runtime Service GetVariable().
385 Each vendor may create and manage its own variables without the risk of name conflicts by
386 using a unique VendorGuid. When a variable is set its Attributes are supplied to indicate
387 how the data variable should be stored and maintained by the system. The attributes affect
388 when the variable may be accessed and volatility of the data. Any attempts to access a variable
389 that does not have the attribute set for runtime access will yield the EFI_NOT_FOUND error.
390 If the Data buffer is too small to hold the contents of the variable, the error EFI_BUFFER_TOO_SMALL
391 is returned and DataSize is set to the required buffer size to obtain the data.
393 @param VariableName the name of the vendor's variable, it's a Null-Terminated Unicode String
394 @param VendorGuid Unify identifier for vendor.
395 @param Attributes Point to memory location to return the attributes of variable. If the point
396 is NULL, the parameter would be ignored.
397 @param DataSize As input, point to the maximum size of return Data-Buffer.
398 As output, point to the actual size of the returned Data-Buffer.
399 @param Data Point to return Data-Buffer.
401 @retval EFI_SUCCESS The function completed successfully.
402 @retval EFI_NOT_FOUND The variable was not found.
403 @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result. DataSize has
404 been updated with the size needed to complete the request.
405 @retval EFI_INVALID_PARAMETER VariableName is NULL.
406 @retval EFI_INVALID_PARAMETER VendorGuid is NULL.
407 @retval EFI_INVALID_PARAMETER DataSize is NULL.
408 @retval EFI_INVALID_PARAMETER The DataSize is not too small and Data is NULL.
409 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
410 @retval EFI_SECURITY_VIOLATION The variable could not be retrieved due to an authentication failure.
415 IN CHAR16
*VariableName
,
416 IN EFI_GUID
*VendorGuid
,
417 OUT UINT32
*Attributes OPTIONAL
,
418 IN OUT UINTN
*DataSize
,
422 return mInternalRT
->GetVariable (VariableName
, VendorGuid
, Attributes
, DataSize
, Data
);
427 This service is a wrapper for the UEFI Runtime Service GetNextVariableName().
429 GetNextVariableName() is called multiple times to retrieve the VariableName and VendorGuid of
430 all variables currently available in the system. On each call to GetNextVariableName() the
431 previous results are passed into the interface, and on output the interface returns the next
432 variable name data. When the entire variable list has been returned, the error EFI_NOT_FOUND
435 @param VariableNameSize As input, point to maximum size of variable name.
436 As output, point to actual size of variable name.
437 @param VariableName As input, supplies the last VariableName that was returned by
438 GetNextVariableName().
439 As output, returns the name of variable. The name
440 string is Null-Terminated Unicode string.
441 @param VendorGuid As input, supplies the last VendorGuid that was returned by
442 GetNextVriableName().
443 As output, returns the VendorGuid of the current variable.
445 @retval EFI_SUCCESS The function completed successfully.
446 @retval EFI_NOT_FOUND The next variable was not found.
447 @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.
448 VariableNameSize has been updated with the size needed
449 to complete the request.
450 @retval EFI_INVALID_PARAMETER VariableNameSize is NULL.
451 @retval EFI_INVALID_PARAMETER VariableName is NULL.
452 @retval EFI_INVALID_PARAMETER VendorGuid is NULL.
453 @retval EFI_DEVICE_ERROR The variable name could not be retrieved due to a hardware error.
458 EfiGetNextVariableName (
459 IN OUT UINTN
*VariableNameSize
,
460 IN OUT CHAR16
*VariableName
,
461 IN OUT EFI_GUID
*VendorGuid
464 return mInternalRT
->GetNextVariableName (VariableNameSize
, VariableName
, VendorGuid
);
469 This service is a wrapper for the UEFI Runtime Service GetNextVariableName()
471 Variables are stored by the firmware and may maintain their values across power cycles. Each vendor
472 may create and manage its own variables without the risk of name conflicts by using a unique VendorGuid.
474 @param VariableName the name of the vendor's variable, it's a
475 Null-Terminated Unicode String
476 @param VendorGuid Unify identifier for vendor.
477 @param Attributes Point to memory location to return the attributes of variable. If the point
478 is NULL, the parameter would be ignored.
479 @param DataSize The size in bytes of Data-Buffer.
480 @param Data Point to the content of the variable.
482 @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as
483 defined by the Attributes.
484 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied, or the
485 DataSize exceeds the maximum allowed.
486 @retval EFI_INVALID_PARAMETER VariableName is an empty Unicode string.
487 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
488 @retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure.
489 @retval EFI_WRITE_PROTECTED The variable in question is read-only.
490 @retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.
491 @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS
492 set but the AuthInfo does NOT pass the validation check carried
494 @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.
500 IN CHAR16
*VariableName
,
501 IN EFI_GUID
*VendorGuid
,
502 IN UINT32 Attributes
,
507 return mInternalRT
->SetVariable (VariableName
, VendorGuid
, Attributes
, DataSize
, Data
);
512 This service is a wrapper for the UEFI Runtime Service GetNextHighMonotonicCount().
514 The platform's monotonic counter is comprised of two 32-bit quantities: the high 32 bits and
515 the low 32 bits. During boot service time the low 32-bit value is volatile: it is reset to zero
516 on every system reset and is increased by 1 on every call to GetNextMonotonicCount(). The high
517 32-bit value is nonvolatile and is increased by 1 whenever the system resets or whenever the low
518 32-bit count (returned by GetNextMonoticCount()) overflows.
520 @param HighCount Pointer to returned value.
522 @retval EFI_SUCCESS The next high monotonic count was returned.
523 @retval EFI_DEVICE_ERROR The device is not functioning properly.
524 @retval EFI_INVALID_PARAMETER HighCount is NULL.
529 EfiGetNextHighMonotonicCount (
530 OUT UINT32
*HighCount
533 return mInternalRT
->GetNextHighMonotonicCount (HighCount
);
538 This service is a wrapper for the UEFI Runtime Service ConvertPointer().
540 The ConvertPointer() function is used by an EFI component during the SetVirtualAddressMap() operation.
541 ConvertPointer()must be called using physical address pointers during the execution of SetVirtualAddressMap().
543 @param DebugDisposition Supplies type information for the pointer being converted.
544 @param Address The pointer to a pointer that is to be fixed to be the
545 value needed for the new virtual address mapping being
548 @retval EFI_SUCCESS The pointer pointed to by Address was modified.
549 @retval EFI_NOT_FOUND The pointer pointed to by Address was not found to be part of
550 the current memory map. This is normally fatal.
551 @retval EFI_INVALID_PARAMETER Address is NULL.
552 @retval EFI_INVALID_PARAMETER *Address is NULL and DebugDispositio
558 IN UINTN DebugDisposition
,
559 IN OUT VOID
**Address
562 return gRT
->ConvertPointer (DebugDisposition
, Address
);
567 Determines the new virtual address that is to be used on subsequent memory accesses.
569 For IA32, x64, and EBC, this service is a wrapper for the UEFI Runtime Service
570 ConvertPointer(). See the UEFI Specification for details.
571 For IPF, this function interprets Address as a pointer to an EFI_PLABEL structure
572 and both the EntryPoint and GP fields of an EFI_PLABEL are converted from physical
573 to virtiual addressing. Since IPF allows the GP to point to an address outside
574 a PE/COFF image, the physical to virtual offset for the EntryPoint field is used
575 to adjust the GP field. The UEFI Runtime Service ConvertPointer() is used to convert
576 EntryPoint and the status code for this conversion is always returned. If the convertion
577 of EntryPoint fails, then neither EntryPoint nor GP are modified. See the UEFI
578 Specification for details on the UEFI Runtime Service ConvertPointer().
580 @param DebugDisposition Supplies type information for the pointer being converted.
581 @param Address The pointer to a pointer that is to be fixed to be the
582 value needed for the new virtual address mapping being
585 @return EFI_STATUS value from EfiConvertPointer().
590 EfiConvertFunctionPointer (
591 IN UINTN DebugDisposition
,
592 IN OUT VOID
**Address
595 return EfiConvertPointer (DebugDisposition
, Address
);
600 Convert the standard Lib double linked list to a virtual mapping.
602 This service uses EfiConvertPointer() to walk a double linked list and convert all the link
603 pointers to their virtual mappings. This function is only guaranteed to work during the
604 EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event and calling it at other times has undefined results.
606 @param DebugDisposition Supplies type information for the pointer being converted.
607 @param ListHead Head of linked list to convert.
609 @retval EFI_SUCCESS Success to execute the function.
610 @retval !EFI_SUCCESS Failed to e3xecute the function.
616 IN UINTN DebugDisposition
,
617 IN OUT LIST_ENTRY
*ListHead
621 LIST_ENTRY
*NextLink
;
624 // For NULL List, return EFI_SUCCESS
626 if (ListHead
== NULL
) {
631 // Convert all the ForwardLink & BackLink pointers in the list
635 NextLink
= Link
->ForwardLink
;
638 Link
->ForwardLink
== ListHead
? DebugDisposition
: 0,
639 (VOID
**) &Link
->ForwardLink
643 Link
->BackLink
== ListHead
? DebugDisposition
: 0,
644 (VOID
**) &Link
->BackLink
648 } while (Link
!= ListHead
);
654 This service is a wrapper for the UEFI Runtime Service SetVirtualAddressMap().
656 The SetVirtualAddressMap() function is used by the OS loader. The function can only be called
657 at runtime, and is called by the owner of the system's memory map. I.e., the component which
658 called ExitBootServices(). All events of type EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE must be signaled
659 before SetVirtualAddressMap() returns.
661 @param MemoryMapSize The size in bytes of VirtualMap.
662 @param DescriptorSize The size in bytes of an entry in the VirtualMap.
663 @param DescriptorVersion The version of the structure entries in VirtualMap.
664 @param VirtualMap An array of memory descriptors which contain new virtual
665 address mapping information for all runtime ranges. Type
666 EFI_MEMORY_DESCRIPTOR is defined in the
667 GetMemoryMap() function description.
669 @retval EFI_SUCCESS The virtual address map has been applied.
670 @retval EFI_UNSUPPORTED EFI firmware is not at runtime, or the EFI firmware is already in
671 virtual address mapped mode.
672 @retval EFI_INVALID_PARAMETER DescriptorSize or DescriptorVersion is
674 @retval EFI_NO_MAPPING A virtual address was not supplied for a range in the memory
675 map that requires a mapping.
676 @retval EFI_NOT_FOUND A virtual address was supplied for an address that is not found
681 EfiSetVirtualAddressMap (
682 IN UINTN MemoryMapSize
,
683 IN UINTN DescriptorSize
,
684 IN UINT32 DescriptorVersion
,
685 IN CONST EFI_MEMORY_DESCRIPTOR
*VirtualMap
688 return mInternalRT
->SetVirtualAddressMap (
692 (EFI_MEMORY_DESCRIPTOR
*) VirtualMap
698 This service is a wrapper for the UEFI Runtime Service UpdateCapsule().
700 Passes capsules to the firmware with both virtual and physical mapping. Depending on the intended
701 consumption, the firmware may process the capsule immediately. If the payload should persist across a
702 system reset, the reset value returned from EFI_QueryCapsuleCapabilities must be passed into ResetSystem()
703 and will cause the capsule to be processed by the firmware as part of the reset process.
705 @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
706 being passed into update capsule. Each capsules is assumed to
707 stored in contiguous virtual memory. The capsules in the
708 CapsuleHeaderArray must be the same capsules as the
709 ScatterGatherList. The CapsuleHeaderArray must
710 have the capsules in the same order as the ScatterGatherList.
711 @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
713 @param ScatterGatherList Physical pointer to a set of
714 EFI_CAPSULE_BLOCK_DESCRIPTOR that describes the
715 location in physical memory of a set of capsules. See Related
716 Definitions for an explanation of how more than one capsule is
717 passed via this interface. The capsules in the
718 ScatterGatherList must be in the same order as the
719 CapsuleHeaderArray. This parameter is only referenced if
720 the capsules are defined to persist across system reset.
722 @retval EFI_SUCCESS Valid capsule was passed. If CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set,
723 the capsule has been successfully processed by the firmware.
724 @retval EFI_INVALID_PARAMETER CapsuleSize or HeaderSize is NULL.
725 @retval EFI_INVALID_PARAMETER CapsuleCount is 0
726 @retval EFI_DEVICE_ERROR The capsule update was started, but failed due to a device error.
727 @retval EFI_UNSUPPORTED The capsule type is not supported on this platform.
728 @retval EFI_OUT_OF_RESOURCES There were insufficient resources to process the capsule.
734 IN EFI_CAPSULE_HEADER
**CapsuleHeaderArray
,
735 IN UINTN CapsuleCount
,
736 IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL
739 return mInternalRT
->UpdateCapsule (
748 This service is a wrapper for the UEFI Runtime Service QueryCapsuleCapabilities().
750 The QueryCapsuleCapabilities() function allows a caller to test to see if a capsule or
751 capsules can be updated via UpdateCapsule(). The Flags values in the capsule header and
752 size of the entire capsule is checked.
753 If the caller needs to query for generic capsule capability a fake EFI_CAPSULE_HEADER can be
754 constructed where CapsuleImageSize is equal to HeaderSize that is equal to sizeof
755 (EFI_CAPSULE_HEADER). To determine reset requirements,
756 CAPSULE_FLAGS_PERSIST_ACROSS_RESET should be set in the Flags field of the
758 The firmware must support any capsule that has the
759 CAPSULE_FLAGS_PERSIST_ACROSS_RESET flag set in EFI_CAPSULE_HEADER. The
760 firmware sets the policy for what capsules are supported that do not have the
761 CAPSULE_FLAGS_PERSIST_ACROSS_RESET flag set.
763 @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
764 being passed into update capsule. The capsules are assumed to
765 stored in contiguous virtual memory.
766 @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
768 @param MaximumCapsuleSize On output the maximum size that UpdateCapsule() can
769 support as an argument to UpdateCapsule() via
770 CapsuleHeaderArray and ScatterGatherList.
772 @param ResetType Returns the type of reset required for the capsule update.
774 @retval EFI_SUCCESS Valid answer returned.
775 @retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.
776 @retval EFI_UNSUPPORTED The capsule type is not supported on this platform, and
777 MaximumCapsuleSize and ResetType are undefined.
778 @retval EFI_OUT_OF_RESOURCES There were insufficient resources to process the query request.
783 EfiQueryCapsuleCapabilities (
784 IN EFI_CAPSULE_HEADER
**CapsuleHeaderArray
,
785 IN UINTN CapsuleCount
,
786 OUT UINT64
*MaximumCapsuleSize
,
787 OUT EFI_RESET_TYPE
*ResetType
790 return mInternalRT
->QueryCapsuleCapabilities (
800 This service is a wrapper for the UEFI Runtime Service QueryVariableInfo().
802 The QueryVariableInfo() function allows a caller to obtain the information about the
803 maximum size of the storage space available for the EFI variables, the remaining size of the storage
804 space available for the EFI variables and the maximum size of each individual EFI variable,
805 associated with the attributes specified.
806 The returned MaximumVariableStorageSize, RemainingVariableStorageSize,
807 MaximumVariableSize information may change immediately after the call based on other
808 runtime activities including asynchronous error events. Also, these values associated with different
809 attributes are not additive in nature.
811 @param Attributes Attributes bitmask to specify the type of variables on
812 which to return information. Refer to the
813 GetVariable() function description.
814 @param MaximumVariableStorageSize
815 On output the maximum size of the storage space
816 available for the EFI variables associated with the
817 attributes specified.
818 @param RemainingVariableStorageSize
819 Returns the remaining size of the storage space
820 available for the EFI variables associated with the
821 attributes specified..
822 @param MaximumVariableSize Returns the maximum size of the individual EFI
823 variables associated with the attributes specified.
825 @retval EFI_SUCCESS Valid answer returned.
826 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied.
827 @retval EFI_UNSUPPORTED EFI_UNSUPPORTED The attribute is not supported on this platform, and the
828 MaximumVariableStorageSize,
829 RemainingVariableStorageSize, MaximumVariableSize
835 EfiQueryVariableInfo (
836 IN UINT32 Attributes
,
837 OUT UINT64
*MaximumVariableStorageSize
,
838 OUT UINT64
*RemainingVariableStorageSize
,
839 OUT UINT64
*MaximumVariableSize
842 return mInternalRT
->QueryVariableInfo (
844 MaximumVariableStorageSize
,
845 RemainingVariableStorageSize
,