EdkModulePkg/Universal/Variable/Pei/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   Tiano PEIM to provide the variable functionality
  19
  20 --*/
  21
  22 #ifndef _PEI_VARIABLE_H
  23 #define _PEI_VARIABLE_H
  24
  25 //
  26 // BugBug: We need relcate the head file.
  27 //
  28 #include <Common/Variable.h>
  29
  30 #define ALIGNMENT 1
  31
  32 //
  33 // Define GET_PAD_SIZE to optimize compiler
  34 //
  35 #if ((ALIGNMENT == 0) || (ALIGNMENT == 1))
  36 #define GET_PAD_SIZE(a) (0)
  37 #else
  38 #define GET_PAD_SIZE(a) (((~a) + 1) & (ALIGNMENT - 1))
  39 #endif
  40
  41 #define GET_VARIABLE_NAME_PTR(a)  (CHAR16 *) ((UINTN) (a) + sizeof (VARIABLE_HEADER))
  42
  43 #define GET_VARIABLE_DATA_PTR(a) \
  44   (UINT8 *) ((UINTN) GET_VARIABLE_NAME_PTR (a) + (a)->NameSize + GET_PAD_SIZE ((a)->NameSize))
  45
  46 typedef struct {
  47   VARIABLE_HEADER *CurrPtr;
  48   VARIABLE_HEADER *EndPtr;
  49   VARIABLE_HEADER *StartPtr;
  50 } VARIABLE_POINTER_TRACK;
  51
  52 #define VARIABLE_INDEX_TABLE_VOLUME 122
  53
  54 #define EFI_VARIABLE_INDEX_TABLE_GUID \
  55   { 0x8cfdb8c8, 0xd6b2, 0x40f3, { 0x8e, 0x97, 0x02, 0x30, 0x7c, 0xc9, 0x8b, 0x7c } }
  56
  57 typedef struct {
  58   UINT16          Length;
  59   UINT16          GoneThrough;
  60   VARIABLE_HEADER *EndPtr;
  61   VARIABLE_HEADER *StartPtr;
  62   UINT16          Index[VARIABLE_INDEX_TABLE_VOLUME];
  63 } VARIABLE_INDEX_TABLE;
  64
  65 extern EFI_GUID gEfiVariableIndexTableGuid;
  66
  67 //
  68 // Functions
  69 //
  70 EFI_STATUS
  71 EFIAPI
  72 PeimInitializeVariableServices (
  73   IN EFI_FFS_FILE_HEADER       *FfsHeader,
  74   IN EFI_PEI_SERVICES          **PeiServices
  75   )
  76 /*++
  77
  78 Routine Description:
  79
  80   TODO: Add function description
  81
  82 Arguments:
  83
  84   FfsHeader   - TODO: add argument description
  85   PeiServices - TODO: add argument description
  86
  87 Returns:
  88
  89   TODO: add return values
  90
  91 --*/
  92 ;
  93
  94 EFI_STATUS
  95 EFIAPI
  96 PeiGetVariable (
  97   IN EFI_PEI_SERVICES             **PeiServices,
  98   IN CHAR16                       *VariableName,
  99   IN EFI_GUID                     * VendorGuid,
 100   OUT UINT32                      *Attributes OPTIONAL,
 101   IN OUT UINTN                    *DataSize,
 102   OUT VOID                        *Data
 103   )
 104 /*++
 105
 106 Routine Description:
 107
 108   TODO: Add function description
 109
 110 Arguments:
 111
 112   PeiServices   - TODO: add argument description
 113   VariableName  - TODO: add argument description
 114   VendorGuid    - TODO: add argument description
 115   Attributes    - TODO: add argument description
 116   DataSize      - TODO: add argument description
 117   Data          - TODO: add argument description
 118
 119 Returns:
 120
 121   TODO: add return values
 122
 123 --*/
 124 ;
 125
 126 EFI_STATUS
 127 EFIAPI
 128 PeiGetNextVariableName (
 129   IN EFI_PEI_SERVICES             **PeiServices,
 130   IN OUT UINTN                    *VariableNameSize,
 131   IN OUT CHAR16                   *VariableName,
 132   IN OUT EFI_GUID                 *VendorGuid
 133   )
 134 /*++
 135
 136 Routine Description:
 137
 138   TODO: Add function description
 139
 140 Arguments:
 141
 142   PeiServices       - TODO: add argument description
 143   VariableNameSize  - TODO: add argument description
 144   VariableName      - TODO: add argument description
 145   VendorGuid        - TODO: add argument description
 146
 147 Returns:
 148
 149   TODO: add return values
 150
 151 --*/
 152 ;
 153
 154 #endif // _PEI_VARIABLE_H