1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
|
/*++
Copyright (c) 2004 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name:
IfrParse.h
Abstract:
Prototypes and defines for the IFR parsing services.
--*/
#ifndef _IFR_PARSE_H_
#define _IFR_PARSE_H_
#define DEFAULT_HII_PACK_FILENAME_EXTENSION ".hpk"
//
// When we parse IFR, we'll keep the IFR in a linked list of
// these.
//
typedef struct _IFR_PARSE_ENTRY {
struct _IFR_PARSE_ENTRY *Next;
int Tag; // for debugging
EFI_IFR_OP_HEADER *RawIfrHeader;
//
// GUIDs for variable storage
//
EFI_GUID *VarStoreGuid1;
char *VarStoreName1;
EFI_GUID *VarStoreGuid2;
char *VarStoreName2;
} IFR_PARSE_ENTRY;
typedef struct _IFR_PARSE_CONTEXT {
struct _IFR_PARSE_CONTEXT *Next;
EFI_HII_IFR_PACK *PackHeader;
char *IfrBufferStart;
char *CurrentPos;
long IfrBufferLen;
int Handle;
IFR_PARSE_ENTRY *Ifr;
IFR_PARSE_ENTRY *LastIfr;
IFR_PARSE_ENTRY *CurrentIfr;
FILE *OutFptr;
CHAR16 *Language;
EFI_GUID *FormsetGuid;
EFI_GUID NullGuid; // for use until we set the Guid field correctly
EFI_GUID PackageGuid; // from the PackageGuid in the HII data table
} IFR_PARSE_CONTEXT;
STATUS
IfrGetVarPack (
int VarIndex,
EFI_HII_VARIABLE_PACK **VarPack
)
/*++
Routine Description:
GC_TODO: Add function description
Arguments:
VarIndex - GC_TODO: add argument description
VarPack - GC_TODO: add argument description
Returns:
GC_TODO: add return values
--*/
;
STATUS
IfrParsePack (
int Handle,
EFI_HII_IFR_PACK *PackHeader,
EFI_GUID *PackageGuid
)
/*++
Routine Description:
GC_TODO: Add function description
Arguments:
Handle - GC_TODO: add argument description
PackHeader - GC_TODO: add argument description
PackageGuid - GC_TODO: add argument description
Returns:
GC_TODO: add return values
--*/
;
STATUS
IfrParseCheck (
char *Buffer,
long BufferSize
)
/*++
Routine Description:
GC_TODO: Add function description
Arguments:
Buffer - GC_TODO: add argument description
BufferSize - GC_TODO: add argument description
Returns:
GC_TODO: add return values
--*/
;
STATUS
IfrParseInit (
VOID
)
/*++
Routine Description:
GC_TODO: Add function description
Arguments:
None
Returns:
GC_TODO: add return values
--*/
;
STATUS
IfrParseEnd (
VOID
)
/*++
Routine Description:
GC_TODO: Add function description
Arguments:
None
Returns:
GC_TODO: add return values
--*/
;
STATUS
IfrParseDump (
int Handle,
CHAR16 *Language,
FILE *OutFptr
)
/*++
Routine Description:
GC_TODO: Add function description
Arguments:
Handle - GC_TODO: add argument description
Language - GC_TODO: add argument description
OutFptr - GC_TODO: add argument description
Returns:
GC_TODO: add return values
--*/
;
STATUS
IfrSetDefaults (
int MfgDefaults
)
/*++
Routine Description:
GC_TODO: Add function description
Arguments:
MfgDefaults - GC_TODO: add argument description
Returns:
GC_TODO: add return values
--*/
;
STATUS
IfrGetIfrPack (
int Handle,
EFI_HII_IFR_PACK **PackHeader,
EFI_GUID *FormsetGuid
)
/*++
Routine Description:
GC_TODO: Add function description
Arguments:
Handle - GC_TODO: add argument description
PackHeader - GC_TODO: add argument description
FormsetGuid - GC_TODO: add argument description
Returns:
GC_TODO: add return values
--*/
;
STATUS
IfrReferencesVarPack (
int IfrHandle,
EFI_HII_VARIABLE_PACK *VarPack
)
/*++
Routine Description:
GC_TODO: Add function description
Arguments:
IfrHandle - GC_TODO: add argument description
VarPack - GC_TODO: add argument description
Returns:
GC_TODO: add return values
--*/
;
#endif // #ifndef _IFR_PARSE_H_
|
