MdePkg/Library/UefiRuntimeLib/RuntimeService.c

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