[mirror_edk2.git] / BaseTools / Source / C / VfrCompile / VfrUtilityLib.h

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