EdkModulePkg/Universal/Variable/RuntimeDxe/Variable.h

   1 /*++
   2
   3 Copyright (c) 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 Module Name:
  13
  14   Variable.h
  15
  16 Abstract:
  17
  18 --*/
  19
  20 #ifndef _VARIABLE_H
  21 #define _VARIABLE_H
  22
  23 //
  24 // Statements that include other header files
  25 //
  26
  27 //
  28 // BugBug: We need relcate the head file.
  29 //
  30 #include <Common/Variable.h>
  31
  32 #if defined (MDE_CPU_IPF)
  33 #define ALIGNMENT  8
  34 #else
  35 #define ALIGNMENT  1
  36 #endif
  37
  38 #define VARIABLE_RECLAIM_THRESHOLD (1024)
  39
  40 #define VARIABLE_STORE_SIZE (64 * 1024)
  41 #define SCRATCH_SIZE        (4 * 1024)
  42
  43 //
  44 // Define GET_PAD_SIZE to optimize compiler
  45 //
  46 #if ((ALIGNMENT == 0) || (ALIGNMENT == 1))
  47 #define GET_PAD_SIZE(a) (0)
  48 #else
  49 #define GET_PAD_SIZE(a) (((~a) + 1) & (ALIGNMENT - 1))
  50 #endif
  51
  52 #define GET_VARIABLE_NAME_PTR(a)  (CHAR16 *) ((UINTN) (a) + sizeof (VARIABLE_HEADER))
  53
  54 typedef enum {
  55   Physical,
  56   Virtual
  57 } VARIABLE_POINTER_TYPE;
  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 } VARIABLE_GLOBAL;
  70
  71 typedef struct {
  72   VARIABLE_GLOBAL VariableBase[2];
  73   UINTN           VolatileLastVariableOffset;
  74   UINTN           NonVolatileLastVariableOffset;
  75   UINT32          FvbInstance;
  76 } ESAL_VARIABLE_GLOBAL;
  77
  78 //
  79 // Functions
  80 //
  81 EFI_STATUS
  82 EFIAPI
  83 VariableCommonInitialize (
  84   IN EFI_HANDLE         ImageHandle,
  85   IN EFI_SYSTEM_TABLE   *SystemTable
  86   )
  87 ;
  88
  89 EFI_STATUS
  90 EFIAPI
  91 VariableServiceInitialize (
  92   IN EFI_HANDLE         ImageHandle,
  93   IN EFI_SYSTEM_TABLE   *SystemTable
  94   )
  95 ;
  96
  97 VOID
  98 EFIAPI
  99 VariableClassAddressChangeEvent (
 100   IN EFI_EVENT        Event,
 101   IN VOID             *Context
 102   )
 103 ;
 104
 105 EFI_STATUS
 106 EFIAPI
 107 GetVariable (
 108   IN      CHAR16            *VariableName,
 109   IN      EFI_GUID          * VendorGuid,
 110   OUT     UINT32            *Attributes OPTIONAL,
 111   IN OUT  UINTN             *DataSize,
 112   OUT     VOID              *Data,
 113   IN      VARIABLE_GLOBAL   * Global,
 114   IN      UINT32            Instance
 115   )
 116 ;
 117
 118 EFI_STATUS
 119 EFIAPI
 120 GetNextVariableName (
 121   IN OUT  UINTN             *VariableNameSize,
 122   IN OUT  CHAR16            *VariableName,
 123   IN OUT  EFI_GUID          *VendorGuid,
 124   IN      VARIABLE_GLOBAL   *Global,
 125   IN      UINT32            Instance
 126   )
 127 ;
 128
 129 EFI_STATUS
 130 EFIAPI
 131 SetVariable (
 132   IN CHAR16                  *VariableName,
 133   IN EFI_GUID                *VendorGuid,
 134   IN UINT32                  Attributes,
 135   IN UINTN                   DataSize,
 136   IN VOID                    *Data,
 137   IN VARIABLE_GLOBAL         *Global,
 138   IN UINTN                   *VolatileOffset,
 139   IN UINTN                   *NonVolatileOffset,
 140   IN UINT32                  Instance
 141   )
 142 ;
 143
 144 #if (EFI_SPECIFICATION_VERSION >= 0x00020000)
 145 EFI_STATUS
 146 EFIAPI
 147 QueryVariableInfo (
 148   IN  UINT32                 Attributes,
 149   OUT UINT64                 *MaximumVariableStorageSize,
 150   OUT UINT64                 *RemainingVariableStorageSize,
 151   OUT UINT64                 *MaximumVariableSize,
 152   IN  VARIABLE_GLOBAL        *Global,
 153   IN  UINT32                 Instance
 154   )
 155 ;
 156 #endif
 157
 158 #endif