MdePkg/Include/Library/UefiRuntimeLib.h

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