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 RuntimeVariable module.
   5
   6 Copyright (c) 2006 - 2008, Intel Corporation
   7 All rights reserved. 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 <Library/PcdLib.h>
  26 #include <Library/UefiDriverEntryPoint.h>
  27 #include <Library/DxeServicesTableLib.h>
  28 #include <Library/UefiRuntimeLib.h>
  29 #include <Library/DebugLib.h>
  30 #include <Library/BaseMemoryLib.h>
  31 #include <Library/FvbServiceLib.h>
  32 #include <Library/UefiBootServicesTableLib.h>
  33 #include <Library/UefiLib.h>
  34 #include <Library/BaseLib.h>
  35 #include <Library/SynchronizationLib.h>
  36 #include <Library/MemoryAllocationLib.h>
  37 #include <Guid/GlobalVariable.h>
  38 #include <Guid/EventGroup.h>
  39 #include <Guid/VariableFormat.h>
  40
  41 #define VARIABLE_RECLAIM_THRESHOLD (1024)
  42
  43 typedef struct {
  44   VARIABLE_HEADER *CurrPtr;
  45   VARIABLE_HEADER *EndPtr;
  46   VARIABLE_HEADER *StartPtr;
  47   BOOLEAN         Volatile;
  48 } VARIABLE_POINTER_TRACK;
  49
  50 typedef struct {
  51   EFI_PHYSICAL_ADDRESS  VolatileVariableBase;
  52   EFI_PHYSICAL_ADDRESS  NonVolatileVariableBase;
  53   EFI_LOCK              VariableServicesLock;
  54   UINT32                ReentrantState;
  55 } VARIABLE_GLOBAL;
  56
  57 typedef struct {
  58   VARIABLE_GLOBAL VariableGlobal;
  59   UINTN           VolatileLastVariableOffset;
  60   UINTN           NonVolatileLastVariableOffset;
  61   UINT32          FvbInstance;
  62 } VARIABLE_MODULE_GLOBAL;
  63
  64 typedef struct {
  65   EFI_GUID    *Guid;
  66   CHAR16      *Name;
  67   UINT32      Attributes;
  68   UINTN       DataSize;
  69   VOID        *Data;
  70 } VARIABLE_CACHE_ENTRY;
  71
  72 /**
  73   Writes a buffer to variable storage space, in the working block.
  74
  75   This function writes a buffer to variable storage space into firmware
  76   volume block device. The destination is specified by parameter
  77   VariableBase. Fault Tolerant Write protocol is used for writing.
  78
  79   @param  VariableBase   Base address of variable to write
  80   @param  Buffer         Point to the data buffer
  81   @param  BufferSize     The number of bytes of the data Buffer
  82
  83   @retval EFI_SUCCESS    The function completed successfully
  84   @retval EFI_NOT_FOUND  Fail to locate Fault Tolerant Write protocol
  85   @retval EFI_ABORTED    The function could not complete successfully
  86
  87 **/
  88 EFI_STATUS
  89 FtwVariableSpace (
  90   IN EFI_PHYSICAL_ADDRESS   VariableBase,
  91   IN UINT8                  *Buffer,
  92   IN UINTN                  BufferSize
  93   );
  94
  95
  96 #endif