[mirror_edk2.git] / EdkCompatibilityPkg / Sample / Tools / Source / UefiVfrCompile / VfrUtilityLib.h

/*++\r
Copyright (c) 2004 - 2010, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
Module Name:\r
  VfrUtilityLib.h\r
\r
Abstract:\r
\r
--*/\r
\r
#ifndef _VFRUTILITYLIB_H_\r
#define _VFRUTILITYLIB_H_\r
\r
#include "Tiano.h"\r
#include "string.h"\r
#include "EfiTypes.h"\r
#include "EfiVfr.h"\r
#include "VfrError.h"\r
\r
#define MAX_NAME_LEN                       64\r
#define DEFAULT_ALIGN                      1\r
#define DEFAULT_PACK_ALIGN                 0x8\r
#define DEFAULT_NAME_TABLE_ITEMS           1024\r
\r
#define EFI_BITS_SHIFT_PER_UINT32          0x5\r
#define EFI_BITS_PER_UINT32                (1 << EFI_BITS_SHIFT_PER_UINT32)\r
\r
#define BUFFER_SAFE_FREE(Buf)              do { if ((Buf) != NULL) { delete (Buf); } } while (0);\r
\r
class CVfrBinaryOutput {\r
public:\r
  virtual VOID WriteLine (IN FILE *, IN UINT32, IN INT8 *, IN INT8 *, IN UINT32);\r
  virtual VOID WriteEnd (IN FILE *, IN UINT32, IN INT8 *, IN INT8 *, IN UINT32);\r
};\r
\r
UINT32\r
_STR2U32 (\r
  IN INT8 *Str\r
  );\r
