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/FaultTolerantWriteLite.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/MemoryAllocationLib.h>
  36 #include <Guid/VariableInfo.h>
  37 #include <Guid/GlobalVariable.h>
  38 #include <VariableFormat.h>
  39
  40
  41
  42 #define VARIABLE_RECLAIM_THRESHOLD (1024)
  43
  44 #define VARIABLE_STORE_SIZE FixedPcdGet32(PcdVariableStoreSize)
  45 #define SCRATCH_SIZE        FixedPcdGet32(PcdMaxVariableSize)
  46
  47 //
  48 // Define GET_PAD_SIZE to optimize compiler
  49 //
  50 #if ((ALIGNMENT == 0) || (ALIGNMENT == 1))
  51 #define GET_PAD_SIZE(a) (0)
  52 #else
  53 #define GET_PAD_SIZE(a) (((~a) + 1) & (ALIGNMENT - 1))
  54 #endif
  55
  56 #define HEADER_ALIGN(Header)  (((UINTN) (Header) + HEADER_ALIGNMENT - 1) & (~(HEADER_ALIGNMENT - 1)))
  57
  58
  59 typedef struct {
  60   VARIABLE_HEADER *CurrPtr;
  61   VARIABLE_HEADER *EndPtr;
  62   VARIABLE_HEADER *StartPtr;
  63   BOOLEAN         Volatile;
  64 } VARIABLE_POINTER_TRACK;
  65
  66 typedef struct {
  67   EFI_PHYSICAL_ADDRESS  VolatileVariableBase;
  68   EFI_PHYSICAL_ADDRESS  NonVolatileVariableBase;
  69   EFI_LOCK              VariableServicesLock;
  70   UINT32                ReentrantState;
  71 } VARIABLE_GLOBAL;
  72
  73 typedef struct {
  74   VARIABLE_GLOBAL VariableGlobal;
  75   UINTN           VolatileLastVariableOffset;
  76   UINTN           NonVolatileLastVariableOffset;
  77   UINT32          FvbInstance;
  78 } VARIABLE_MODULE_GLOBAL;
  79
  80 typedef struct {
  81   EFI_GUID    *Guid;
  82   CHAR16      *Name;
  83   UINT32      Attributes;
  84   UINTN       DataSize;
  85   VOID        *Data;
  86 } VARIABLE_CACHE_ENTRY;
  87
  88 #endif