EdkCompatibilityPkg/Foundation/Library/EdkIIGlueLib/Include/Library/EdkIIGlueDxeRuntimeDriverLib.h

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