\r
struct SConfigInfo {\r
  UINT16             mOffset;\r
  UINT16             mWidth;\r
  UINT8              *mValue;\r
  SConfigInfo        *mNext;\r
\r
  SConfigInfo (IN UINT8, IN UINT16, IN UINT32, IN EFI_IFR_TYPE_VALUE);\r
  ~SConfigInfo (VOID);\r
};\r
\r
struct SConfigItem {\r
  INT8          *mName;         // varstore name\r
  INT8          *mId;           // varstore ID\r
  SConfigInfo   *mInfoStrList;  // list of Offset/Value in the varstore\r
  SConfigItem   *mNext;\r
\r
public:\r
  SConfigItem (IN INT8 *, IN INT8 *);\r
  SConfigItem (IN INT8 *, IN INT8 *, IN UINT8, IN UINT16, IN UINT16, IN EFI_IFR_TYPE_VALUE);\r
  virtual ~SConfigItem ();\r
};\r
\r
class CVfrBufferConfig {\r
private:\r
  SConfigItem *mItemListHead;\r
  SConfigItem *mItemListTail;\r
  SConfigItem *mItemListPos;\r
\r
public:\r
  CVfrBufferConfig (VOID);\r
  virtual ~CVfrBufferConfig (VOID);\r
\r
  virtual UINT8   Register (IN INT8 *, IN INT8 *Info = NULL);\r
  virtual VOID    Open (VOID);\r
  virtual BOOLEAN Eof(VOID);\r
  virtual UINT8   Select (IN INT8 *, IN INT8 *Info = NULL);\r
  virtual UINT8   Write (IN CONST CHAR8, IN INT8 *, IN INT8 *, IN UINT8, IN UINT16, IN UINT32, IN EFI_IFR_TYPE_VALUE);\r
#if 0\r
  virtual UINT8   Read (OUT INT8 **, OUT INT8 **, OUT INT8 **, OUT INT8 **, OUT INT8 **);\r
#endif\r
  virtual VOID    Close (VOID);\r
  virtual VOID    OutputCFile (IN FILE *, IN INT8 *);\r
};\r
\r
extern CVfrBufferConfig gCVfrBufferConfig;\r
\r
#define ALIGN_STUFF(Size, Align) ((Align) - (Size) % (Align))\r
#define INVALID_ARRAY_INDEX      0xFFFFFFFF\r
\r
struct SVfrDataType;\r
\r
struct SVfrDataField {\r
  INT8                      mFieldName[MAX_NAME_LEN];\r
  SVfrDataType              *mFieldType;\r
  UINT32                    mOffset;\r
  UINT32                    mArrayNum;\r
  SVfrDataField             *mNext;\r
};\r
\r
struct SVfrDataType {\r
  INT8                      mTypeName[MAX_NAME_LEN];\r
  UINT8                     mType;\r
  UINT32                    mAlign;\r
  UINT32                    mTotalSize;\r
  SVfrDataField             *mMembers;\r
  SVfrDataType              *mNext;\r
};\r
\r
#define VFR_PACK_ASSIGN     0x01\r
#define VFR_PACK_SHOW       0x02\r
#define VFR_PACK_PUSH       0x04\r
#define VFR_PACK_POP        0x08\r
\r
#define PACKSTACK_MAX_SIZE  0x400\r
\r
struct SVfrPackStackNode {\r
  INT8                      *mIdentifier;\r
  UINT32                    mNumber;\r
  SVfrPackStackNode         *mNext;\r
\r
  SVfrPackStackNode (IN INT8 *Identifier, IN UINT32 Number) {\r
    mIdentifier = NULL;\r
    mNumber     = Number;\r
    mNext       = NULL;\r
\r
    if (Identifier != NULL) {\r
      mIdentifier = new INT8[strlen (Identifier) + 1];\r
      strcpy (mIdentifier, Identifier);\r
    }\r
  }\r
\r
  ~SVfrPackStackNode (VOID) {\r
    if (mIdentifier != NULL) {\r
      delete mIdentifier;\r
    }\r
    mNext = NULL;\r
  }\r
\r
  bool Match (IN INT8 *Identifier) {\r
    if (Identifier == NULL) {\r
      return TRUE;\r
    } else if (mIdentifier == NULL) {\r
      return FALSE;\r
    } else if (strcmp (Identifier, mIdentifier) == 0) {\r
      return TRUE;\r
    } else {\r
      return FALSE;\r
    }\r
  }\r
};\r
\r
class CVfrVarDataTypeDB {\r
private:\r
  UINT32                    mPackAlign;\r
  SVfrPackStackNode         *mPackStack;\r
\r
public:\r
  EFI_VFR_RETURN_CODE       Pack (IN UINT32, IN UINT8, IN INT8 *Identifier = NULL, IN UINT32 Number = DEFAULT_PACK_ALIGN);\r
\r
private:\r
  SVfrDataType              *mDataTypeList;\r
\r
  SVfrDataType              *mNewDataType;\r
  SVfrDataType              *mCurrDataType;\r
  SVfrDataField             *mCurrDataField;\r
\r
  VOID InternalTypesListInit (VOID);\r
  VOID RegisterNewType (IN SVfrDataType *);\r
\r
  EFI_VFR_RETURN_CODE ExtractStructTypeName (IN INT8 *&, OUT INT8 *);\r
  EFI_VFR_RETURN_CODE ExtractFieldNameAndArrary (IN INT8 *&, OUT INT8 *, OUT UINT32 &);\r
  EFI_VFR_RETURN_CODE GetTypeField (IN INT8 *, IN SVfrDataType *, IN SVfrDataField *&);\r
  EFI_VFR_RETURN_CODE GetFieldOffset (IN SVfrDataField *, IN UINT32, OUT UINT32 &);\r
  UINT8               GetFieldWidth (IN SVfrDataField *);\r
  UINT32              GetFieldSize (IN SVfrDataField *, IN UINT32);\r
\r
public:\r
  CVfrVarDataTypeDB (VOID);\r
  ~CVfrVarDataTypeDB (VOID);\r
\r
  VOID                DeclareDataTypeBegin (VOID);\r
  EFI_VFR_RETURN_CODE SetNewTypeName (IN INT8 *);\r
  EFI_VFR_RETURN_CODE DataTypeAddField (IN INT8 *, IN INT8 *, IN UINT32);\r
  VOID                DeclareDataTypeEnd (VOID);\r
\r
  EFI_VFR_RETURN_CODE GetDataType (IN INT8 *, OUT SVfrDataType **);\r
  EFI_VFR_RETURN_CODE GetDataTypeSize (IN INT8 *, OUT UINT32 *);\r
  EFI_VFR_RETURN_CODE GetDataTypeSize (IN UINT8, OUT UINT32 *);\r
  EFI_VFR_RETURN_CODE GetDataFieldInfo (IN INT8 *, OUT UINT16 &, OUT UINT8 &, OUT UINT32 &);\r
\r
  EFI_VFR_RETURN_CODE GetUserDefinedTypeNameList (OUT INT8 ***, OUT UINT32 *);\r
  BOOLEAN             IsTypeNameDefined (IN INT8 *);\r
\r
#ifdef CVFR_VARDATATYPEDB_DEBUG\r
  VOID ParserDB ();\r
#endif\r
};\r
\r
typedef enum {\r
  EFI_VFR_VARSTORE_INVALID,\r
  EFI_VFR_VARSTORE_BUFFER,\r
  EFI_VFR_VARSTORE_EFI,\r
  EFI_VFR_VARSTORE_NAME\r
} EFI_VFR_VARSTORE_TYPE;\r
\r
struct SVfrVarStorageNode {\r
  EFI_GUID                  mGuid;\r
  INT8                      *mVarStoreName;\r
  EFI_VARSTORE_ID           mVarStoreId;\r
  struct SVfrVarStorageNode *mNext;\r
\r
  EFI_VFR_VARSTORE_TYPE     mVarStoreType;\r
  union {\r
    // EFI Variable\r
    struct {\r
      EFI_STRING_ID           mEfiVarName;\r
      UINT32                  mEfiVarSize;\r
    } mEfiVar;\r
\r
    // Buffer Storage\r
    SVfrDataType            *mDataType;\r
\r
    // NameValue Storage\r
	struct {\r
      EFI_STRING_ID         *mNameTable;\r
      UINT32                mTableSize;\r
    } mNameSpace;\r
  } mStorageInfo;\r
\r
public:\r
  SVfrVarStorageNode (IN EFI_GUID *, IN INT8 *, IN EFI_VARSTORE_ID, IN EFI_STRING_ID, IN UINT32);\r
  SVfrVarStorageNode (IN EFI_GUID *, IN INT8 *, IN EFI_VARSTORE_ID, IN SVfrDataType *);\r
  SVfrVarStorageNode (IN INT8 *, IN EFI_VARSTORE_ID);\r
  ~SVfrVarStorageNode (VOID);\r
};\r
\r
struct EFI_VARSTORE_INFO {\r
  EFI_VARSTORE_ID           mVarStoreId;\r
  union {\r
    EFI_STRING_ID           mVarName;\r
    UINT16                  mVarOffset;\r
  } mInfo;\r
  UINT8                     mVarType;\r
  UINT32                    mVarTotalSize;\r
\r
  EFI_VARSTORE_INFO (VOID);\r
  EFI_VARSTORE_INFO (IN EFI_VARSTORE_INFO &);\r
  BOOLEAN operator == (IN EFI_VARSTORE_INFO *);\r
};\r
\r
#define EFI_VARSTORE_ID_MAX              0xFFFF\r
#define EFI_FREE_VARSTORE_ID_BITMAP_SIZE ((EFI_VARSTORE_ID_MAX + 1) / EFI_BITS_PER_UINT32)\r
\r
class CVfrDataStorage {\r
private:\r
  UINT32                    mFreeVarStoreIdBitMap[EFI_FREE_VARSTORE_ID_BITMAP_SIZE];\r
\r
  struct SVfrVarStorageNode *mBufferVarStoreList;\r
  struct SVfrVarStorageNode *mEfiVarStoreList;\r
  struct SVfrVarStorageNode *mNameVarStoreList;\r
\r
  struct SVfrVarStorageNode *mCurrVarStorageNode;\r
  struct SVfrVarStorageNode *mNewVarStorageNode;\r
\r
private:\r
\r
  EFI_VARSTORE_ID GetFreeVarStoreId (VOID);\r
  BOOLEAN         ChekVarStoreIdFree (IN EFI_VARSTORE_ID);\r
  VOID            MarkVarStoreIdUsed (IN EFI_VARSTORE_ID);\r
  VOID            MarkVarStoreIdUnused (IN EFI_VARSTORE_ID);\r
\r
public:\r
  CVfrDataStorage ();\r
  ~CVfrDataStorage ();\r
\r
  EFI_VFR_RETURN_CODE DeclareNameVarStoreBegin (INT8 *);\r
  EFI_VFR_RETURN_CODE NameTableAddItem (EFI_STRING_ID);\r
  EFI_VFR_RETURN_CODE DeclareNameVarStoreEnd (EFI_GUID *);\r
\r
  EFI_VFR_RETURN_CODE DeclareEfiVarStore (IN INT8 *, IN EFI_GUID *, IN EFI_STRING_ID, IN UINT32);\r
\r
  EFI_VFR_RETURN_CODE DeclareBufferVarStore (IN INT8 *, IN EFI_GUID *, IN CVfrVarDataTypeDB *, IN INT8 *, IN EFI_VARSTORE_ID);\r
\r
  EFI_VFR_RETURN_CODE GetVarStoreId (IN INT8 *, OUT EFI_VARSTORE_ID *);\r
  EFI_VFR_RETURN_CODE GetVarStoreType (IN INT8 *, OUT EFI_VFR_VARSTORE_TYPE &);\r
  EFI_VFR_VARSTORE_TYPE GetVarStoreType (IN EFI_VARSTORE_ID);\r
  EFI_VFR_RETURN_CODE GetVarStoreName (IN EFI_VARSTORE_ID, OUT INT8 **);\r
\r
  EFI_VFR_RETURN_CODE GetBufferVarStoreDataTypeName (IN INT8 *, OUT INT8 **);\r
  EFI_VFR_RETURN_CODE GetEfiVarStoreInfo (IN EFI_VARSTORE_INFO *);\r
  EFI_VFR_RETURN_CODE GetNameVarStoreInfo (IN EFI_VARSTORE_INFO *, IN UINT32);\r
\r
  EFI_VFR_RETURN_CODE BufferVarStoreRequestElementAdd (IN INT8 *, IN EFI_VARSTORE_INFO &);\r
};\r
\r
#define EFI_QUESTION_ID_MAX              0xFFFF\r
#define EFI_FREE_QUESTION_ID_BITMAP_SIZE ((EFI_QUESTION_ID_MAX + 1) / EFI_BITS_PER_UINT32)\r
#define EFI_QUESTION_ID_INVALID          0x0\r
\r
#define DATE_YEAR_BITMASK                0x0000FFFF\r
#define DATE_MONTH_BITMASK               0x00FF0000\r
#define DATE_DAY_BITMASK                 0xFF000000\r
#define TIME_HOUR_BITMASK                0x000000FF\r
#define TIME_MINUTE_BITMASK              0x0000FF00\r
#define TIME_SECOND_BITMASK              0x00FF0000\r
\r
struct SVfrQuestionNode {\r
  INT8                      *mName;\r
  INT8                      *mVarIdStr;\r
  EFI_QUESTION_ID           mQuestionId;\r
  UINT32                    mBitMask;\r
  SVfrQuestionNode          *mNext;\r
\r
  SVfrQuestionNode (IN INT8 *, IN INT8 *, IN UINT32 BitMask = 0);\r
  ~SVfrQuestionNode ();\r
};\r
\r
class CVfrQuestionDB {\r
private:\r
  SVfrQuestionNode          *mQuestionList;\r
  UINT32                    mFreeQIdBitMap[EFI_FREE_QUESTION_ID_BITMAP_SIZE];\r
\r
private:\r
  EFI_QUESTION_ID GetFreeQuestionId (VOID);\r
  BOOLEAN         ChekQuestionIdFree (IN EFI_QUESTION_ID);\r
  VOID            MarkQuestionIdUsed (IN EFI_QUESTION_ID);\r
  VOID            MarkQuestionIdUnused (IN EFI_QUESTION_ID);\r
\r
public:\r
  CVfrQuestionDB ();\r
  ~CVfrQuestionDB();\r
\r
  EFI_VFR_RETURN_CODE RegisterQuestion (IN INT8 *, IN INT8 *, IN OUT EFI_QUESTION_ID &);\r
  VOID                RegisterOldDateQuestion (IN INT8 *, IN INT8 *, IN INT8 *, IN OUT EFI_QUESTION_ID &);\r
  VOID                RegisterNewDateQuestion (IN INT8 *, IN INT8 *, IN OUT EFI_QUESTION_ID &);\r
  VOID                RegisterOldTimeQuestion (IN INT8 *, IN INT8 *, IN INT8 *, IN OUT EFI_QUESTION_ID &);\r
  VOID                RegisterNewTimeQuestion (IN INT8 *, IN INT8 *, IN OUT EFI_QUESTION_ID &);\r
  EFI_VFR_RETURN_CODE UpdateQuestionId (IN EFI_QUESTION_ID, IN EFI_QUESTION_ID);\r
  VOID                GetQuestionId (IN INT8 *, IN INT8 *, OUT EFI_QUESTION_ID &, OUT UINT32 &);\r
  EFI_VFR_RETURN_CODE FindQuestion (IN EFI_QUESTION_ID);\r
  EFI_VFR_RETURN_CODE FindQuestion (IN INT8 *);\r
 };\r
