MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h

   1 /** @file
   2
   3   The internal header file includes the common header files, defines
   4   internal structure and functions used by Variable modules.
   5
   6 Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>
   7 This program and the accompanying materials
   8 are licensed and made available under the terms and conditions of the BSD License
   9 which accompanies this distribution.  The full text of the license may be found at
  10 http://opensource.org/licenses/bsd-license.php
  11
  12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  14
  15 **/
  16
  17 #ifndef _VARIABLE_H_
  18 #define _VARIABLE_H_
  19
  20 #include <PiDxe.h>
  21 #include <Protocol/VariableWrite.h>
  22 #include <Protocol/FaultTolerantWrite.h>
  23 #include <Protocol/FirmwareVolumeBlock.h>
  24 #include <Protocol/Variable.h>
  25 #include <Protocol/VariableLock.h>
  26 #include <Library/PcdLib.h>
  27 #include <Library/HobLib.h>
  28 #include <Library/UefiDriverEntryPoint.h>
  29 #include <Library/DxeServicesTableLib.h>
  30 #include <Library/UefiRuntimeLib.h>
  31 #include <Library/DebugLib.h>
  32 #include <Library/BaseMemoryLib.h>
  33 #include <Library/UefiBootServicesTableLib.h>
  34 #include <Library/UefiLib.h>
  35 #include <Library/BaseLib.h>
  36 #include <Library/SynchronizationLib.h>
  37 #include <Library/MemoryAllocationLib.h>
  38 #include <Guid/GlobalVariable.h>
  39 #include <Guid/EventGroup.h>
  40 #include <Guid/VariableFormat.h>
  41 #include <Guid/SystemNvDataGuid.h>
  42 #include <Guid/FaultTolerantWrite.h>
  43 #include <Guid/HardwareErrorVariable.h>
  44
  45 #define VARIABLE_ATTRIBUTE_BS_RT        (EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS)
  46 #define VARIABLE_ATTRIBUTE_NV_BS_RT     (VARIABLE_ATTRIBUTE_BS_RT | EFI_VARIABLE_NON_VOLATILE)
  47 #define VARIABLE_ATTRIBUTE_NV_BS_RT_AT  (VARIABLE_ATTRIBUTE_NV_BS_RT | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS)
  48
  49 typedef struct {
  50   CHAR16      *Name;
  51   UINT32      Attributes;
  52 } GLOBAL_VARIABLE_ENTRY;
  53
  54 ///
  55 /// The size of a 3 character ISO639 language code.
  56 ///
  57 #define ISO_639_2_ENTRY_SIZE    3
  58
  59 typedef enum {
  60   VariableStoreTypeVolatile,
  61   VariableStoreTypeHob,
  62   VariableStoreTypeNv,
  63   VariableStoreTypeMax
  64 } VARIABLE_STORE_TYPE;
  65
  66 typedef struct {
  67   VARIABLE_HEADER *CurrPtr;
  68   //
  69   // If both ADDED and IN_DELETED_TRANSITION variable are present,
  70   // InDeletedTransitionPtr will point to the IN_DELETED_TRANSITION one.
  71   // Otherwise, CurrPtr will point to the ADDED or IN_DELETED_TRANSITION one,
  72   // and InDeletedTransitionPtr will be NULL at the same time.
  73   //
  74   VARIABLE_HEADER *InDeletedTransitionPtr;
  75   VARIABLE_HEADER *EndPtr;
  76   VARIABLE_HEADER *StartPtr;
  77   BOOLEAN         Volatile;
  78 } VARIABLE_POINTER_TRACK;
  79
  80 typedef struct {
  81   EFI_PHYSICAL_ADDRESS  HobVariableBase;
  82   EFI_PHYSICAL_ADDRESS  VolatileVariableBase;
  83   EFI_PHYSICAL_ADDRESS  NonVolatileVariableBase;
  84   EFI_LOCK              VariableServicesLock;
  85   UINT32                ReentrantState;
  86 } VARIABLE_GLOBAL;
  87
  88 typedef struct {
  89   VARIABLE_GLOBAL VariableGlobal;
  90   UINTN           VolatileLastVariableOffset;
  91   UINTN           NonVolatileLastVariableOffset;
  92   UINTN           CommonVariableTotalSize;
  93   UINTN           HwErrVariableTotalSize;
  94   CHAR8           *PlatformLangCodes;
  95   CHAR8           *LangCodes;
  96   CHAR8           *PlatformLang;
  97   CHAR8           Lang[ISO_639_2_ENTRY_SIZE + 1];
  98   EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *FvbInstance;
  99 } VARIABLE_MODULE_GLOBAL;
 100
 101 typedef struct {
 102   EFI_GUID    *Guid;
 103   CHAR16      *Name;
 104   UINT32      Attributes;
 105   UINTN       DataSize;
 106   VOID        *Data;
 107 } VARIABLE_CACHE_ENTRY;
 108
 109 typedef struct {
 110   EFI_GUID    Guid;
 111   CHAR16      *Name;
 112   LIST_ENTRY  Link;
 113 } VARIABLE_ENTRY;
 114
 115 /**
 116   Flush the HOB variable to flash.
 117
 118   @param[in] VariableName       Name of variable has been updated or deleted.
 119   @param[in] VendorGuid         Guid of variable has been updated or deleted.
 120
 121 **/
 122 VOID
 123 FlushHobVariableToFlash (
 124   IN CHAR16                     *VariableName,
 125   IN EFI_GUID                   *VendorGuid
 126   );
 127
 128 /**
 129   Writes a buffer to variable storage space, in the working block.
 130
 131   This function writes a buffer to variable storage space into a firmware
 132   volume block device. The destination is specified by the parameter
 133   VariableBase. Fault Tolerant Write protocol is used for writing.
 134
 135   @param  VariableBase   Base address of the variable to write.
 136   @param  VariableBuffer Point to the variable data buffer.
 137
 138   @retval EFI_SUCCESS    The function completed successfully.
 139   @retval EFI_NOT_FOUND  Fail to locate Fault Tolerant Write protocol.
 140   @retval EFI_ABORTED    The function could not complete successfully.
 141
 142 **/
 143 EFI_STATUS
 144 FtwVariableSpace (
 145   IN EFI_PHYSICAL_ADDRESS   VariableBase,
 146   IN VARIABLE_STORE_HEADER  *VariableBuffer
 147   );
 148
 149
 150 /**
 151   Update the variable region with Variable information. These are the same
 152   arguments as the EFI Variable services.
 153
 154   @param[in] VariableName       Name of variable.
 155
 156   @param[in] VendorGuid         Guid of variable.
 157
 158   @param[in] Data               Variable data.
 159
 160   @param[in] DataSize           Size of data. 0 means delete.
 161
 162   @param[in] Attributes         Attribues of the variable.
 163
 164   @param[in, out] Variable      The variable information that is used to keep track of variable usage.
 165
 166   @retval EFI_SUCCESS           The update operation is success.
 167
 168   @retval EFI_OUT_OF_RESOURCES  Variable region is full, cannot write other data into this region.
 169
 170 **/
 171 EFI_STATUS
 172 UpdateVariable (
 173   IN      CHAR16          *VariableName,
 174   IN      EFI_GUID        *VendorGuid,
 175   IN      VOID            *Data,
 176   IN      UINTN           DataSize,
 177   IN      UINT32          Attributes OPTIONAL,
 178   IN OUT  VARIABLE_POINTER_TRACK *Variable
 179   );
 180
 181
 182 /**
 183   Return TRUE if ExitBootServices () has been called.
 184
 185   @retval TRUE If ExitBootServices () has been called.
 186 **/
 187 BOOLEAN
 188 AtRuntime (
 189   VOID
 190   );
 191
 192 /**
 193   Initializes a basic mutual exclusion lock.
 194
 195   This function initializes a basic mutual exclusion lock to the released state
 196   and returns the lock.  Each lock provides mutual exclusion access at its task
 197   priority level.  Since there is no preemption or multiprocessor support in EFI,
 198   acquiring the lock only consists of raising to the locks TPL.
 199   If Lock is NULL, then ASSERT().
 200   If Priority is not a valid TPL value, then ASSERT().
 201
 202   @param  Lock       A pointer to the lock data structure to initialize.
 203   @param  Priority   EFI TPL is associated with the lock.
 204
 205   @return The lock.
 206
 207 **/
 208 EFI_LOCK *
 209 InitializeLock (
 210   IN OUT EFI_LOCK  *Lock,
 211   IN EFI_TPL        Priority
 212   );
 213
 214
 215 /**
 216   Acquires lock only at boot time. Simply returns at runtime.
 217
 218   This is a temperary function that will be removed when
 219   EfiAcquireLock() in UefiLib can handle the call in UEFI
 220   Runtimer driver in RT phase.
 221   It calls EfiAcquireLock() at boot time, and simply returns
 222   at runtime.
 223
 224   @param  Lock         A pointer to the lock to acquire.
 225
 226 **/
 227 VOID
 228 AcquireLockOnlyAtBootTime (
 229   IN EFI_LOCK  *Lock
 230   );
 231
 232
 233 /**
 234   Releases lock only at boot time. Simply returns at runtime.
 235
 236   This is a temperary function which will be removed when
 237   EfiReleaseLock() in UefiLib can handle the call in UEFI
 238   Runtimer driver in RT phase.
 239   It calls EfiReleaseLock() at boot time and simply returns
 240   at runtime.
 241
 242   @param  Lock         A pointer to the lock to release.
 243
 244 **/
 245 VOID
 246 ReleaseLockOnlyAtBootTime (
 247   IN EFI_LOCK  *Lock
 248   );
 249
 250 /**
 251   Retrive the FVB protocol interface by HANDLE.
 252
 253   @param[in]  FvBlockHandle     The handle of FVB protocol that provides services for
 254                                 reading, writing, and erasing the target block.
 255   @param[out] FvBlock           The interface of FVB protocol
 256
 257   @retval EFI_SUCCESS           The interface information for the specified protocol was returned.
 258   @retval EFI_UNSUPPORTED       The device does not support the FVB protocol.
 259   @retval EFI_INVALID_PARAMETER FvBlockHandle is not a valid EFI_HANDLE or FvBlock is NULL.
 260
 261 **/
 262 EFI_STATUS
 263 GetFvbByHandle (
 264   IN  EFI_HANDLE                          FvBlockHandle,
 265   OUT EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL  **FvBlock
 266   );
 267
 268
 269 /**
 270   Retrive the Swap Address Range protocol interface.
 271
 272   @param[out] SarProtocol       The interface of SAR protocol
 273
 274   @retval EFI_SUCCESS           The SAR protocol instance was found and returned in SarProtocol.
 275   @retval EFI_NOT_FOUND         The SAR protocol instance was not found.
 276   @retval EFI_INVALID_PARAMETER SarProtocol is NULL.
 277
 278 **/
 279 EFI_STATUS
 280 GetSarProtocol (
 281   OUT VOID                                **SarProtocol
 282   );
 283
 284 /**
 285   Function returns an array of handles that support the FVB protocol
 286   in a buffer allocated from pool.
 287
 288   @param[out]  NumberHandles    The number of handles returned in Buffer.
 289   @param[out]  Buffer           A pointer to the buffer to return the requested
 290                                 array of  handles that support FVB protocol.
 291
 292   @retval EFI_SUCCESS           The array of handles was returned in Buffer, and the number of
 293                                 handles in Buffer was returned in NumberHandles.
 294   @retval EFI_NOT_FOUND         No FVB handle was found.
 295   @retval EFI_OUT_OF_RESOURCES  There is not enough pool memory to store the matching results.
 296   @retval EFI_INVALID_PARAMETER NumberHandles is NULL or Buffer is NULL.
 297
 298 **/
 299 EFI_STATUS
 300 GetFvbCountAndBuffer (
 301   OUT UINTN                               *NumberHandles,
 302   OUT EFI_HANDLE                          **Buffer
 303   );
 304
 305 /**
 306   Initializes variable store area for non-volatile and volatile variable.
 307
 308   @retval EFI_SUCCESS           Function successfully executed.
 309   @retval EFI_OUT_OF_RESOURCES  Fail to allocate enough memory resource.
 310
 311 **/
 312 EFI_STATUS
 313 VariableCommonInitialize (
 314   VOID
 315   );
 316
 317 /**
 318   This function reclaims variable storage if free size is below the threshold.
 319
 320 **/
 321 VOID
 322 ReclaimForOS(
 323   VOID
 324   );
 325
 326
 327 /**
 328   Initializes variable write service after FVB was ready.
 329
 330   @retval EFI_SUCCESS          Function successfully executed.
 331   @retval Others               Fail to initialize the variable service.
 332
 333 **/
 334 EFI_STATUS
 335 VariableWriteServiceInitialize (
 336   VOID
 337   );
 338
 339 /**
 340   Retrive the SMM Fault Tolerent Write protocol interface.
 341
 342   @param[out] FtwProtocol       The interface of SMM Ftw protocol
 343
 344   @retval EFI_SUCCESS           The SMM SAR protocol instance was found and returned in SarProtocol.
 345   @retval EFI_NOT_FOUND         The SMM SAR protocol instance was not found.
 346   @retval EFI_INVALID_PARAMETER SarProtocol is NULL.
 347
 348 **/
 349 EFI_STATUS
 350 GetFtwProtocol (
 351   OUT VOID                                **FtwProtocol
 352   );
 353
 354 /**
 355   Get the proper fvb handle and/or fvb protocol by the given Flash address.
 356
 357   @param[in] Address        The Flash address.
 358   @param[out] FvbHandle     In output, if it is not NULL, it points to the proper FVB handle.
 359   @param[out] FvbProtocol   In output, if it is not NULL, it points to the proper FVB protocol.
 360
 361 **/
 362 EFI_STATUS
 363 GetFvbInfoByAddress (
 364   IN  EFI_PHYSICAL_ADDRESS                Address,
 365   OUT EFI_HANDLE                          *FvbHandle OPTIONAL,
 366   OUT EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL  **FvbProtocol OPTIONAL
 367   );
 368
 369 /**
 370
 371   This code finds variable in storage blocks (Volatile or Non-Volatile).
 372
 373   @param VariableName               Name of Variable to be found.
 374   @param VendorGuid                 Variable vendor GUID.
 375   @param Attributes                 Attribute value of the variable found.
 376   @param DataSize                   Size of Data found. If size is less than the
 377                                     data, this value contains the required size.
 378   @param Data                       Data pointer.
 379
 380   @return EFI_INVALID_PARAMETER     Invalid parameter.
 381   @return EFI_SUCCESS               Find the specified variable.
 382   @return EFI_NOT_FOUND             Not found.
 383   @return EFI_BUFFER_TO_SMALL       DataSize is too small for the result.
 384
 385 **/
 386 EFI_STATUS
 387 EFIAPI
 388 VariableServiceGetVariable (
 389   IN      CHAR16            *VariableName,
 390   IN      EFI_GUID          *VendorGuid,
 391   OUT     UINT32            *Attributes OPTIONAL,
 392   IN OUT  UINTN             *DataSize,
 393   OUT     VOID              *Data
 394   );
 395
 396 /**
 397
 398   This code Finds the Next available variable.
 399
 400   @param VariableNameSize           Size of the variable name.
 401   @param VariableName               Pointer to variable name.
 402   @param VendorGuid                 Variable Vendor Guid.
 403
 404   @return EFI_INVALID_PARAMETER     Invalid parameter.
 405   @return EFI_SUCCESS               Find the specified variable.
 406   @return EFI_NOT_FOUND             Not found.
 407   @return EFI_BUFFER_TO_SMALL       DataSize is too small for the result.
 408
 409 **/
 410 EFI_STATUS
 411 EFIAPI
 412 VariableServiceGetNextVariableName (
 413   IN OUT  UINTN             *VariableNameSize,
 414   IN OUT  CHAR16            *VariableName,
 415   IN OUT  EFI_GUID          *VendorGuid
 416   );
 417
 418 /**
 419
 420   This code sets variable in storage blocks (Volatile or Non-Volatile).
 421
 422   @param VariableName                     Name of Variable to be found.
 423   @param VendorGuid                       Variable vendor GUID.
 424   @param Attributes                       Attribute value of the variable found
 425   @param DataSize                         Size of Data found. If size is less than the
 426                                           data, this value contains the required size.
 427   @param Data                             Data pointer.
 428
 429   @return EFI_INVALID_PARAMETER           Invalid parameter.
 430   @return EFI_SUCCESS                     Set successfully.
 431   @return EFI_OUT_OF_RESOURCES            Resource not enough to set variable.
 432   @return EFI_NOT_FOUND                   Not found.
 433   @return EFI_WRITE_PROTECTED             Variable is read-only.
 434
 435 **/
 436 EFI_STATUS
 437 EFIAPI
 438 VariableServiceSetVariable (
 439   IN CHAR16                  *VariableName,
 440   IN EFI_GUID                *VendorGuid,
 441   IN UINT32                  Attributes,
 442   IN UINTN                   DataSize,
 443   IN VOID                    *Data
 444   );
 445
 446 /**
 447
 448   This code returns information about the EFI variables.
 449
 450   @param Attributes                     Attributes bitmask to specify the type of variables
 451                                         on which to return information.
 452   @param MaximumVariableStorageSize     Pointer to the maximum size of the storage space available
 453                                         for the EFI variables associated with the attributes specified.
 454   @param RemainingVariableStorageSize   Pointer to the remaining size of the storage space available
 455                                         for EFI variables associated with the attributes specified.
 456   @param MaximumVariableSize            Pointer to the maximum size of an individual EFI variables
 457                                         associated with the attributes specified.
 458
 459   @return EFI_INVALID_PARAMETER         An invalid combination of attribute bits was supplied.
 460   @return EFI_SUCCESS                   Query successfully.
 461   @return EFI_UNSUPPORTED               The attribute is not supported on this platform.
 462
 463 **/
 464 EFI_STATUS
 465 EFIAPI
 466 VariableServiceQueryVariableInfo (
 467   IN  UINT32                 Attributes,
 468   OUT UINT64                 *MaximumVariableStorageSize,
 469   OUT UINT64                 *RemainingVariableStorageSize,
 470   OUT UINT64                 *MaximumVariableSize
 471   );
 472
 473 /**
 474   Mark a variable that will become read-only after leaving the DXE phase of execution.
 475
 476   @param[in] This          The VARIABLE_LOCK_PROTOCOL instance.
 477   @param[in] VariableName  A pointer to the variable name that will be made read-only subsequently.
 478   @param[in] VendorGuid    A pointer to the vendor GUID that will be made read-only subsequently.
 479
 480   @retval EFI_SUCCESS           The variable specified by the VariableName and the VendorGuid was marked
 481                                 as pending to be read-only.
 482   @retval EFI_INVALID_PARAMETER VariableName or VendorGuid is NULL.
 483                                 Or VariableName is an empty string.
 484   @retval EFI_ACCESS_DENIED     EFI_END_OF_DXE_EVENT_GROUP_GUID or EFI_EVENT_GROUP_READY_TO_BOOT has
 485                                 already been signaled.
 486   @retval EFI_OUT_OF_RESOURCES  There is not enough resource to hold the lock request.
 487 **/
 488 EFI_STATUS
 489 EFIAPI
 490 VariableLockRequestToLock (
 491   IN CONST EDKII_VARIABLE_LOCK_PROTOCOL *This,
 492   IN       CHAR16                       *VariableName,
 493   IN       EFI_GUID                     *VendorGuid
 494   );
 495
 496 extern VARIABLE_MODULE_GLOBAL  *mVariableModuleGlobal;
 497
 498 #endif