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