\r
struct SVfrDefaultStoreNode {\r
  EFI_IFR_DEFAULTSTORE      *mObjBinAddr;\r
  INT8                      *mRefName;\r
  EFI_STRING_ID             mDefaultStoreNameId;\r
  UINT16                    mDefaultId;\r
\r
  SVfrDefaultStoreNode      *mNext;\r
\r
  SVfrDefaultStoreNode (IN EFI_IFR_DEFAULTSTORE *, IN INT8 *, IN EFI_STRING_ID, IN UINT16);\r
  ~SVfrDefaultStoreNode();\r
};\r
\r
class CVfrDefaultStore {\r
private:\r
  SVfrDefaultStoreNode      *mDefaultStoreList;\r
\r
public:\r
  CVfrDefaultStore ();\r
  ~CVfrDefaultStore ();\r
\r
  EFI_VFR_RETURN_CODE RegisterDefaultStore (IN CHAR8 *, IN INT8 *, IN EFI_STRING_ID, IN UINT16);\r
  EFI_VFR_RETURN_CODE ReRegisterDefaultStoreById (IN UINT16, IN INT8 *, IN EFI_STRING_ID);\r
  BOOLEAN             DefaultIdRegistered (IN UINT16);\r
  EFI_VFR_RETURN_CODE GetDefaultId (IN INT8 *, OUT UINT16 *);\r
  EFI_VFR_RETURN_CODE BufferVarStoreAltConfigAdd (IN EFI_VARSTORE_ID, IN EFI_VARSTORE_INFO &, IN INT8 *, IN UINT8, IN EFI_IFR_TYPE_VALUE);\r
};\r
\r
#define EFI_RULE_ID_START    0x01\r
#define EFI_RULE_ID_INVALID  0x00\r
\r
struct SVfrRuleNode {\r
  UINT8                     mRuleId;\r
  INT8                      *mRuleName;\r
  SVfrRuleNode              *mNext;\r
\r
  SVfrRuleNode(IN INT8 *, IN UINT8);\r
  ~SVfrRuleNode();\r
};\r
\r
class CVfrRulesDB {\r
private:\r
  SVfrRuleNode              *mRuleList;\r
  UINT8                     mFreeRuleId;\r
\r
public:\r
  CVfrRulesDB ();\r
  ~CVfrRulesDB();\r
\r
  VOID RegisterRule (IN INT8 *);\r
  UINT8 GetRuleId (IN INT8 *);\r
};\r
\r
#define MIN(v1, v2) (((v1) < (v2)) ? (v1) : (v2))\r
#define MAX(v1, v2) (((v1) > (v2)) ? (v1) : (v2))\r
\r
#endif\r
Commit	Line	Data
5b19df7f	1	/*++\r
4b1e1121 HT	2	Copyright (c) 2004 - 2010, Intel Corporation. All rights reserved.<BR>\r
4b1e1121 HT	3	This program and the accompanying materials\r
5b19df7f LG	4	are licensed and made available under the terms and conditions of the BSD License\r
	5	which accompanies this distribution. The full text of the license may be found at\r
	6	http://opensource.org/licenses/bsd-license.php\r
	7	\r
	8	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	9	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	10	\r
	11	Module Name:\r
3e99020d	12	VfrUtilityLib.h\r
5b19df7f LG	13	\r
	14	Abstract:\r
	15	\r
	16	--*/\r
	17	\r
