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

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