EdkModulePkg/Universal/Variable/RuntimeDxe/Variable.h

   1 /*++
   2
   3 Copyright (c) 2006 - 2007, 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 #define VARIABLE_RECLAIM_THRESHOLD (1024)
  33
  34 #define VARIABLE_STORE_SIZE (64 * 1024)
  35 #define SCRATCH_SIZE        (4 * 1024)
  36
  37 //
  38 // Define GET_PAD_SIZE to optimize compiler
  39 //
  40 #if ((ALIGNMENT == 0) || (ALIGNMENT == 1))
  41 #define GET_PAD_SIZE(a) (0)
  42 #else
  43 #define GET_PAD_SIZE(a) (((~a) + 1) & (ALIGNMENT - 1))
  44 #endif
  45
  46 #define GET_VARIABLE_NAME_PTR(a)  (CHAR16 *) ((UINTN) (a) + sizeof (VARIABLE_HEADER))
  47
  48 typedef enum {
  49   Physical,
  50   Virtual
  51 } VARIABLE_POINTER_TYPE;
  52
  53 typedef struct {
  54   VARIABLE_HEADER *CurrPtr;
  55   VARIABLE_HEADER *EndPtr;
  56   VARIABLE_HEADER *StartPtr;
  57   BOOLEAN         Volatile;
  58 } VARIABLE_POINTER_TRACK;
  59
  60 typedef struct {
  61   EFI_PHYSICAL_ADDRESS  VolatileVariableBase;
  62   EFI_PHYSICAL_ADDRESS  NonVolatileVariableBase;
  63   EFI_LOCK              VariableServicesLock;
  64 } VARIABLE_GLOBAL;
  65
  66 typedef struct {
  67   VARIABLE_GLOBAL VariableGlobal[2];
  68   UINTN           VolatileLastVariableOffset;
  69   UINTN           NonVolatileLastVariableOffset;
  70   UINT32          FvbInstance;
  71 } ESAL_VARIABLE_GLOBAL;
  72
  73 extern ESAL_VARIABLE_GLOBAL *mVariableModuleGlobal;
  74
  75 //
  76 // Functions
  77 //
  78 EFI_STATUS
  79 EFIAPI
  80 VariableCommonInitialize (
  81   IN EFI_HANDLE         ImageHandle,
  82   IN EFI_SYSTEM_TABLE   *SystemTable
  83   )
  84 ;
  85
  86 EFI_STATUS
  87 EFIAPI
  88 VariableServiceInitialize (
  89   IN EFI_HANDLE         ImageHandle,
  90   IN EFI_SYSTEM_TABLE   *SystemTable
  91   )
  92 ;
  93
  94 VOID
  95 EFIAPI
  96 VariableClassAddressChangeEvent (
  97   IN EFI_EVENT        Event,
  98   IN VOID             *Context
  99   )
 100 ;
 101
 102 EFI_STATUS
 103 EFIAPI
 104 GetVariable (
 105   IN      CHAR16            *VariableName,
 106   IN      EFI_GUID          * VendorGuid,
 107   OUT     UINT32            *Attributes OPTIONAL,
 108   IN OUT  UINTN             *DataSize,
 109   OUT     VOID              *Data,
 110   IN      VARIABLE_GLOBAL   * Global,
 111   IN      UINT32            Instance
 112   )
 113 ;
 114
 115 EFI_STATUS
 116 EFIAPI
 117 GetNextVariableName (
 118   IN OUT  UINTN             *VariableNameSize,
 119   IN OUT  CHAR16            *VariableName,
 120   IN OUT  EFI_GUID          *VendorGuid,
 121   IN      VARIABLE_GLOBAL   *Global,
 122   IN      UINT32            Instance
 123   )
 124 ;
 125
 126 EFI_STATUS
 127 EFIAPI
 128 SetVariable (
 129   IN CHAR16                  *VariableName,
 130   IN EFI_GUID                *VendorGuid,
 131   IN UINT32                  Attributes,
 132   IN UINTN                   DataSize,
 133   IN VOID                    *Data,
 134   IN VARIABLE_GLOBAL         *Global,
 135   IN UINTN                   *VolatileOffset,
 136   IN UINTN                   *NonVolatileOffset,
 137   IN UINT32                  Instance
 138   )
 139 ;
 140
 141 EFI_STATUS
 142 EFIAPI
 143 QueryVariableInfo (
 144   IN  UINT32                 Attributes,
 145   OUT UINT64                 *MaximumVariableStorageSize,
 146   OUT UINT64                 *RemainingVariableStorageSize,
 147   OUT UINT64                 *MaximumVariableSize,
 148   IN  VARIABLE_GLOBAL        *Global,
 149   IN  UINT32                 Instance
 150   )
 151 ;
 152
 153 #endif