95d675b5	18	#ifndef _VFRUTILITYLIB_H_\r
	19	#define _VFRUTILITYLIB_H_\r
	20	\r
	21	#include "Tiano.h"\r
	22	#include "string.h"\r
	23	#include "EfiTypes.h"\r
	24	#include "EfiVfr.h"\r
	25	#include "VfrError.h"\r
	26	\r
	27	#define MAX_NAME_LEN 64\r
	28	#define DEFAULT_ALIGN 1\r
3e99020d	29	#define DEFAULT_PACK_ALIGN 0x8\r
95d675b5	30	#define DEFAULT_NAME_TABLE_ITEMS 1024\r
	31	\r
	32	#define EFI_BITS_SHIFT_PER_UINT32 0x5\r
	33	#define EFI_BITS_PER_UINT32 (1 << EFI_BITS_SHIFT_PER_UINT32)\r
	34	\r
	35	#define BUFFER_SAFE_FREE(Buf) do { if ((Buf) != NULL) { delete (Buf); } } while (0);\r
	36	\r
	37	class CVfrBinaryOutput {\r
	38	public:\r
	39	virtual VOID WriteLine (IN FILE , IN UINT32, IN INT8 , IN INT8 *, IN UINT32);\r
	40	virtual VOID WriteEnd (IN FILE , IN UINT32, IN INT8 , IN INT8 *, IN UINT32);\r
	41	};\r
	42	\r
	43	UINT32\r
	44	_STR2U32 (\r
	45	IN INT8 *Str\r
	46	);\r
	47	\r
	48	struct SConfigInfo {\r
	49	UINT16 mOffset;\r
	50	UINT16 mWidth;\r
	51	UINT8 *mValue;\r
	52	SConfigInfo *mNext;\r
	53	\r
	54	SConfigInfo (IN UINT8, IN UINT16, IN UINT32, IN EFI_IFR_TYPE_VALUE);\r
	55	~SConfigInfo (VOID);\r
	56	};\r
	57	\r
	58	struct SConfigItem {\r
3e99020d LG	59	INT8 *mName; // varstore name\r
	60	INT8 *mId; // varstore ID\r
	61	SConfigInfo *mInfoStrList; // list of Offset/Value in the varstore\r
95d675b5	62	SConfigItem *mNext;\r
	63	\r
	64	public:\r
	65	SConfigItem (IN INT8 , IN INT8 );\r
	66	SConfigItem (IN INT8 , IN INT8 , IN UINT8, IN UINT16, IN UINT16, IN EFI_IFR_TYPE_VALUE);\r
	67	virtual ~SConfigItem ();\r
	68	};\r
	69	\r
	70	class CVfrBufferConfig {\r
	71	private:\r
	72	SConfigItem *mItemListHead;\r
	73	SConfigItem *mItemListTail;\r
	74	SConfigItem *mItemListPos;\r
	75	\r
	76	public:\r
	77	CVfrBufferConfig (VOID);\r
	78	virtual ~CVfrBufferConfig (VOID);\r
	79	\r
	80	virtual UINT8 Register (IN INT8 , IN INT8 Info = NULL);\r
	81	virtual VOID Open (VOID);\r
	82	virtual BOOLEAN Eof(VOID);\r
	83	virtual UINT8 Select (IN INT8 , IN INT8 Info = NULL);\r
	84	virtual UINT8 Write (IN CONST CHAR8, IN INT8 , IN INT8 , IN UINT8, IN UINT16, IN UINT32, IN EFI_IFR_TYPE_VALUE);\r
	85	#if 0\r
	86	virtual UINT8 Read (OUT INT8 , OUT INT8 , OUT INT8 , OUT INT8 , OUT INT8 **);\r
	87	#endif\r
	88	virtual VOID Close (VOID);\r
	89	virtual VOID OutputCFile (IN FILE , IN INT8 );\r
	90	};\r
	91	\r
	92	extern CVfrBufferConfig gCVfrBufferConfig;\r
	93	\r
	94	#define ALIGN_STUFF(Size, Align) ((Align) - (Size) % (Align))\r
	95	#define INVALID_ARRAY_INDEX 0xFFFFFFFF\r
	96	\r
	97	struct SVfrDataType;\r
	98	\r
	99	struct SVfrDataField {\r
	100	INT8 mFieldName[MAX_NAME_LEN];\r
	101	SVfrDataType *mFieldType;\r
	102	UINT32 mOffset;\r
	103	UINT32 mArrayNum;\r
	104	SVfrDataField *mNext;\r
	105	};\r
	106	\r
	107	struct SVfrDataType {\r
	108	INT8 mTypeName[MAX_NAME_LEN];\r
	109	UINT8 mType;\r
	110	UINT32 mAlign;\r
	111	UINT32 mTotalSize;\r
	112	SVfrDataField *mMembers;\r
	113	SVfrDataType *mNext;\r
	114	};\r
	115	\r
