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
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.
18 Tiano PEIM to provide the variable functionality
22 #ifndef _PEI_VARIABLE_H
23 #define _PEI_VARIABLE_H
26 #include <Ppi/ReadOnlyVariable2.h>
27 #include <Library/DebugLib.h>
28 #include <Library/PeimEntryPoint.h>
29 #include <Library/HobLib.h>
30 #include <Library/PcdLib.h>
31 #include <Library/BaseMemoryLib.h>
32 #include <Library/PeiServicesTablePointerLib.h>
36 // BugBug: We need relcate the head file.
38 #include <Common/Variable.h>
41 // Define GET_PAD_SIZE to optimize compiler
43 #if ((ALIGNMENT == 0) || (ALIGNMENT == 1))
44 #define GET_PAD_SIZE(a) (0)
46 #define GET_PAD_SIZE(a) (((~a) + 1) & (ALIGNMENT - 1))
49 #define GET_VARIABLE_NAME_PTR(a) (CHAR16 *) ((UINTN) (a) + sizeof (VARIABLE_HEADER))
51 #define GET_VARIABLE_DATA_PTR(a) \
52 (UINT8 *) ((UINTN) GET_VARIABLE_NAME_PTR (a) + (a)->NameSize + GET_PAD_SIZE ((a)->NameSize))
55 VARIABLE_HEADER
*CurrPtr
;
56 VARIABLE_HEADER
*EndPtr
;
57 VARIABLE_HEADER
*StartPtr
;
58 } VARIABLE_POINTER_TRACK
;
60 #define VARIABLE_INDEX_TABLE_VOLUME 122
62 #define EFI_VARIABLE_INDEX_TABLE_GUID \
63 { 0x8cfdb8c8, 0xd6b2, 0x40f3, { 0x8e, 0x97, 0x02, 0x30, 0x7c, 0xc9, 0x8b, 0x7c } }
68 VARIABLE_HEADER
*EndPtr
;
69 VARIABLE_HEADER
*StartPtr
;
70 UINT16 Index
[VARIABLE_INDEX_TABLE_VOLUME
];
71 } VARIABLE_INDEX_TABLE
;
79 PeimInitializeVariableServices (
80 IN EFI_FFS_FILE_HEADER
*FfsHeader
,
81 IN EFI_PEI_SERVICES
**PeiServices
87 TODO: Add function description
91 FfsHeader - TODO: add argument description
92 PeiServices - TODO: add argument description
96 TODO: add return values
104 IN CONST EFI_PEI_READ_ONLY_VARIABLE2_PPI
*This
,
105 IN CONST CHAR16
*VariableName
,
106 IN CONST EFI_GUID
*VariableGuid
,
107 OUT UINT32
*Attributes
,
108 IN OUT UINTN
*DataSize
,
115 TODO: Add function description
119 PeiServices - TODO: add argument description
120 VariableName - TODO: add argument description
121 VendorGuid - TODO: add argument description
122 Attributes - TODO: add argument description
123 DataSize - TODO: add argument description
124 Data - TODO: add argument description
128 TODO: add return values
135 PeiGetNextVariableName (
136 IN CONST EFI_PEI_READ_ONLY_VARIABLE2_PPI
*This
,
137 IN OUT UINTN
*VariableNameSize
,
138 IN OUT CHAR16
*VariableName
,
139 IN OUT EFI_GUID
*VariableGuid
145 TODO: Add function description
149 PeiServices - TODO: add argument description
150 VariableNameSize - TODO: add argument description
151 VariableName - TODO: add argument description
152 VendorGuid - TODO: add argument description
156 TODO: add return values
162 Get one variable by the index count.
164 @param IndexTable The pointer to variable index table.
165 @param Count The index count of variable in index table.
167 @return The pointer to variable header indexed by count.
172 IN VARIABLE_INDEX_TABLE
*IndexTable
,
177 Record Variable in VariableIndex HOB.
179 Record Variable in VariableIndex HOB and update the length of variable index table.
181 @param IndexTable The pointer to variable index table.
182 @param Variable The pointer to the variable that will be recorded.
188 VariableIndexTableUpdate (
189 IN OUT VARIABLE_INDEX_TABLE
*IndexTable
,
190 IN VARIABLE_HEADER
*Variable
193 #endif // _PEI_VARIABLE_H