3 Vfr common library functions.
5 Copyright (c) 2004 - 2010, Intel Corporation
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #ifndef _VFRUTILITYLIB_H_
17 #define _VFRUTILITYLIB_H_
20 #include "Common/UefiBaseTypes.h"
24 extern BOOLEAN VfrCompatibleMode
;
26 #define MAX_NAME_LEN 64
27 #define MAX_STRING_LEN 0x100
28 #define DEFAULT_ALIGN 1
29 #define DEFAULT_PACK_ALIGN 0x8
30 #define DEFAULT_NAME_TABLE_ITEMS 1024
32 #define EFI_BITS_SHIFT_PER_UINT32 0x5
33 #define EFI_BITS_PER_UINT32 (1 << EFI_BITS_SHIFT_PER_UINT32)
35 #define BUFFER_SAFE_FREE(Buf) do { if ((Buf) != NULL) { delete (Buf); } } while (0);
37 class CVfrBinaryOutput
{
39 virtual VOID
WriteLine (IN
FILE *, IN UINT32
, IN CONST CHAR8
*, IN CHAR8
*, IN UINT32
);
40 virtual VOID
WriteEnd (IN
FILE *, IN UINT32
, IN CONST CHAR8
*, IN CHAR8
*, IN UINT32
);
54 SConfigInfo (IN UINT8
, IN UINT16
, IN UINT32
, IN EFI_IFR_TYPE_VALUE
);
59 CHAR8
*mName
; // varstore name
60 CHAR8
*mId
; // varstore ID
61 SConfigInfo
*mInfoStrList
; // list of Offset/Value in the varstore
65 SConfigItem (IN CHAR8
*, IN CHAR8
*);
66 SConfigItem (IN CHAR8
*, IN CHAR8
*, IN UINT8
, IN UINT16
, IN UINT16
, IN EFI_IFR_TYPE_VALUE
);
67 virtual ~SConfigItem ();
70 class CVfrBufferConfig
{
72 SConfigItem
*mItemListHead
;
73 SConfigItem
*mItemListTail
;
74 SConfigItem
*mItemListPos
;
77 CVfrBufferConfig (VOID
);
78 virtual ~CVfrBufferConfig (VOID
);
80 virtual UINT8
Register (IN CHAR8
*, IN CHAR8
*Info
= NULL
);
81 virtual VOID
Open (VOID
);
82 virtual BOOLEAN
Eof(VOID
);
83 virtual UINT8
Select (IN CHAR8
*, IN CHAR8
*Info
= NULL
);
84 virtual UINT8
Write (IN CONST CHAR8
, IN CHAR8
*, IN CHAR8
*, IN UINT8
, IN UINT16
, IN UINT32
, IN EFI_IFR_TYPE_VALUE
);
86 virtual UINT8
Read (OUT CHAR8
**, OUT CHAR8
**, OUT CHAR8
**, OUT CHAR8
**, OUT CHAR8
**);
88 virtual VOID
Close (VOID
);
89 virtual VOID
OutputCFile (IN
FILE *, IN CHAR8
*);
92 extern CVfrBufferConfig gCVfrBufferConfig
;
94 #define ALIGN_STUFF(Size, Align) ((Align) - (Size) % (Align))
95 #define INVALID_ARRAY_INDEX 0xFFFFFFFF
99 struct SVfrDataField
{
100 CHAR8 mFieldName
[MAX_NAME_LEN
];
101 SVfrDataType
*mFieldType
;
104 SVfrDataField
*mNext
;
107 struct SVfrDataType
{
108 CHAR8 mTypeName
[MAX_NAME_LEN
];
112 SVfrDataField
*mMembers
;
116 #define VFR_PACK_ASSIGN 0x01
117 #define VFR_PACK_SHOW 0x02
118 #define VFR_PACK_PUSH 0x04
119 #define VFR_PACK_POP 0x08
121 #define PACKSTACK_MAX_SIZE 0x400
123 struct SVfrPackStackNode
{
126 SVfrPackStackNode
*mNext
;
128 SVfrPackStackNode (IN CHAR8
*Identifier
, IN UINT32 Number
) {
133 if (Identifier
!= NULL
) {
134 mIdentifier
= new CHAR8
[strlen (Identifier
) + 1];
135 strcpy (mIdentifier
, Identifier
);
139 ~SVfrPackStackNode (VOID
) {
140 if (mIdentifier
!= NULL
) {
146 bool Match (IN CHAR8
*Identifier
) {
147 if (Identifier
== NULL
) {
149 } else if (mIdentifier
== NULL
) {
151 } else if (strcmp (Identifier
, mIdentifier
) == 0) {
159 class CVfrVarDataTypeDB
{
162 SVfrPackStackNode
*mPackStack
;
165 EFI_VFR_RETURN_CODE
Pack (IN UINT32
, IN UINT8
, IN CHAR8
*Identifier
= NULL
, IN UINT32 Number
= DEFAULT_PACK_ALIGN
);
168 SVfrDataType
*mDataTypeList
;
170 SVfrDataType
*mNewDataType
;
171 SVfrDataType
*mCurrDataType
;
172 SVfrDataField
*mCurrDataField
;
174 VOID
InternalTypesListInit (VOID
);
175 VOID
RegisterNewType (IN SVfrDataType
*);
177 EFI_VFR_RETURN_CODE
ExtractStructTypeName (IN CHAR8
*&, OUT CHAR8
*);
178 EFI_VFR_RETURN_CODE
GetTypeField (IN CHAR8
*, IN SVfrDataType
*, IN SVfrDataField
*&);
179 EFI_VFR_RETURN_CODE
GetFieldOffset (IN SVfrDataField
*, IN UINT32
, OUT UINT32
&);
180 UINT8
GetFieldWidth (IN SVfrDataField
*);
181 UINT32
GetFieldSize (IN SVfrDataField
*, IN UINT32
);
184 CVfrVarDataTypeDB (VOID
);
185 ~CVfrVarDataTypeDB (VOID
);
187 VOID
DeclareDataTypeBegin (VOID
);
188 EFI_VFR_RETURN_CODE
SetNewTypeName (IN CHAR8
*);
189 EFI_VFR_RETURN_CODE
DataTypeAddField (IN CHAR8
*, IN CHAR8
*, IN UINT32
);
190 VOID
DeclareDataTypeEnd (VOID
);
192 EFI_VFR_RETURN_CODE
GetDataType (IN CHAR8
*, OUT SVfrDataType
**);
193 EFI_VFR_RETURN_CODE
GetDataTypeSize (IN CHAR8
*, OUT UINT32
*);
194 EFI_VFR_RETURN_CODE
GetDataTypeSize (IN UINT8
, OUT UINT32
*);
195 EFI_VFR_RETURN_CODE
GetDataFieldInfo (IN CHAR8
*, OUT UINT16
&, OUT UINT8
&, OUT UINT32
&);
197 EFI_VFR_RETURN_CODE
GetUserDefinedTypeNameList (OUT CHAR8
***, OUT UINT32
*);
198 EFI_VFR_RETURN_CODE
ExtractFieldNameAndArrary (IN CHAR8
*&, OUT CHAR8
*, OUT UINT32
&);
200 BOOLEAN
IsTypeNameDefined (IN CHAR8
*);
202 VOID
Dump(IN
FILE *);
204 // First the declared
206 CHAR8
*mFirstNewDataTypeName
;
207 #ifdef CVFR_VARDATATYPEDB_DEBUG
212 extern CVfrVarDataTypeDB gCVfrVarDataTypeDB
;
215 EFI_VFR_VARSTORE_INVALID
,
216 EFI_VFR_VARSTORE_BUFFER
,
217 EFI_VFR_VARSTORE_EFI
,
218 EFI_VFR_VARSTORE_NAME
219 } EFI_VFR_VARSTORE_TYPE
;
221 struct SVfrVarStorageNode
{
223 CHAR8
*mVarStoreName
;
224 EFI_VARSTORE_ID mVarStoreId
;
225 BOOLEAN mAssignedFlag
; //Create varstore opcode
226 struct SVfrVarStorageNode
*mNext
;
228 EFI_VFR_VARSTORE_TYPE mVarStoreType
;
232 EFI_STRING_ID mEfiVarName
;
237 SVfrDataType
*mDataType
;
241 EFI_STRING_ID
*mNameTable
;
247 SVfrVarStorageNode (IN EFI_GUID
*, IN CHAR8
*, IN EFI_VARSTORE_ID
, IN EFI_STRING_ID
, IN UINT32
, IN BOOLEAN Flag
= TRUE
);
248 SVfrVarStorageNode (IN EFI_GUID
*, IN CHAR8
*, IN EFI_VARSTORE_ID
, IN SVfrDataType
*, IN BOOLEAN Flag
= TRUE
);
249 SVfrVarStorageNode (IN CHAR8
*, IN EFI_VARSTORE_ID
);
250 ~SVfrVarStorageNode (VOID
);
253 struct EFI_VARSTORE_INFO
{
254 EFI_VARSTORE_ID mVarStoreId
;
256 EFI_STRING_ID mVarName
;
260 UINT32 mVarTotalSize
;
262 EFI_VARSTORE_INFO (VOID
);
263 EFI_VARSTORE_INFO (IN EFI_VARSTORE_INFO
&);
264 BOOLEAN
operator == (IN EFI_VARSTORE_INFO
*);
267 #define EFI_VARSTORE_ID_MAX 0xFFFF
268 #define EFI_FREE_VARSTORE_ID_BITMAP_SIZE ((EFI_VARSTORE_ID_MAX + 1) / EFI_BITS_PER_UINT32)
270 class CVfrDataStorage
{
272 UINT32 mFreeVarStoreIdBitMap
[EFI_FREE_VARSTORE_ID_BITMAP_SIZE
];
274 struct SVfrVarStorageNode
*mBufferVarStoreList
;
275 struct SVfrVarStorageNode
*mEfiVarStoreList
;
276 struct SVfrVarStorageNode
*mNameVarStoreList
;
278 struct SVfrVarStorageNode
*mCurrVarStorageNode
;
279 struct SVfrVarStorageNode
*mNewVarStorageNode
;
283 EFI_VARSTORE_ID
GetFreeVarStoreId (EFI_VFR_VARSTORE_TYPE VarType
= EFI_VFR_VARSTORE_BUFFER
);
284 BOOLEAN
ChekVarStoreIdFree (IN EFI_VARSTORE_ID
);
285 VOID
MarkVarStoreIdUsed (IN EFI_VARSTORE_ID
);
286 VOID
MarkVarStoreIdUnused (IN EFI_VARSTORE_ID
);
292 SVfrVarStorageNode
* GetBufferVarStoreList () {
293 return mBufferVarStoreList
;
295 SVfrVarStorageNode
* GetEfiVarStoreList () {
296 return mEfiVarStoreList
;
298 EFI_VFR_RETURN_CODE
DeclareNameVarStoreBegin (CHAR8
*);
299 EFI_VFR_RETURN_CODE
NameTableAddItem (EFI_STRING_ID
);
300 EFI_VFR_RETURN_CODE
DeclareNameVarStoreEnd (EFI_GUID
*);
302 EFI_VFR_RETURN_CODE
DeclareEfiVarStore (IN CHAR8
*, IN EFI_GUID
*, IN EFI_STRING_ID
, IN UINT32
, IN BOOLEAN Flag
= TRUE
);
304 EFI_VFR_RETURN_CODE
DeclareBufferVarStore (IN CHAR8
*, IN EFI_GUID
*, IN CVfrVarDataTypeDB
*, IN CHAR8
*, IN EFI_VARSTORE_ID
, IN BOOLEAN Flag
= TRUE
);
306 EFI_VFR_RETURN_CODE
GetVarStoreId (IN CHAR8
*, OUT EFI_VARSTORE_ID
*);
307 EFI_VFR_RETURN_CODE
GetVarStoreType (IN CHAR8
*, OUT EFI_VFR_VARSTORE_TYPE
&);
308 EFI_VFR_VARSTORE_TYPE
GetVarStoreType (IN EFI_VARSTORE_ID
);
309 EFI_VFR_RETURN_CODE
GetVarStoreName (IN EFI_VARSTORE_ID
, OUT CHAR8
**);
311 EFI_VFR_RETURN_CODE
GetBufferVarStoreDataTypeName (IN CHAR8
*, OUT CHAR8
**);
312 EFI_VFR_RETURN_CODE
GetEfiVarStoreInfo (IN EFI_VARSTORE_INFO
*);
313 EFI_VFR_RETURN_CODE
GetNameVarStoreInfo (IN EFI_VARSTORE_INFO
*, IN UINT32
);
315 EFI_VFR_RETURN_CODE
BufferVarStoreRequestElementAdd (IN CHAR8
*, IN EFI_VARSTORE_INFO
&);
318 #define EFI_QUESTION_ID_MAX 0xFFFF
319 #define EFI_FREE_QUESTION_ID_BITMAP_SIZE ((EFI_QUESTION_ID_MAX + 1) / EFI_BITS_PER_UINT32)
320 #define EFI_QUESTION_ID_INVALID 0x0
322 #define DATE_YEAR_BITMASK 0x0000FFFF
323 #define DATE_MONTH_BITMASK 0x00FF0000
324 #define DATE_DAY_BITMASK 0xFF000000
325 #define TIME_HOUR_BITMASK 0x000000FF
326 #define TIME_MINUTE_BITMASK 0x0000FF00
327 #define TIME_SECOND_BITMASK 0x00FF0000
329 struct SVfrQuestionNode
{
332 EFI_QUESTION_ID mQuestionId
;
334 SVfrQuestionNode
*mNext
;
335 EFI_QUESION_TYPE mQtype
;
337 SVfrQuestionNode (IN CHAR8
*, IN CHAR8
*, IN UINT32 BitMask
= 0);
338 ~SVfrQuestionNode ();
341 class CVfrQuestionDB
{
343 SVfrQuestionNode
*mQuestionList
;
344 UINT32 mFreeQIdBitMap
[EFI_FREE_QUESTION_ID_BITMAP_SIZE
];
347 EFI_QUESTION_ID
GetFreeQuestionId (VOID
);
348 BOOLEAN
ChekQuestionIdFree (IN EFI_QUESTION_ID
);
349 VOID
MarkQuestionIdUsed (IN EFI_QUESTION_ID
);
350 VOID
MarkQuestionIdUnused (IN EFI_QUESTION_ID
);
356 EFI_VFR_RETURN_CODE
RegisterQuestion (IN CHAR8
*, IN CHAR8
*, IN OUT EFI_QUESTION_ID
&);
357 VOID
RegisterOldDateQuestion (IN CHAR8
*, IN CHAR8
*, IN CHAR8
*, IN OUT EFI_QUESTION_ID
&);
358 VOID
RegisterNewDateQuestion (IN CHAR8
*, IN CHAR8
*, IN OUT EFI_QUESTION_ID
&);
359 VOID
RegisterOldTimeQuestion (IN CHAR8
*, IN CHAR8
*, IN CHAR8
*, IN OUT EFI_QUESTION_ID
&);
360 VOID
RegisterNewTimeQuestion (IN CHAR8
*, IN CHAR8
*, IN OUT EFI_QUESTION_ID
&);
361 EFI_VFR_RETURN_CODE
UpdateQuestionId (IN EFI_QUESTION_ID
, IN EFI_QUESTION_ID
);
362 VOID
GetQuestionId (IN CHAR8
*, IN CHAR8
*, OUT EFI_QUESTION_ID
&, OUT UINT32
&, OUT EFI_QUESION_TYPE
*QType
= NULL
);
363 EFI_VFR_RETURN_CODE
FindQuestion (IN EFI_QUESTION_ID
);
364 EFI_VFR_RETURN_CODE
FindQuestion (IN CHAR8
*);
365 VOID
PrintAllQuestion (IN VOID
);
366 VOID
ResetInit (IN VOID
);
368 VOID
SetCompatibleMode (IN BOOLEAN Mode
) {
369 VfrCompatibleMode
= Mode
;
373 struct SVfrDefaultStoreNode
{
374 EFI_IFR_DEFAULTSTORE
*mObjBinAddr
;
376 EFI_STRING_ID mDefaultStoreNameId
;
379 SVfrDefaultStoreNode
*mNext
;
381 SVfrDefaultStoreNode (IN EFI_IFR_DEFAULTSTORE
*, IN CHAR8
*, IN EFI_STRING_ID
, IN UINT16
);
382 ~SVfrDefaultStoreNode();
385 class CVfrDefaultStore
{
387 SVfrDefaultStoreNode
*mDefaultStoreList
;
391 ~CVfrDefaultStore ();
393 EFI_VFR_RETURN_CODE
RegisterDefaultStore (IN CHAR8
*, IN CHAR8
*, IN EFI_STRING_ID
, IN UINT16
);
394 EFI_VFR_RETURN_CODE
ReRegisterDefaultStoreById (IN UINT16
, IN CHAR8
*, IN EFI_STRING_ID
);
395 BOOLEAN
DefaultIdRegistered (IN UINT16
);
396 EFI_VFR_RETURN_CODE
GetDefaultId (IN CHAR8
*, OUT UINT16
*);
397 EFI_VFR_RETURN_CODE
BufferVarStoreAltConfigAdd (IN EFI_VARSTORE_ID
, IN EFI_VARSTORE_INFO
&, IN CHAR8
*, IN UINT8
, IN EFI_IFR_TYPE_VALUE
);
400 #define EFI_RULE_ID_START 0x01
401 #define EFI_RULE_ID_INVALID 0x00
403 struct SVfrRuleNode
{
408 SVfrRuleNode(IN CHAR8
*, IN UINT8
);
414 SVfrRuleNode
*mRuleList
;
421 VOID
RegisterRule (IN CHAR8
*);
422 UINT8
GetRuleId (IN CHAR8
*);