3e99020d LG	116	#define VFR_PACK_ASSIGN 0x01\r
	117	#define VFR_PACK_SHOW 0x02\r
	118	#define VFR_PACK_PUSH 0x04\r
	119	#define VFR_PACK_POP 0x08\r
	120	\r
	121	#define PACKSTACK_MAX_SIZE 0x400\r
	122	\r
	123	struct SVfrPackStackNode {\r
	124	INT8 *mIdentifier;\r
	125	UINT32 mNumber;\r
	126	SVfrPackStackNode *mNext;\r
	127	\r
	128	SVfrPackStackNode (IN INT8 *Identifier, IN UINT32 Number) {\r
	129	mIdentifier = NULL;\r
	130	mNumber = Number;\r
	131	mNext = NULL;\r
	132	\r
	133	if (Identifier != NULL) {\r
	134	mIdentifier = new INT8[strlen (Identifier) + 1];\r
	135	strcpy (mIdentifier, Identifier);\r
	136	}\r
	137	}\r
	138	\r
	139	~SVfrPackStackNode (VOID) {\r
	140	if (mIdentifier != NULL) {\r
	141	delete mIdentifier;\r
	142	}\r
	143	mNext = NULL;\r
	144	}\r
	145	\r
	146	bool Match (IN INT8 *Identifier) {\r
	147	if (Identifier == NULL) {\r
	148	return TRUE;\r
	149	} else if (mIdentifier == NULL) {\r
	150	return FALSE;\r
	151	} else if (strcmp (Identifier, mIdentifier) == 0) {\r
	152	return TRUE;\r
	153	} else {\r
	154	return FALSE;\r
	155	}\r
	156	}\r
	157	};\r
	158	\r
