IntelFrameworkModulePkg/Universal/VariablePei/Variable.h

   1 /** @file
   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 **/
  13
  14 #ifndef _PEI_VARIABLE_H
  15 #define _PEI_VARIABLE_H
  16
  17 #include <PiPei.h>
  18 #include <Ppi/ReadOnlyVariable.h>
  19 #include <Ppi/ReadOnlyVariable2.h>
  20 #include <Library/DebugLib.h>
  21 #include <Library/PeimEntryPoint.h>
  22 #include <Library/HobLib.h>
  23 #include <Library/PcdLib.h>
  24 #include <Library/BaseMemoryLib.h>
  25 #include <Library/PeiServicesTablePointerLib.h>
  26 #include <VariableFormat.h>
  27
  28 //
  29 // Define GET_PAD_SIZE to optimize compiler
  30 //
  31 #if ((ALIGNMENT == 0) || (ALIGNMENT == 1))
  32 #define GET_PAD_SIZE(a) (0)
  33 #else
  34 #define GET_PAD_SIZE(a) (((~a) + 1) & (ALIGNMENT - 1))
  35 #endif
  36
  37 #define HEADER_ALIGN(Header)  (((UINTN) (Header) + HEADER_ALIGNMENT - 1) & (~(HEADER_ALIGNMENT - 1)))
  38
  39 typedef struct {
  40   VARIABLE_HEADER *CurrPtr;
  41   VARIABLE_HEADER *EndPtr;
  42   VARIABLE_HEADER *StartPtr;
  43 } VARIABLE_POINTER_TRACK;
  44
  45 #define VARIABLE_INDEX_TABLE_VOLUME 122
  46
  47 #define EFI_VARIABLE_INDEX_TABLE_GUID \
  48   { 0x8cfdb8c8, 0xd6b2, 0x40f3, { 0x8e, 0x97, 0x02, 0x30, 0x7c, 0xc9, 0x8b, 0x7c } }
  49
  50 typedef struct {
  51   UINT16          Length;
  52   UINT16          GoneThrough;
  53   VARIABLE_HEADER *EndPtr;
  54   VARIABLE_HEADER *StartPtr;
  55   UINT16          Index[VARIABLE_INDEX_TABLE_VOLUME];
  56 } VARIABLE_INDEX_TABLE;
  57
  58
  59 //
  60 // Functions
  61 //
  62
  63 EFI_STATUS
  64 EFIAPI
  65 PeiGetVariable (
  66   IN EFI_PEI_SERVICES             **PeiServices,
  67   IN CHAR16                       *VariableName,
  68   IN EFI_GUID                     * VendorGuid,
  69   OUT UINT32                      *Attributes OPTIONAL,
  70   IN OUT UINTN                    *DataSize,
  71   OUT VOID                        *Data
  72   );
  73
  74 EFI_STATUS
  75 EFIAPI
  76 PeiGetVariable2 (
  77   IN CONST  EFI_PEI_READ_ONLY_VARIABLE2_PPI *This,
  78   IN CONST  CHAR16                          *VariableName,
  79   IN CONST  EFI_GUID                        *VariableGuid,
  80   OUT       UINT32                          *Attributes,
  81   IN OUT    UINTN                           *DataSize,
  82   OUT       VOID                            *Data
  83   );
  84
  85 EFI_STATUS
  86 EFIAPI
  87 PeiGetNextVariableName2 (
  88   IN CONST  EFI_PEI_READ_ONLY_VARIABLE2_PPI *This,
  89   IN OUT UINTN                              *VariableNameSize,
  90   IN OUT CHAR16                             *VariableName,
  91   IN OUT EFI_GUID                           *VariableGuid
  92   );
  93
  94 EFI_STATUS
  95 EFIAPI
  96 PeiGetNextVariableName (
  97   IN EFI_PEI_SERVICES             **PeiServices,
  98   IN OUT UINTN                    *VariableNameSize,
  99   IN OUT CHAR16                   *VariableName,
 100   IN OUT EFI_GUID                 *VendorGuid
 101   );
 102
 103 /**
 104   Get one variable by the index count.
 105
 106   @param  IndexTable  The pointer to variable index table.
 107   @param  Count       The index count of variable in index table.
 108
 109   @return The pointer to variable header indexed by count.
 110
 111 **/
 112 VARIABLE_HEADER *
 113 GetVariableByIndex (
 114   IN VARIABLE_INDEX_TABLE        *IndexTable,
 115   IN UINT32                      Count
 116   );
 117
 118 /**
 119   Record Variable in VariableIndex HOB.
 120
 121   Record Variable in VariableIndex HOB and update the length of variable index table.
 122
 123   @param  IndexTable  The pointer to variable index table.
 124   @param  Variable    The pointer to the variable that will be recorded.
 125
 126   @retval VOID
 127
 128 **/
 129 VOID
 130 VariableIndexTableUpdate (
 131   IN OUT  VARIABLE_INDEX_TABLE   *IndexTable,
 132   IN      VARIABLE_HEADER        *Variable
 133   );
 134
 135 #endif // _PEI_VARIABLE_H