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