95d675b5	159	class CVfrVarDataTypeDB {\r
95d675b5	160	private:\r
95d675b5	161	UINT32 mPackAlign;\r
3e99020d LG	162	SVfrPackStackNode *mPackStack;\r
	163	\r
	164	public:\r
	165	EFI_VFR_RETURN_CODE Pack (IN UINT32, IN UINT8, IN INT8 *Identifier = NULL, IN UINT32 Number = DEFAULT_PACK_ALIGN);\r
	166	\r
	167	private:\r
	168	SVfrDataType *mDataTypeList;\r
95d675b5	169	\r
	170	SVfrDataType *mNewDataType;\r
	171	SVfrDataType *mCurrDataType;\r
	172	SVfrDataField *mCurrDataField;\r
	173	\r
	174	VOID InternalTypesListInit (VOID);\r
	175	VOID RegisterNewType (IN SVfrDataType *);\r
	176	\r
	177	EFI_VFR_RETURN_CODE ExtractStructTypeName (IN INT8 &, OUT INT8 );\r
	178	EFI_VFR_RETURN_CODE ExtractFieldNameAndArrary (IN INT8 &, OUT INT8 , OUT UINT32 &);\r
	179	EFI_VFR_RETURN_CODE GetTypeField (IN INT8 , IN SVfrDataType , IN SVfrDataField *&);\r
	180	EFI_VFR_RETURN_CODE GetFieldOffset (IN SVfrDataField *, IN UINT32, OUT UINT32 &);\r
	181	UINT8 GetFieldWidth (IN SVfrDataField *);\r
	182	UINT32 GetFieldSize (IN SVfrDataField *, IN UINT32);\r
	183	\r
	184	public:\r
	185	CVfrVarDataTypeDB (VOID);\r
	186	~CVfrVarDataTypeDB (VOID);\r
	187	\r
95d675b5	188	VOID DeclareDataTypeBegin (VOID);\r
	189	EFI_VFR_RETURN_CODE SetNewTypeName (IN INT8 *);\r
	190	EFI_VFR_RETURN_CODE DataTypeAddField (IN INT8 , IN INT8 , IN UINT32);\r
	191	VOID DeclareDataTypeEnd (VOID);\r
	192	\r
	193	EFI_VFR_RETURN_CODE GetDataType (IN INT8 , OUT SVfrDataType *);\r
	194	EFI_VFR_RETURN_CODE GetDataTypeSize (IN INT8 , OUT UINT32 );\r
3e99020d	195	EFI_VFR_RETURN_CODE GetDataTypeSize (IN UINT8, OUT UINT32 *);\r
95d675b5	196	EFI_VFR_RETURN_CODE GetDataFieldInfo (IN INT8 *, OUT UINT16 &, OUT UINT8 &, OUT UINT32 &);\r
	197	\r
	198	EFI_VFR_RETURN_CODE GetUserDefinedTypeNameList (OUT INT8 **, OUT UINT32 );\r
	199	BOOLEAN IsTypeNameDefined (IN INT8 *);\r
	200	\r
	201	#ifdef CVFR_VARDATATYPEDB_DEBUG\r
	202	VOID ParserDB ();\r
	203	#endif\r
	204	};\r
	205	\r
	206	typedef enum {\r
	207	EFI_VFR_VARSTORE_INVALID,\r
	208	EFI_VFR_VARSTORE_BUFFER,\r
	209	EFI_VFR_VARSTORE_EFI,\r
	210	EFI_VFR_VARSTORE_NAME\r
	211	} EFI_VFR_VARSTORE_TYPE;\r
	212	\r
	213	struct SVfrVarStorageNode {\r
	214	EFI_GUID mGuid;\r
	215	INT8 *mVarStoreName;\r
	216	EFI_VARSTORE_ID mVarStoreId;\r
	217	struct SVfrVarStorageNode *mNext;\r
	218	\r
	219	EFI_VFR_VARSTORE_TYPE mVarStoreType;\r
	220	union {\r
	221	// EFI Variable\r
	222	struct {\r
	223	EFI_STRING_ID mEfiVarName;\r
	224	UINT32 mEfiVarSize;\r
	225	} mEfiVar;\r
	226	\r
	227	// Buffer Storage\r
	228	SVfrDataType *mDataType;\r
	229	\r
	230	// NameValue Storage\r
	231	struct {\r
	232	EFI_STRING_ID *mNameTable;\r
	233	UINT32 mTableSize;\r
	234	} mNameSpace;\r
	235	} mStorageInfo;\r
	236	\r
	237	public:\r
	238	SVfrVarStorageNode (IN EFI_GUID , IN INT8 , IN EFI_VARSTORE_ID, IN EFI_STRING_ID, IN UINT32);\r
	239	SVfrVarStorageNode (IN EFI_GUID , IN INT8 , IN EFI_VARSTORE_ID, IN SVfrDataType *);\r
	240	SVfrVarStorageNode (IN INT8 *, IN EFI_VARSTORE_ID);\r
	241	~SVfrVarStorageNode (VOID);\r
	242	};\r
	243	\r
	244	struct EFI_VARSTORE_INFO {\r
	245	EFI_VARSTORE_ID mVarStoreId;\r
	246	union {\r
	247	EFI_STRING_ID mVarName;\r
	248	UINT16 mVarOffset;\r
	249	} mInfo;\r
	250	UINT8 mVarType;\r
	251	UINT32 mVarTotalSize;\r
	252	\r
	253	EFI_VARSTORE_INFO (VOID);\r
	254	EFI_VARSTORE_INFO (IN EFI_VARSTORE_INFO &);\r
	255	BOOLEAN operator == (IN EFI_VARSTORE_INFO *);\r
	256	};\r
	257	\r
	258	#define EFI_VARSTORE_ID_MAX 0xFFFF\r
	259	#define EFI_FREE_VARSTORE_ID_BITMAP_SIZE ((EFI_VARSTORE_ID_MAX + 1) / EFI_BITS_PER_UINT32)\r
