MdePkg/Include/Library/UefiRuntimeLib.h

   1 /** @file
   2   Library to abstract runtime services
   3
   4   Copyright (c) 2006, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13   Module Name:  UefiRuntimeLib.h
  14
  15 **/
  16
  17 #ifndef __UEFI_RUNTIME_LIB__
  18 #define __UEFI_RUNTIME_LIB__
  19
  20
  21 extern const EFI_EVENT_NOTIFY _gDriverExitBootServicesEvent[];
  22
  23 extern const EFI_EVENT_NOTIFY _gDriverSetVirtualAddressMapEvent[];
  24
  25 /**
  26   Check to see if the execute context is in Runtime phase or not.
  27
  28   @param  None.
  29
  30   @retval  TRUE  The driver is in SMM.
  31   @retval  FALSE The driver is not in SMM.
  32
  33 **/
  34 BOOLEAN
  35 EFIAPI
  36 EfiAtRuntime (
  37   VOID
  38   );
  39
  40 /**
  41   Check to see if the SetVirtualAddressMsp() is invoked or not.
  42
  43   @retval  TRUE  SetVirtualAddressMsp() has been called.
  44   @retval  FALSE SetVirtualAddressMsp() has not been called.
  45
  46 **/
  47 BOOLEAN
  48 EFIAPI
  49 EfiGoneVirtual (
  50   VOID
  51   );
  52
  53 /**
  54   Return current time and date information, and time-keeping
  55   capabilities of hardware platform.
  56
  57   @param  Time         A pointer to storage to receive a snapshot of the current time.
  58   @param  Capabilities An optional pointer to a buffer to receive the real time clock device¡¯s
  59                        capabilities.
  60
  61   @retval  EFI_SUCCESS  Success to execute the function.
  62   @retval  !EFI_SUCCESS Failed to e3xecute the function.
  63
  64 **/
  65 EFI_STATUS
  66 EFIAPI
  67 EfiGetTime (
  68   OUT EFI_TIME                    *Time,
  69   OUT EFI_TIME_CAPABILITIES       *Capabilities
  70   );
  71
  72 /**
  73   Set current time and date information.
  74
  75   @param  Time         A pointer to cache of time setting.
  76
  77   @retval  EFI_SUCCESS  Success to execute the function.
  78   @retval  !EFI_SUCCESS Failed to execute the function.
  79
  80 **/
  81 EFI_STATUS
  82 EFIAPI
  83 EfiSetTime (
  84   IN EFI_TIME                   *Time
  85   );
  86
  87 /**
  88   Return current wakeup alarm clock setting.
  89
  90   @param  Enabled Indicate if the alarm clock is enabled or disabled.
  91   @param  Pending Indicate if the alarm signal is pending and requires acknowledgement.
  92   @param  Time    Current alarm clock setting.
  93
  94   @retval  EFI_SUCCESS  Success to execute the function.
  95   @retval  !EFI_SUCCESS Failed to e3xecute the function.
  96
  97 **/
  98 EFI_STATUS
  99 EFIAPI
 100 EfiGetWakeupTime (
 101   OUT BOOLEAN                     *Enabled,
 102   OUT BOOLEAN                     *Pending,
 103   OUT EFI_TIME                    *Time
 104   );
 105
 106 /**
 107   Set current wakeup alarm clock.
 108
 109   @param  Enable Enable or disable current alarm clock..
 110   @param  Time   Point to alarm clock setting.
 111
 112   @retval  EFI_SUCCESS  Success to execute the function.
 113   @retval  !EFI_SUCCESS Failed to e3xecute the function.
 114
 115 **/
 116 EFI_STATUS
 117 EFIAPI
 118 EfiSetWakeupTime (
 119   IN BOOLEAN                      Enable,
 120   IN EFI_TIME                     *Time
 121   );
 122
 123 /**
 124   Return value of variable.
 125
 126   @param  VariableName the name of the vendor's variable, it's a
 127                        Null-Terminated Unicode String
 128   @param  VendorGuid   Unify identifier for vendor.
 129   @param  Attributes   Point to memory location to return the attributes of variable. If the point
 130                        is NULL, the parameter would be ignored.
 131   @param  DataSize     As input, point to the maxinum size of return Data-Buffer.
 132                        As output, point to the actual size of the returned Data-Buffer.
 133   @param  Data         Point to return Data-Buffer.
 134
 135   @retval  EFI_SUCCESS  Success to execute the function.
 136   @retval  !EFI_SUCCESS Failed to e3xecute the function.
 137
 138 **/
 139 EFI_STATUS
 140 EFIAPI
 141 EfiGetVariable (
 142   IN      CHAR16                   *VariableName,
 143   IN      EFI_GUID                 *VendorGuid,
 144   OUT     UINT32                   *Attributes,
 145   IN OUT  UINTN                    *DataSize,
 146   OUT     VOID                     *Data
 147   )
 148 ;
 149
 150 /**
 151   Enumerates variable's name.
 152
 153   @param  VariableNameSize As input, point to maxinum size of variable name.
 154                            As output, point to actual size of varaible name.
 155   @param  VariableName     As input, supplies the last VariableName that was returned by
 156                            GetNextVariableName().
 157                            As output, returns the name of variable. The name
 158                            string is Null-Terminated Unicode string.
 159   @param  VendorGuid       As input, supplies the last VendorGuid that was returned by
 160                            GetNextVriableName().
 161                            As output, returns the VendorGuid of the current variable.
 162
 163   @retval  EFI_SUCCESS  Success to execute the function.
 164   @retval  !EFI_SUCCESS Failed to e3xecute the function.
 165
 166 **/
 167 EFI_STATUS
 168 EFIAPI
 169 EfiGetNextVariableName (
 170   IN OUT UINTN                    *VariableNameSize,
 171   IN OUT CHAR16                   *VariableName,
 172   IN OUT EFI_GUID                 *VendorGuid
 173   );
 174
 175 /**
 176   Sets value of variable.
 177
 178   @param  VariableName the name of the vendor's variable, it's a
 179                        Null-Terminated Unicode String
 180   @param  VendorGuid   Unify identifier for vendor.
 181   @param  Attributes   Point to memory location to return the attributes of variable. If the point
 182                        is NULL, the parameter would be ignored.
 183   @param  DataSize     The size in bytes of Data-Buffer.
 184   @param  Data         Point to the content of the variable.
 185
 186   @retval  EFI_SUCCESS  Success to execute the function.
 187   @retval  !EFI_SUCCESS Failed to e3xecute the function.
 188
 189 **/
 190 EFI_STATUS
 191 EFIAPI
 192 EfiSetVariable (
 193   IN CHAR16                       *VariableName,
 194   IN EFI_GUID                     *VendorGuid,
 195   IN UINT32                       Attributes,
 196   IN UINTN                        DataSize,
 197   IN VOID                         *Data
 198   );
 199
 200 /**
 201   Returns the next high 32 bits of platform's monotonic counter.
 202
 203   @param  HighCount Pointer to returned value.
 204
 205   @retval  EFI_SUCCESS  Success to execute the function.
 206   @retval  !EFI_SUCCESS Failed to e3xecute the function.
 207
 208 **/
 209 EFI_STATUS
 210 EFIAPI
 211 EfiGetNextHighMonotonicCount (
 212   OUT UINT32                      *HighCount
 213   );
 214
 215 /**
 216   Resets the entire platform.
 217
 218   @param  ResetType   The type of reset to perform.
 219   @param  ResetStatus The status code for reset.
 220   @param  DataSize    The size in bytes of reset data.
 221   @param  ResetData   Pointer to data buffer that includes
 222                       Null-Terminated Unicode string.
 223
 224   @retval  EFI_SUCCESS  Success to execute the function.
 225   @retval  !EFI_SUCCESS Failed to e3xecute the function.
 226
 227 **/
 228 VOID
 229 EfiResetSystem (
 230   IN EFI_RESET_TYPE               ResetType,
 231   IN EFI_STATUS                   ResetStatus,
 232   IN UINTN                        DataSize,
 233   IN CHAR16                       *ResetData
 234   );
 235
 236 /**
 237   Determines the new virtual address that is to be used on subsequent memory accesses.
 238
 239   @param  DebugDisposition   Supplies type information for the pointer being converted.
 240   @param  Address            The pointer to a pointer that is to be fixed to be the
 241                              value needed for the new virtual address mapping being
 242                              applied.
 243
 244   @retval  EFI_SUCCESS  Success to execute the function.
 245   @retval  !EFI_SUCCESS Failed to e3xecute the function.
 246
 247 **/
 248 EFI_STATUS
 249 EFIAPI
 250 EfiConvertPointer (
 251   IN UINTN                  DebugDisposition,
 252   IN OUT VOID               **Address
 253   );
 254
 255
 256 /**
 257   Change the runtime addressing mode of EFI firmware from physical to virtual.
 258
 259   @param  MemoryMapSize         The size in bytes of VirtualMap.
 260   @param  DescriptorSize        The size in bytes of an entry in the VirtualMap.
 261   @param  DescriptorVersion     The version of the structure entries in VirtualMap.
 262   @param  VirtualMap            An array of memory descriptors which contain new virtual
 263                                 address mapping information for all runtime ranges. Type
 264                                 EFI_MEMORY_DESCRIPTOR is defined in the
 265                                 GetMemoryMap() function description.
 266
 267   @retval EFI_SUCCESS           The virtual address map has been applied.
 268   @retval EFI_UNSUPPORTED       EFI firmware is not at runtime, or the EFI firmware is already in
 269                                 virtual address mapped mode.
 270   @retval EFI_INVALID_PARAMETER DescriptorSize or DescriptorVersion is
 271                                 invalid.
 272   @retval EFI_NO_MAPPING        A virtual address was not supplied for a range in the memory
 273                                 map that requires a mapping.
 274   @retval EFI_NOT_FOUND         A virtual address was supplied for an address that is not found
 275                                 in the memory map.
 276 **/
 277 EFI_STATUS
 278 EFIAPI
 279 EfiSetVirtualAddressMap (
 280   IN UINTN                          MemoryMapSize,
 281   IN UINTN                          DescriptorSize,
 282   IN UINT32                         DescriptorVersion,
 283   IN CONST EFI_MEMORY_DESCRIPTOR    *VirtualMap
 284   );
 285
 286
 287 /**
 288   Conver the standard Lib double linked list to a virtual mapping.
 289
 290   @param  DebugDisposition   Supplies type information for the pointer being converted.
 291   @param  ListHead           Head of linked list to convert.
 292
 293   @retval  EFI_SUCCESS  Success to execute the function.
 294   @retval  !EFI_SUCCESS Failed to e3xecute the function.
 295
 296 **/
 297 EFI_STATUS
 298 EFIAPI
 299 EfiConvertList (
 300   IN UINTN                DebugDisposition,
 301   IN OUT LIST_ENTRY       *ListHead
 302   );
 303
 304 /**
 305
 306   Passes capsules to the firmware with both virtual and physical mapping.
 307   Depending on the intended consumption, the firmware may
 308   process the capsule immediately. If the payload should persist across a
 309   system reset, the reset value returned from EFI_QueryCapsuleCapabilities must
 310   be passed into ResetSystem() and will cause the capsule to be processed by
 311   the firmware as part of the reset process.
 312
 313   @param  CapsuleHeaderArray    Virtual pointer to an array of virtual pointers to the capsules
 314                                 being passed into update capsule. Each capsules is assumed to
 315                                 stored in contiguous virtual memory. The capsules in the
 316                                 CapsuleHeaderArray must be the same capsules as the
 317                                 ScatterGatherList. The CapsuleHeaderArray must
 318                                 have the capsules in the same order as the ScatterGatherList.
 319   @param  CapsuleCount          Number of pointers to EFI_CAPSULE_HEADER in
 320                                 CaspuleHeaderArray.
 321   @param  ScatterGatherList     Physical pointer to a set of
 322                                 EFI_CAPSULE_BLOCK_DESCRIPTOR that describes the
 323                                 location in physical memory of a set of capsules. See Related
 324                                 Definitions for an explanation of how more than one capsule is
 325                                 passed via this interface. The capsules in the
 326                                 ScatterGatherList must be in the same order as the
 327                                 CapsuleHeaderArray. This parameter is only referenced if
 328                                 the capsules are defined to persist across system reset.
 329
 330   @retval EFI_SUCCESS           Valid capsule was passed. I Valid capsule was passed. If
 331                                 CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set, the
 332                                 capsule has been successfully processed by the firmware.
 333   @retval EFI_INVALID_PARAMETER CapsuleSize is NULL or ResetTye is NULL.
 334   @retval EFI_DEVICE_ERROR      The capsule update was started, but failed due to a device error.
 335
 336 **/
 337 EFI_STATUS
 338 EFIAPI
 339 EfiUpdateCapsule (
 340   IN UEFI_CAPSULE_HEADER      **CapsuleHeaderArray,
 341   IN UINTN                    CapsuleCount,
 342   IN EFI_PHYSICAL_ADDRESS     ScatterGatherList
 343   );
 344
 345
 346 /**
 347
 348   The QueryCapsuleCapabilities() function allows a caller to test to see if a capsule or
 349   capsules can be updated via UpdateCapsule(). The Flags values in the capsule header and
 350   size of the entire capsule is checked.
 351   If the caller needs to query for generic capsule capability a fake EFI_CAPSULE_HEADER can be
 352   constructed where CapsuleImageSize is equal to HeaderSize that is equal to sizeof
 353   (EFI_CAPSULE_HEADER). To determine reset requirements,
 354   CAPSULE_FLAGS_PERSIST_ACROSS_RESET should be set in the Flags field of the
 355   EFI_CAPSULE_HEADER.
 356   The firmware must support any capsule that has the
 357   CAPSULE_FLAGS_PERSIST_ACROSS_RESET flag set in EFI_CAPSULE_HEADER. The
 358   firmware sets the policy for what capsules are supported that do not have the
 359   CAPSULE_FLAGS_PERSIST_ACROSS_RESET flag set.
 360
 361   @param  CapsuleHeaderArray    Virtual pointer to an array of virtual pointers to the capsules
 362                                 being passed into update capsule. The capsules are assumed to
 363                                 stored in contiguous virtual memory.
 364   @param  CapsuleCount          Number of pointers to EFI_CAPSULE_HEADER in
 365                                 CaspuleHeaderArray.
 366   @param  MaxiumCapsuleSize     On output the maximum size that UpdateCapsule() can
 367                                 support as an argument to UpdateCapsule() via
 368                                 CapsuleHeaderArray and ScatterGatherList.
 369                                 Undefined on input.
 370   @param  ResetType             Returns the type of reset required for the capsule update.
 371
 372   @retval EFI_SUCCESS           Valid answer returned..
 373   @retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.
 374   @retval EFI_UNSUPPORTED       The capsule type is not supported on this platform, and
 375                                 MaximumCapsuleSize and ResetType are undefined.
 376
 377 **/
 378 EFI_STATUS
 379 EFIAPI
 380 EfiQueryCapsuleCapabilities (
 381   IN UEFI_CAPSULE_HEADER       **CapsuleHeaderArray,
 382   IN UINTN                     CapsuleCount,
 383   OUT UINT64                   *MaximumCapsuleSize,
 384   OUT EFI_RESET_TYPE           *ResetType
 385   );
 386
 387
 388 /**
 389
 390   The QueryVariableInfo() function allows a caller to obtain the information about the
 391   maximum size of the storage space available for the EFI variables, the remaining size of the storage
 392   space available for the EFI variables and the maximum size of each individual EFI variable,
 393   associated with the attributes specified.
 394   The returned MaximumVariableStorageSize, RemainingVariableStorageSize,
 395   MaximumVariableSize information may change immediately after the call based on other
 396   runtime activities including asynchronous error events. Also, these values associated with different
 397   attributes are not additive in nature.
 398
 399   @param  Attributes            Attributes bitmask to specify the type of variables on
 400                                 which to return information. Refer to the
 401                                 GetVariable() function description.
 402   @param  MaximumVariableStorageSize
 403                                 On output the maximum size of the storage space
 404                                 available for the EFI variables associated with the
 405                                 attributes specified.
 406   @param  RemainingVariableStorageSize
 407                                 Returns the remaining size of the storage space
 408                                 available for the EFI variables associated with the
 409                                 attributes specified..
 410   @param  MaximumVariableSize   Returns the maximum size of the individual EFI
 411                                 variables associated with the attributes specified.
 412
 413   @retval EFI_SUCCESS           Valid answer returned.
 414   @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied.
 415   @retval EFI_UNSUPPORTED       EFI_UNSUPPORTED The attribute is not supported on this platform, and the
 416                                 MaximumVariableStorageSize,
 417                                 RemainingVariableStorageSize, MaximumVariableSize
 418                                 are undefined.
 419 **/
 420 EFI_STATUS
 421 EFIAPI
 422 EfiQueryVariableInfo (
 423   IN UINT32   Attrubutes,
 424   OUT UINT64  *MaximumVariableStorageSize,
 425   OUT UINT64  *RemainingVariableStorageSize,
 426   OUT UINT64  *MaximumVariableSize
 427   );
 428
 429 #endif
 430