]>
Commit | Line | Data |
---|---|---|
8d3a5c82 | 1 | /*++\r |
2 | \r | |
3 | Copyright (c) 2006 - 2007, Intel Corporation\r | |
4 | All rights reserved. This program and the accompanying materials\r | |
5 | are licensed and made available under the terms and conditions of the BSD License\r | |
6 | which accompanies this distribution. The full text of the license may be found at\r | |
7 | http://opensource.org/licenses/bsd-license.php\r | |
8 | \r | |
9 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
10 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
11 | \r | |
12 | Module Name:\r | |
13 | \r | |
14 | Variable.h\r | |
15 | \r | |
16 | Abstract:\r | |
17 | \r | |
18 | Tiano PEIM to provide the variable functionality\r | |
19 | \r | |
20 | --*/\r | |
21 | \r | |
22 | #ifndef _PEI_VARIABLE_H\r | |
23 | #define _PEI_VARIABLE_H\r | |
24 | \r | |
25 | #include <PiPei.h>\r | |
26 | #include <Ppi/ReadOnlyVariable2.h>\r | |
27 | #include <Library/DebugLib.h>\r | |
28 | #include <Library/PeimEntryPoint.h>\r | |
29 | #include <Library/HobLib.h>\r | |
30 | #include <Library/PcdLib.h>\r | |
31 | #include <Library/BaseMemoryLib.h>\r | |
32 | #include <Library/PeiServicesTablePointerLib.h>\r | |
3cfb790c | 33 | #include <VariableFormat.h>\r |
8d3a5c82 | 34 | \r |
35 | //\r | |
36 | // Define GET_PAD_SIZE to optimize compiler\r | |
37 | //\r | |
38 | #if ((ALIGNMENT == 0) || (ALIGNMENT == 1))\r | |
39 | #define GET_PAD_SIZE(a) (0)\r | |
40 | #else\r | |
41 | #define GET_PAD_SIZE(a) (((~a) + 1) & (ALIGNMENT - 1))\r | |
42 | #endif\r | |
43 | \r | |
9cad030b | 44 | #define HEADER_ALIGN(Header) (((UINTN) (Header) + HEADER_ALIGNMENT - 1) & (~(HEADER_ALIGNMENT - 1)))\r |
45 | \r | |
8d3a5c82 | 46 | #define GET_VARIABLE_NAME_PTR(a) (CHAR16 *) ((UINTN) (a) + sizeof (VARIABLE_HEADER))\r |
47 | \r | |
48 | #define GET_VARIABLE_DATA_PTR(a) \\r | |
9cad030b | 49 | (UINT8 *) ((UINTN) GET_VARIABLE_NAME_PTR (a) + NameSizeOfVariable(a) + GET_PAD_SIZE (NameSizeOfVariable(a)))\r |
8d3a5c82 | 50 | \r |
51 | typedef struct {\r | |
52 | VARIABLE_HEADER *CurrPtr;\r | |
53 | VARIABLE_HEADER *EndPtr;\r | |
54 | VARIABLE_HEADER *StartPtr;\r | |
55 | } VARIABLE_POINTER_TRACK;\r | |
56 | \r | |
57 | #define VARIABLE_INDEX_TABLE_VOLUME 122\r | |
58 | \r | |
59 | #define EFI_VARIABLE_INDEX_TABLE_GUID \\r | |
60 | { 0x8cfdb8c8, 0xd6b2, 0x40f3, { 0x8e, 0x97, 0x02, 0x30, 0x7c, 0xc9, 0x8b, 0x7c } }\r | |
61 | \r | |
62 | typedef struct {\r | |
63 | UINT16 Length;\r | |
64 | UINT16 GoneThrough;\r | |
65 | VARIABLE_HEADER *EndPtr;\r | |
66 | VARIABLE_HEADER *StartPtr;\r | |
67 | UINT16 Index[VARIABLE_INDEX_TABLE_VOLUME];\r | |
68 | } VARIABLE_INDEX_TABLE;\r | |
69 | \r | |
70 | \r | |
71 | //\r | |
72 | // Functions\r | |
73 | //\r | |
74 | EFI_STATUS\r | |
75 | EFIAPI\r | |
76 | PeimInitializeVariableServices (\r | |
77 | IN EFI_FFS_FILE_HEADER *FfsHeader,\r | |
78 | IN EFI_PEI_SERVICES **PeiServices\r | |
79 | )\r | |
80 | /*++\r | |
81 | \r | |
82 | Routine Description:\r | |
83 | \r | |
84 | TODO: Add function description\r | |
85 | \r | |
86 | Arguments:\r | |
87 | \r | |
88 | FfsHeader - TODO: add argument description\r | |
89 | PeiServices - TODO: add argument description\r | |
90 | \r | |
91 | Returns:\r | |
92 | \r | |
93 | TODO: add return values\r | |
94 | \r | |
95 | --*/\r | |
96 | ;\r | |
97 | \r | |
98 | EFI_STATUS\r | |
99 | EFIAPI\r | |
100 | PeiGetVariable (\r | |
101 | IN CONST EFI_PEI_READ_ONLY_VARIABLE2_PPI *This,\r | |
102 | IN CONST CHAR16 *VariableName,\r | |
103 | IN CONST EFI_GUID *VariableGuid,\r | |
104 | OUT UINT32 *Attributes,\r | |
105 | IN OUT UINTN *DataSize,\r | |
106 | OUT VOID *Data\r | |
107 | )\r | |
108 | /*++\r | |
109 | \r | |
110 | Routine Description:\r | |
111 | \r | |
112 | TODO: Add function description\r | |
113 | \r | |
114 | Arguments:\r | |
115 | \r | |
116 | PeiServices - TODO: add argument description\r | |
117 | VariableName - TODO: add argument description\r | |
118 | VendorGuid - TODO: add argument description\r | |
119 | Attributes - TODO: add argument description\r | |
120 | DataSize - TODO: add argument description\r | |
121 | Data - TODO: add argument description\r | |
122 | \r | |
123 | Returns:\r | |
124 | \r | |
125 | TODO: add return values\r | |
126 | \r | |
127 | --*/\r | |
128 | ;\r | |
129 | \r | |
130 | EFI_STATUS\r | |
131 | EFIAPI\r | |
132 | PeiGetNextVariableName (\r | |
133 | IN CONST EFI_PEI_READ_ONLY_VARIABLE2_PPI *This,\r | |
134 | IN OUT UINTN *VariableNameSize,\r | |
135 | IN OUT CHAR16 *VariableName,\r | |
136 | IN OUT EFI_GUID *VariableGuid\r | |
137 | )\r | |
138 | /*++\r | |
139 | \r | |
140 | Routine Description:\r | |
141 | \r | |
142 | TODO: Add function description\r | |
143 | \r | |
144 | Arguments:\r | |
145 | \r | |
146 | PeiServices - TODO: add argument description\r | |
147 | VariableNameSize - TODO: add argument description\r | |
148 | VariableName - TODO: add argument description\r | |
149 | VendorGuid - TODO: add argument description\r | |
150 | \r | |
151 | Returns:\r | |
152 | \r | |
153 | TODO: add return values\r | |
154 | \r | |
155 | --*/\r | |
156 | ;\r | |
157 | \r | |
158 | /**\r | |
159 | Get one variable by the index count.\r | |
160 | \r | |
161 | @param IndexTable The pointer to variable index table.\r | |
162 | @param Count The index count of variable in index table.\r | |
163 | \r | |
164 | @return The pointer to variable header indexed by count.\r | |
165 | \r | |
166 | **/\r | |
167 | VARIABLE_HEADER *\r | |
168 | GetVariableByIndex (\r | |
169 | IN VARIABLE_INDEX_TABLE *IndexTable,\r | |
170 | IN UINT32 Count\r | |
171 | );\r | |
172 | \r | |
173 | /**\r | |
174 | Record Variable in VariableIndex HOB.\r | |
175 | \r | |
176 | Record Variable in VariableIndex HOB and update the length of variable index table.\r | |
177 | \r | |
178 | @param IndexTable The pointer to variable index table.\r | |
179 | @param Variable The pointer to the variable that will be recorded.\r | |
180 | \r | |
181 | @retval VOID\r | |
182 | \r | |
183 | **/\r | |
184 | VOID\r | |
185 | VariableIndexTableUpdate (\r | |
186 | IN OUT VARIABLE_INDEX_TABLE *IndexTable,\r | |
187 | IN VARIABLE_HEADER *Variable\r | |
188 | );\r | |
189 | \r | |
190 | #endif // _PEI_VARIABLE_H\r |