260	\r
261	class CVfrDataStorage {\r
262	private:\r
263	UINT32 mFreeVarStoreIdBitMap[EFI_FREE_VARSTORE_ID_BITMAP_SIZE];\r
264	\r
265	struct SVfrVarStorageNode *mBufferVarStoreList;\r
266	struct SVfrVarStorageNode *mEfiVarStoreList;\r
267	struct SVfrVarStorageNode *mNameVarStoreList;\r
268	\r
269	struct SVfrVarStorageNode *mCurrVarStorageNode;\r
270	struct SVfrVarStorageNode *mNewVarStorageNode;\r
271	\r
272	private:\r
273	\r
274	EFI_VARSTORE_ID GetFreeVarStoreId (VOID);\r
275	BOOLEAN ChekVarStoreIdFree (IN EFI_VARSTORE_ID);\r
276	VOID MarkVarStoreIdUsed (IN EFI_VARSTORE_ID);\r
277	VOID MarkVarStoreIdUnused (IN EFI_VARSTORE_ID);\r
278	\r
279	public:\r
280	CVfrDataStorage ();\r
281	~CVfrDataStorage ();\r
282	\r
283	EFI_VFR_RETURN_CODE DeclareNameVarStoreBegin (INT8 *);\r
284	EFI_VFR_RETURN_CODE NameTableAddItem (EFI_STRING_ID);\r
285	EFI_VFR_RETURN_CODE DeclareNameVarStoreEnd (EFI_GUID *);\r
286	\r
287	EFI_VFR_RETURN_CODE DeclareEfiVarStore (IN INT8 , IN EFI_GUID , IN EFI_STRING_ID, IN UINT32);\r
288	\r
289	EFI_VFR_RETURN_CODE DeclareBufferVarStore (IN INT8 , IN EFI_GUID , IN CVfrVarDataTypeDB , IN INT8 , IN EFI_VARSTORE_ID);\r
290	\r
291	EFI_VFR_RETURN_CODE GetVarStoreId (IN INT8 , OUT EFI_VARSTORE_ID );\r
292	EFI_VFR_RETURN_CODE GetVarStoreType (IN INT8 *, OUT EFI_VFR_VARSTORE_TYPE &);\r
3e99020d	293	EFI_VFR_VARSTORE_TYPE GetVarStoreType (IN EFI_VARSTORE_ID);\r
95d675b5	294	EFI_VFR_RETURN_CODE GetVarStoreName (IN EFI_VARSTORE_ID, OUT INT8 **);\r
	295	\r
	296	EFI_VFR_RETURN_CODE GetBufferVarStoreDataTypeName (IN INT8 , OUT INT8 *);\r
	297	EFI_VFR_RETURN_CODE GetEfiVarStoreInfo (IN EFI_VARSTORE_INFO *);\r
	298	EFI_VFR_RETURN_CODE GetNameVarStoreInfo (IN EFI_VARSTORE_INFO *, IN UINT32);\r
	299	\r
	300	EFI_VFR_RETURN_CODE BufferVarStoreRequestElementAdd (IN INT8 *, IN EFI_VARSTORE_INFO &);\r
	301	};\r
	302	\r
	303	#define EFI_QUESTION_ID_MAX 0xFFFF\r
	304	#define EFI_FREE_QUESTION_ID_BITMAP_SIZE ((EFI_QUESTION_ID_MAX + 1) / EFI_BITS_PER_UINT32)\r
	305	#define EFI_QUESTION_ID_INVALID 0x0\r
	306	\r
	307	#define DATE_YEAR_BITMASK 0x0000FFFF\r
	308	#define DATE_MONTH_BITMASK 0x00FF0000\r
	309	#define DATE_DAY_BITMASK 0xFF000000\r
	310	#define TIME_HOUR_BITMASK 0x000000FF\r
	311	#define TIME_MINUTE_BITMASK 0x0000FF00\r
	312	#define TIME_SECOND_BITMASK 0x00FF0000\r
	313	\r
	314	struct SVfrQuestionNode {\r
	315	INT8 *mName;\r
	316	INT8 *mVarIdStr;\r
	317	EFI_QUESTION_ID mQuestionId;\r
	318	UINT32 mBitMask;\r
	319	SVfrQuestionNode *mNext;\r
	320	\r
	321	SVfrQuestionNode (IN INT8 , IN INT8 , IN UINT32 BitMask = 0);\r
	322	~SVfrQuestionNode ();\r
	323	};\r
	324	\r
	325	class CVfrQuestionDB {\r
	326	private:\r
	327	SVfrQuestionNode *mQuestionList;\r
	328	UINT32 mFreeQIdBitMap[EFI_FREE_QUESTION_ID_BITMAP_SIZE];\r
	329	\r
	330	private:\r
	331	EFI_QUESTION_ID GetFreeQuestionId (VOID);\r
	332	BOOLEAN ChekQuestionIdFree (IN EFI_QUESTION_ID);\r
	333	VOID MarkQuestionIdUsed (IN EFI_QUESTION_ID);\r
	334	VOID MarkQuestionIdUnused (IN EFI_QUESTION_ID);\r
	335	\r
	336	public:\r
	337	CVfrQuestionDB ();\r
	338	~CVfrQuestionDB();\r
	339	\r
	340	EFI_VFR_RETURN_CODE RegisterQuestion (IN INT8 , IN INT8 , IN OUT EFI_QUESTION_ID &);\r
	341	VOID RegisterOldDateQuestion (IN INT8 , IN INT8 , IN INT8 *, IN OUT EFI_QUESTION_ID &);\r
	342	VOID RegisterNewDateQuestion (IN INT8 , IN INT8 , IN OUT EFI_QUESTION_ID &);\r
	343	VOID RegisterOldTimeQuestion (IN INT8 , IN INT8 , IN INT8 *, IN OUT EFI_QUESTION_ID &);\r
	344	VOID RegisterNewTimeQuestion (IN INT8 , IN INT8 , IN OUT EFI_QUESTION_ID &);\r
	345	EFI_VFR_RETURN_CODE UpdateQuestionId (IN EFI_QUESTION_ID, IN EFI_QUESTION_ID);\r
	346	VOID GetQuestionId (IN INT8 , IN INT8 , OUT EFI_QUESTION_ID &, OUT UINT32 &);\r
	347	EFI_VFR_RETURN_CODE FindQuestion (IN EFI_QUESTION_ID);\r
	348	EFI_VFR_RETURN_CODE FindQuestion (IN INT8 *);\r
	349	};\r
	350	\r
	351	struct SVfrDefaultStoreNode {\r
	352	EFI_IFR_DEFAULTSTORE *mObjBinAddr;\r
	353	INT8 *mRefName;\r
	354	EFI_STRING_ID mDefaultStoreNameId;\r
	355	UINT16 mDefaultId;\r
	356	\r
	357	SVfrDefaultStoreNode *mNext;\r
358	\r
359	SVfrDefaultStoreNode (IN EFI_IFR_DEFAULTSTORE , IN INT8 , IN EFI_STRING_ID, IN UINT16);\r
360	~SVfrDefaultStoreNode();\r
361	};\r
362	\r
363	class CVfrDefaultStore {\r
364	private:\r
365	SVfrDefaultStoreNode *mDefaultStoreList;\r
366	\r
367	public:\r
368	CVfrDefaultStore ();\r
369	~CVfrDefaultStore ();\r
370	\r
371	EFI_VFR_RETURN_CODE RegisterDefaultStore (IN CHAR8 , IN INT8 , IN EFI_STRING_ID, IN UINT16);\r
372	EFI_VFR_RETURN_CODE ReRegisterDefaultStoreById (IN UINT16, IN INT8 *, IN EFI_STRING_ID);\r
373	BOOLEAN DefaultIdRegistered (IN UINT16);\r
374	EFI_VFR_RETURN_CODE GetDefaultId (IN INT8 , OUT UINT16 );\r
375	EFI_VFR_RETURN_CODE BufferVarStoreAltConfigAdd (IN EFI_VARSTORE_ID, IN EFI_VARSTORE_INFO &, IN INT8 *, IN UINT8, IN EFI_IFR_TYPE_VALUE);\r
376	};\r
377	\r
378	#define EFI_RULE_ID_START 0x01\r
379	#define EFI_RULE_ID_INVALID 0x00\r
380	\r
381	struct SVfrRuleNode {\r
382	UINT8 mRuleId;\r
383	INT8 *mRuleName;\r
384	SVfrRuleNode *mNext;\r
385	\r
386	SVfrRuleNode(IN INT8 *, IN UINT8);\r
387	~SVfrRuleNode();\r
388	};\r
389	\r
390	class CVfrRulesDB {\r
391	private:\r
392	SVfrRuleNode *mRuleList;\r
393	UINT8 mFreeRuleId;\r
394	\r
395	public:\r
396	CVfrRulesDB ();\r
397	~CVfrRulesDB();\r
398	\r
399	VOID RegisterRule (IN INT8 *);\r
400	UINT8 GetRuleId (IN INT8 *);\r
401	};\r
402	\r
403	#define MIN(v1, v2) (((v1) < (v2)) ? (v1) : (v2))\r
404	#define MAX(v1, v2) (((v1) > (v2)) ? (v1) : (v2))\r
405	\r
406	#endif\r