[mirror_edk2.git] / EdkCompatibilityPkg / Compatibility / FrameworkHiiToUefiHiiThunk / Utility.c

/**@file\r
\r
  This file contains the keyboard processing code to the HII database.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation\r
All rights reserved. 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
\r
#include "HiiDatabase.h"\r
\r
EFI_GUID  gFrameworkHiiCompatbilityGuid = EFI_IFR_FRAMEWORK_GUID;\r
EFI_GUID  gTianoHiiIfrGuid              = EFI_IFR_TIANO_GUID;\r
\r
\r
EFI_GUID *\r
GetGuidOfFirstFormset (\r
  CONST EFI_HII_FORM_PACKAGE * FormPackage\r
) \r
{\r
  UINT8                   *StartOfNextPackage;\r
  EFI_IFR_OP_HEADER       *OpCodeData;\r
\r
  StartOfNextPackage = (UINT8 *) FormPackage + FormPackage->Header.Length;\r
  OpCodeData = (EFI_IFR_OP_HEADER *) (FormPackage + 1);\r
\r
  while ((UINT8 *) OpCodeData < StartOfNextPackage) {\r
    if (OpCodeData->OpCode == EFI_IFR_FORM_SET_OP) {\r
      return AllocateCopyPool (sizeof(EFI_GUID), &(((EFI_IFR_FORM_SET *) OpCodeData)->Guid));\r
    }\r
    OpCodeData = (EFI_IFR_OP_HEADER *) ((UINT8 *) OpCodeData + OpCodeData->Length);\r
  }\r
\r
  ASSERT (FALSE);\r
\r
  return NULL;\r
}\r
\r
EFI_HII_HANDLE\r
FwHiiHandleToUefiHiiHandle (\r
  IN CONST HII_THUNK_PRIVATE_DATA      *Private,\r
  IN FRAMEWORK_EFI_HII_HANDLE          FwHiiHandle\r
  )\r
{\r
  HII_THUNK_CONTEXT            *ThunkContext;\r
\r
  ASSERT (FwHiiHandle != (FRAMEWORK_EFI_HII_HANDLE) 0);\r
  ASSERT (Private != NULL);\r
\r
  ThunkContext = FwHiiHandleToThunkContext (Private, FwHiiHandle);\r
\r
  if (ThunkContext != NULL) {\r
    return ThunkContext->UefiHiiHandle;\r
  }\r
  \r
  return (EFI_HII_HANDLE) NULL;\r
}\r
\r
\r
HII_THUNK_CONTEXT *\r
FwHiiHandleToThunkContext (\r
  IN CONST HII_THUNK_PRIVATE_DATA      *Private,\r
  IN FRAMEWORK_EFI_HII_HANDLE          FwHiiHandle\r
  )\r
{\r
  LIST_ENTRY                 *Link;\r
  HII_THUNK_CONTEXT           *ThunkContext;\r
\r
\r
  Link = GetFirstNode (&Private->ThunkContextListHead);\r
\r
  while (!IsNull (&Private->ThunkContextListHead, Link)) {\r
    ThunkContext = HII_THUNK_CONTEXT_FROM_LINK (Link);\r
\r
    if (FwHiiHandle == ThunkContext->FwHiiHandle) {\r
      return ThunkContext;\r
    }\r
\r
    Link = GetNextNode (&Private->ThunkContextListHead, Link);\r
  }\r
\r
  return NULL;\r
}\r
\r
HII_THUNK_CONTEXT *\r
UefiHiiHandleToThunkContext (\r
  IN CONST HII_THUNK_PRIVATE_DATA     *Private,\r
  IN EFI_HII_HANDLE                   UefiHiiHandle\r
  )\r
{\r
  LIST_ENTRY                 *Link;\r
  HII_THUNK_CONTEXT           *ThunkContext;\r
\r
  Link = GetFirstNode (&Private->ThunkContextListHead);\r
\r
  while (!IsNull (&Private->ThunkContextListHead, Link)) {\r
    ThunkContext = HII_THUNK_CONTEXT_FROM_LINK (Link);\r
\r
    if (UefiHiiHandle == ThunkContext->UefiHiiHandle) {\r
      return ThunkContext;\r
    }\r
    Link = GetNextNode (&Private->ThunkContextListHead, Link);\r
  }\r
\r
  return NULL;\r
}\r
\r
EFI_HII_HANDLE *\r
TagGuidToUefiHiiHandle (\r
  IN CONST HII_THUNK_PRIVATE_DATA *Private,\r
  IN CONST EFI_GUID                   *Guid\r
  )\r
{\r
  LIST_ENTRY                 *Link;\r
  HII_THUNK_CONTEXT           *ThunkContext;\r
\r
  Link = GetFirstNode (&Private->ThunkContextListHead);\r
\r
  while (!IsNull (&Private->ThunkContextListHead, Link)) {\r
    ThunkContext = HII_THUNK_CONTEXT_FROM_LINK (Link);\r
\r
    if (CompareGuid (Guid, &ThunkContext->TagGuid) && (ThunkContext->IfrPackageCount != 0)) {\r
      return ThunkContext->UefiHiiHandle;\r
    }\r
\r
    Link = GetNextNode (&Private->ThunkContextListHead, Link);\r
  }\r
\r
  return NULL;\r
  \r
}\r
\r
BOOLEAN\r
IsFrameworkHiiDatabaseHandleDepleted (\r
  IN CONST HII_THUNK_PRIVATE_DATA *Private\r
  )\r
{\r
  return (BOOLEAN) (Private->StaticHiiHandle == (UINTN) Private->StaticPureUefiHiiHandle);\r
}\r
\r
EFI_STATUS\r
AssignFrameworkHiiHandle (\r
  IN OUT HII_THUNK_PRIVATE_DATA     *Private,\r
  IN     BOOLEAN                    FromFwHiiNewPack,\r
  OUT    FRAMEWORK_EFI_HII_HANDLE   *Handle\r
  )\r
{\r
  ASSERT (Handle != NULL);\r
\r
  if (FromFwHiiNewPack) {\r
\r
    *Handle = Private->StaticHiiHandle;\r
    Private->StaticHiiHandle += 1;\r
\r
    if (IsFrameworkHiiDatabaseHandleDepleted (Private)) {\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
\r
  } else {\r
\r
    *Handle = Private->StaticPureUefiHiiHandle;\r
    Private->StaticPureUefiHiiHandle -= 1;\r
    \r
    if (IsFrameworkHiiDatabaseHandleDepleted (Private)) {\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
DestroyThunkContextForUefiHiiHandle (\r
  IN HII_THUNK_PRIVATE_DATA     *Private,\r
  IN EFI_HII_HANDLE             UefiHiiHandle\r
 )\r
{\r
  HII_THUNK_CONTEXT     *ThunkContext;\r
\r
  ThunkContext = UefiHiiHandleToThunkContext (Private, UefiHiiHandle);\r
  ASSERT (ThunkContext != NULL);\r
\r
  ASSERT (IsListEmpty (&ThunkContext->OneOfOptionMapListHead));\r
  ASSERT (IsListEmpty (&ThunkContext->QuestionIdMapListHead));\r
  \r
  RemoveEntryList (&ThunkContext->Link);\r
\r
  FreePool (ThunkContext);\r
    \r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  This function create a HII_THUNK_CONTEXT for a package list registered\r
  by a module calling EFI_HII_DATABASE_PROTOCOL.NewPackageList. It records\r
  the PackageListGuid in EFI_HII_PACKAGE_LIST_HEADER in the TagGuid in \r
  HII_THUNK_CONTEXT created. This TagGuid will be used as a key to s\r
\r
**/\r
HII_THUNK_CONTEXT *\r
CreateThunkContextForUefiHiiHandle (\r
  IN  HII_THUNK_PRIVATE_DATA     *Private,\r
  IN  EFI_HII_HANDLE             UefiHiiHandle\r
 )\r
{\r
  EFI_STATUS            Status;\r
  EFI_GUID              PackageGuid;\r
  HII_THUNK_CONTEXT      *ThunkContext;\r
\r
  ThunkContext = AllocateZeroPool (sizeof (*ThunkContext));\r
  ASSERT (ThunkContext != NULL);\r
  \r
  ThunkContext->Signature = HII_THUNK_CONTEXT_SIGNATURE;\r
\r
  Status = AssignFrameworkHiiHandle (Private, FALSE, &ThunkContext->FwHiiHandle);\r
  if (EFI_ERROR (Status)) {\r
    return NULL;\r
  }\r
  \r
  ThunkContext->UefiHiiHandle = UefiHiiHandle;\r
  \r
  Status = HiiLibExtractGuidFromHiiHandle (UefiHiiHandle, &PackageGuid);\r
  ASSERT_EFI_ERROR (Status);\r
  \r
  CopyGuid(&ThunkContext->TagGuid, &PackageGuid);\r
\r
  InitializeListHead (&ThunkContext->QuestionIdMapListHead);\r
  InitializeListHead (&ThunkContext->OneOfOptionMapListHead);\r
  \r
  InsertTailList (&Private->ThunkContextListHead, &ThunkContext->Link);\r
\r
  return ThunkContext;\r
}\r
\r
\r
UINTN\r
GetPackageCountByType (\r
  IN CONST EFI_HII_PACKAGE_LIST_HEADER     *PackageListHeader,\r
  IN       UINT8                           PackageType\r
  )\r
{\r
  UINTN                     Count;\r
  EFI_HII_PACKAGE_HEADER    *PackageHeader;\r
\r
  PackageHeader = (EFI_HII_PACKAGE_HEADER *) ((UINT8 *) PackageListHeader + sizeof (EFI_HII_PACKAGE_LIST_HEADER));\r
  Count = 0;\r
  \r
  while (PackageHeader->Type != EFI_HII_PACKAGE_END) {\r
    if (PackageHeader->Type == PackageType ) {\r
      Count++;\r
    }\r
    PackageHeader = (EFI_HII_PACKAGE_HEADER *) ((UINT8 *) PackageHeader + PackageHeader->Length);\r
  }\r
  \r
  \r
  return Count;\r
}\r
\r
LIST_ENTRY *\r
GetOneOfOptionMapEntryListHead (\r
  IN CONST HII_THUNK_CONTEXT  *ThunkContext,\r
  IN       UINT16             QuestionId\r
  )\r
{\r
  LIST_ENTRY            *Link;\r
  ONE_OF_OPTION_MAP     *Map;\r
\r
  Link = GetFirstNode (&ThunkContext->OneOfOptionMapListHead);\r
\r
  while (!IsNull (&ThunkContext->OneOfOptionMapListHead, Link)) {\r
    Map = ONE_OF_OPTION_MAP_FROM_LINK (Link);\r
    if (QuestionId == Map->QuestionId) {\r
      return &Map->OneOfOptionMapEntryListHead;\r
    }\r
    Link = GetNextNode (&ThunkContext->OneOfOptionMapListHead, Link);\r
  }\r
  \r
  return NULL;\r
}\r
\r
\r
EFI_STATUS\r
CreateQuestionIdMap (\r
  IN    OUT HII_THUNK_CONTEXT  *ThunkContext\r
  )\r
{\r
  EFI_STATUS                    Status;\r
  EFI_HII_PACKAGE_LIST_HEADER   *List;\r
  EFI_HII_PACKAGE_HEADER        *Package;\r
  UINTN                         Size;\r
  EFI_IFR_OP_HEADER             *OpCode;\r
  UINTN                         Offset;\r
  QUESTION_ID_MAP               *IdMap;\r
  EFI_IFR_VARSTORE              *VarStore;\r
  EFI_IFR_FORM_SET              *FormSet;\r
  EFI_IFR_QUESTION_HEADER       *Question;\r
  LIST_ENTRY                    *QuestionIdMapEntryListHead;\r
  LIST_ENTRY                    *OneOfOptinMapEntryListHead;\r
  QUESTION_ID_MAP_ENTRY         *IdMapEntry;\r
  EFI_IFR_GUID_OPTIONKEY        *OptionMap;\r
  ONE_OF_OPTION_MAP             *OneOfOptionMap;\r
  ONE_OF_OPTION_MAP_ENTRY       *OneOfOptionMapEntry;\r
  EFI_IFR_GUID_CLASS            *Class;\r
  \r
\r
  Status = HiiLibExportPackageLists (ThunkContext->UefiHiiHandle, &List, &Size);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Get all VarStoreId and build the the QuestionId map.\r
  // EFI_IFR_QUESTION_HEADER.VarStoreInfo.VarOffset -> Framework Question ID\r
  // EFI_IFR_QUESTION_HEADER.QuestionId             -> UEFI Question ID\r
  //\r
\r
  //\r
  // Skip the package list header.\r
  //\r
  Package = (EFI_HII_PACKAGE_HEADER *) (List + 1);\r
\r
  while (Package->Type != EFI_HII_PACKAGE_END) {\r
\r
    if (Package->Type == EFI_HII_PACKAGE_FORM) {\r
\r
      //\r
      // Skip the package header\r
      //\r
      Offset = sizeof (EFI_HII_PACKAGE_HEADER);\r
      while (Offset < Package->Length) {\r
        OpCode = (EFI_IFR_OP_HEADER *)((UINT8 *) Package + Offset);\r
\r
        switch (OpCode->OpCode) {\r
        case EFI_IFR_FORM_SET_OP:\r
          FormSet = (EFI_IFR_FORM_SET *) OpCode;\r
          ThunkContext->FormSetTitle = FormSet->FormSetTitle;\r
          ThunkContext->FormSetHelp  = FormSet->Help;\r
          break;\r
          \r
        case EFI_IFR_VARSTORE_OP:\r
          //\r
          // IFR built from Framework VFR only has UEFI Buffer Type Storage\r
          //\r
          VarStore = (EFI_IFR_VARSTORE *) OpCode;\r
          IdMap = AllocateZeroPool (sizeof (QUESTION_ID_MAP));\r
          ASSERT (IdMap != NULL);\r
          \r
          IdMap->Signature  = QUESTION_ID_MAP_SIGNATURE;\r
          IdMap->VarStoreId = VarStore->VarStoreId;\r
          IdMap->VarSize    = VarStore->Size;\r
          InitializeListHead (&IdMap->MapEntryListHead);\r
          InsertTailList (&ThunkContext->QuestionIdMapListHead, &IdMap->Link);\r
          break;\r
\r
        case EFI_IFR_NUMERIC_OP:\r
        case EFI_IFR_CHECKBOX_OP:\r
        case EFI_IFR_ONE_OF_OP:\r
        case EFI_IFR_ORDERED_LIST_OP:\r
        case EFI_IFR_STRING_OP:\r
        //case EFI_IFR_PASSWORD_OP:\r
          Question = (EFI_IFR_QUESTION_HEADER *)(OpCode + 1);\r
          QuestionIdMapEntryListHead = GetMapEntryListHead (ThunkContext, Question->VarStoreId);\r
\r
          if (QuestionIdMapEntryListHead != NULL) {\r
            //\r
            // If the Question is using Buffer (EFI_IFR_VARSTORE_OP) type VarStore.\r
            //\r
            IdMapEntry = AllocateZeroPool (sizeof (QUESTION_ID_MAP_ENTRY));\r
            ASSERT (IdMapEntry != NULL);\r
\r
            IdMapEntry->FwQId = Question->VarStoreInfo.VarOffset;\r
            IdMapEntry->UefiQid = Question->QuestionId;\r
            IdMapEntry->Signature = QUESTION_ID_MAP_ENTRY_SIGNATURE;\r
\r
            InsertTailList (QuestionIdMapEntryListHead, &IdMapEntry->Link);\r
          }\r
\r
          break;\r
       \r
        case EFI_IFR_GUID_OP:\r
          OptionMap = (EFI_IFR_GUID_OPTIONKEY *) OpCode;\r
          if (CompareGuid (&OptionMap->Guid, &gFrameworkHiiCompatbilityGuid)) {\r
            if (OptionMap->ExtendOpCode == EFI_IFR_EXTEND_OP_OPTIONKEY) {\r
              OneOfOptinMapEntryListHead = GetOneOfOptionMapEntryListHead (ThunkContext, OptionMap->QuestionId);\r
              if (OneOfOptinMapEntryListHead == NULL) {\r
                OneOfOptionMap = AllocateZeroPool (sizeof (ONE_OF_OPTION_MAP));\r
                ASSERT (OneOfOptionMap != NULL);\r
\r
                OneOfOptionMap->Signature = ONE_OF_OPTION_MAP_SIGNATURE;\r
                OneOfOptionMap->QuestionId = OptionMap->QuestionId;\r
                OneOfOptionMap->ValueType = EFI_IFR_TYPE_NUM_SIZE_8;\r
                InitializeListHead (&OneOfOptionMap->OneOfOptionMapEntryListHead);\r
                OneOfOptinMapEntryListHead = &OneOfOptionMap->OneOfOptionMapEntryListHead;\r
                InsertTailList (&ThunkContext->OneOfOptionMapListHead, &OneOfOptionMap->Link);\r
              }\r
              OneOfOptionMapEntry = AllocateZeroPool (sizeof (ONE_OF_OPTION_MAP_ENTRY));\r
              ASSERT (OneOfOptionMapEntry != NULL);\r
\r
              OneOfOptionMapEntry->Signature = ONE_OF_OPTION_MAP_ENTRY_SIGNATURE;\r
              OneOfOptionMapEntry->FwKey = OptionMap->KeyValue;\r
              CopyMem (&OneOfOptionMapEntry->Value, &OptionMap->OptionValue, sizeof (EFI_IFR_TYPE_VALUE));\r
              \r
              InsertTailList (OneOfOptinMapEntryListHead, &OneOfOptionMapEntry->Link);\r
            }\r
          }else if (CompareGuid (&OptionMap->Guid, &gTianoHiiIfrGuid)) {\r
            Class = (EFI_IFR_GUID_CLASS *) OpCode;\r
\r
            switch (Class->ExtendOpCode) {\r
              case EFI_IFR_EXTEND_OP_CLASS:\r
                ThunkContext->FormSetClass = Class->Class;\r
                break;\r
              case EFI_IFR_EXTEND_OP_SUBCLASS:\r
                ThunkContext->FormSetSubClass = ((EFI_IFR_GUID_SUBCLASS *) Class)->SubClass;\r
                break;\r
\r
              default:\r
                break;\r
            }\r
          }\r
          break;\r
          \r
        default:\r
          break;\r
        \r
        }\r
\r
        Offset += OpCode->Length;\r
      }\r
      //\r
      // Only Form Package is in a Package List.\r
      //\r
      break;\r
    }\r
\r
    Package = (EFI_HII_PACKAGE_HEADER *) (UINT8 *) Package + Package->Length;\r
  }\r
\r
  FreePool (List);\r
  return EFI_SUCCESS;\r
}\r
\r
\r
LIST_ENTRY *\r
GetMapEntryListHead (\r
  IN CONST HII_THUNK_CONTEXT  *ThunkContext,\r
  IN       UINT16             VarStoreId\r
  )\r
{\r
  LIST_ENTRY            *Link;\r
  QUESTION_ID_MAP       *Map;\r
\r
  Link = GetFirstNode (&ThunkContext->QuestionIdMapListHead);\r
\r
  while (!IsNull (&ThunkContext->QuestionIdMapListHead, Link)) {\r
    Map = QUESTION_ID_MAP_FROM_LINK (Link);\r
    if (VarStoreId == Map->VarStoreId) {\r
      return &Map->MapEntryListHead;\r
    }\r
    Link = GetNextNode (&ThunkContext->QuestionIdMapListHead, Link);\r
  }\r
  return NULL;\r
}\r
\r
\r
Commit	Line	Data
4259256b	1	/**@file\r
	2	\r
	3	This file contains the keyboard processing code to the HII database.\r
	4	\r
	5	Copyright (c) 2006 - 2008, Intel Corporation\r
	6	All rights reserved. This program and the accompanying materials\r
	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	\r
	17	#include "HiiDatabase.h"\r
	18	\r
0368663f	19	EFI_GUID gFrameworkHiiCompatbilityGuid = EFI_IFR_FRAMEWORK_GUID;\r
	20	EFI_GUID gTianoHiiIfrGuid = EFI_IFR_TIANO_GUID;\r
	21	\r
	22	\r
4259256b	23	EFI_GUID *\r
	24	GetGuidOfFirstFormset (\r
	25	CONST EFI_HII_FORM_PACKAGE * FormPackage\r
	26	) \r
	27	{\r
0368663f	28	UINT8 *StartOfNextPackage;\r
0368663f	29	EFI_IFR_OP_HEADER *OpCodeData;\r
4259256b	30	\r
	31	StartOfNextPackage = (UINT8 *) FormPackage + FormPackage->Header.Length;\r
	32	OpCodeData = (EFI_IFR_OP_HEADER *) (FormPackage + 1);\r
	33	\r
	34	while ((UINT8 *) OpCodeData < StartOfNextPackage) {\r
	35	if (OpCodeData->OpCode == EFI_IFR_FORM_SET_OP) {\r
3711f8f8	36	return AllocateCopyPool (sizeof(EFI_GUID), &(((EFI_IFR_FORM_SET *) OpCodeData)->Guid));\r
4259256b	37	}\r
	38	OpCodeData = (EFI_IFR_OP_HEADER ) ((UINT8 ) OpCodeData + OpCodeData->Length);\r
	39	}\r
	40	\r
	41	ASSERT (FALSE);\r
	42	\r
	43	return NULL;\r
	44	}\r
	45	\r
ee3428bb	46	EFI_HII_HANDLE\r
0368663f	47	FwHiiHandleToUefiHiiHandle (\r
	48	IN CONST HII_THUNK_PRIVATE_DATA *Private,\r
	49	IN FRAMEWORK_EFI_HII_HANDLE FwHiiHandle\r
ee3428bb	50	)\r
ee3428bb	51	{\r
0368663f	52	HII_THUNK_CONTEXT *ThunkContext;\r
ee3428bb	53	\r
0368663f	54	ASSERT (FwHiiHandle != (FRAMEWORK_EFI_HII_HANDLE) 0);\r
ee3428bb	55	ASSERT (Private != NULL);\r
ee3428bb	56	\r
0368663f	57	ThunkContext = FwHiiHandleToThunkContext (Private, FwHiiHandle);\r
ee3428bb	58	\r
0368663f	59	if (ThunkContext != NULL) {\r
0368663f	60	return ThunkContext->UefiHiiHandle;\r
ee3428bb	61	}\r
	62	\r
	63	return (EFI_HII_HANDLE) NULL;\r
	64	}\r
	65	\r
ebbd2793	66	\r
0368663f	67	HII_THUNK_CONTEXT *\r
	68	FwHiiHandleToThunkContext (\r
	69	IN CONST HII_THUNK_PRIVATE_DATA *Private,\r
	70	IN FRAMEWORK_EFI_HII_HANDLE FwHiiHandle\r
ebbd2793	71	)\r
ebbd2793	72	{\r
0368663f	73	LIST_ENTRY *Link;\r
	74	HII_THUNK_CONTEXT *ThunkContext;\r
	75	\r
ebbd2793	76	\r
0368663f	77	Link = GetFirstNode (&Private->ThunkContextListHead);\r
ebbd2793	78	\r
0368663f	79	while (!IsNull (&Private->ThunkContextListHead, Link)) {\r
	80	ThunkContext = HII_THUNK_CONTEXT_FROM_LINK (Link);\r
	81	\r
	82	if (FwHiiHandle == ThunkContext->FwHiiHandle) {\r
	83	return ThunkContext;\r
ebbd2793	84	}\r
0368663f	85	\r
0368663f	86	Link = GetNextNode (&Private->ThunkContextListHead, Link);\r
ebbd2793	87	}\r
ebbd2793	88	\r
0368663f	89	return NULL;\r
ebbd2793	90	}\r
ebbd2793	91	\r
0368663f	92	HII_THUNK_CONTEXT *\r
	93	UefiHiiHandleToThunkContext (\r
	94	IN CONST HII_THUNK_PRIVATE_DATA *Private,\r
ea58467b	95	IN EFI_HII_HANDLE UefiHiiHandle\r
	96	)\r
	97	{\r
0368663f	98	LIST_ENTRY *Link;\r
0368663f	99	HII_THUNK_CONTEXT *ThunkContext;\r
ea58467b	100	\r
0368663f	101	Link = GetFirstNode (&Private->ThunkContextListHead);\r
ea58467b	102	\r
0368663f	103	while (!IsNull (&Private->ThunkContextListHead, Link)) {\r
	104	ThunkContext = HII_THUNK_CONTEXT_FROM_LINK (Link);\r
	105	\r
	106	if (UefiHiiHandle == ThunkContext->UefiHiiHandle) {\r
	107	return ThunkContext;\r
ea58467b	108	}\r
0368663f	109	Link = GetNextNode (&Private->ThunkContextListHead, Link);\r
ea58467b	110	}\r
ea58467b	111	\r
0368663f	112	return NULL;\r
ea58467b	113	}\r
99a83b4c	114	\r
99a83b4c	115	EFI_HII_HANDLE *\r
0368663f	116	TagGuidToUefiHiiHandle (\r
0368663f	117	IN CONST HII_THUNK_PRIVATE_DATA *Private,\r
99a83b4c	118	IN CONST EFI_GUID *Guid\r
	119	)\r
	120	{\r
0368663f	121	LIST_ENTRY *Link;\r
	122	HII_THUNK_CONTEXT *ThunkContext;\r
	123	\r
	124	Link = GetFirstNode (&Private->ThunkContextListHead);\r
99a83b4c	125	\r
0368663f	126	while (!IsNull (&Private->ThunkContextListHead, Link)) {\r
0368663f	127	ThunkContext = HII_THUNK_CONTEXT_FROM_LINK (Link);\r
99a83b4c	128	\r
0368663f	129	if (CompareGuid (Guid, &ThunkContext->TagGuid) && (ThunkContext->IfrPackageCount != 0)) {\r
0368663f	130	return ThunkContext->UefiHiiHandle;\r
99a83b4c	131	}\r
0368663f	132	\r
0368663f	133	Link = GetNextNode (&Private->ThunkContextListHead, Link);\r
99a83b4c	134	}\r
99a83b4c	135	\r
0368663f	136	return NULL;\r
99a83b4c	137	\r
	138	}\r
	139	\r
ea58467b	140	BOOLEAN\r
ea58467b	141	IsFrameworkHiiDatabaseHandleDepleted (\r
0368663f	142	IN CONST HII_THUNK_PRIVATE_DATA *Private\r
ea58467b	143	)\r
	144	{\r
	145	return (BOOLEAN) (Private->StaticHiiHandle == (UINTN) Private->StaticPureUefiHiiHandle);\r
	146	}\r
	147	\r
	148	EFI_STATUS\r
0368663f	149	AssignFrameworkHiiHandle (\r
	150	IN OUT HII_THUNK_PRIVATE_DATA *Private,\r
	151	IN BOOLEAN FromFwHiiNewPack,\r
ea58467b	152	OUT FRAMEWORK_EFI_HII_HANDLE *Handle\r
	153	)\r
	154	{\r
	155	ASSERT (Handle != NULL);\r
	156	\r
0368663f	157	if (FromFwHiiNewPack) {\r
	158	\r
	159	*Handle = Private->StaticHiiHandle;\r
	160	Private->StaticHiiHandle += 1;\r
	161	\r
	162	if (IsFrameworkHiiDatabaseHandleDepleted (Private)) {\r
	163	return EFI_OUT_OF_RESOURCES;\r
	164	}\r
	165	\r
	166	} else {\r
	167	\r
	168	*Handle = Private->StaticPureUefiHiiHandle;\r
	169	Private->StaticPureUefiHiiHandle -= 1;\r
	170	\r
	171	if (IsFrameworkHiiDatabaseHandleDepleted (Private)) {\r
	172	return EFI_OUT_OF_RESOURCES;\r
	173	}\r
ea58467b	174	\r
ea58467b	175	}\r
	176	\r
	177	return EFI_SUCCESS;\r
	178	}\r
	179	\r
	180	EFI_STATUS\r
0368663f	181	DestroyThunkContextForUefiHiiHandle (\r
	182	IN HII_THUNK_PRIVATE_DATA *Private,\r
	183	IN EFI_HII_HANDLE UefiHiiHandle\r
	184	)\r
	185	{\r
	186	HII_THUNK_CONTEXT *ThunkContext;\r
	187	\r
	188	ThunkContext = UefiHiiHandleToThunkContext (Private, UefiHiiHandle);\r
	189	ASSERT (ThunkContext != NULL);\r
	190	\r
	191	ASSERT (IsListEmpty (&ThunkContext->OneOfOptionMapListHead));\r
	192	ASSERT (IsListEmpty (&ThunkContext->QuestionIdMapListHead));\r
	193	\r
	194	RemoveEntryList (&ThunkContext->Link);\r
	195	\r
	196	FreePool (ThunkContext);\r
	197	\r
	198	return EFI_SUCCESS;\r
	199	}\r
	200	\r
	201	\r
	202	/**\r
	203	This function create a HII_THUNK_CONTEXT for a package list registered\r
	204	by a module calling EFI_HII_DATABASE_PROTOCOL.NewPackageList. It records\r
	205	the PackageListGuid in EFI_HII_PACKAGE_LIST_HEADER in the TagGuid in \r
	206	HII_THUNK_CONTEXT created. This TagGuid will be used as a key to s\r
	207	\r
	208	**/\r
	209	HII_THUNK_CONTEXT *\r
	210	CreateThunkContextForUefiHiiHandle (\r
	211	IN HII_THUNK_PRIVATE_DATA *Private,\r
	212	IN EFI_HII_HANDLE UefiHiiHandle\r
	213	)\r
	214	{\r
	215	EFI_STATUS Status;\r
	216	EFI_GUID PackageGuid;\r
	217	HII_THUNK_CONTEXT *ThunkContext;\r
	218	\r
	219	ThunkContext = AllocateZeroPool (sizeof (*ThunkContext));\r
	220	ASSERT (ThunkContext != NULL);\r
	221	\r
	222	ThunkContext->Signature = HII_THUNK_CONTEXT_SIGNATURE;\r
	223	\r
	224	Status = AssignFrameworkHiiHandle (Private, FALSE, &ThunkContext->FwHiiHandle);\r
	225	if (EFI_ERROR (Status)) {\r
	226	return NULL;\r
	227	}\r
	228	\r
	229	ThunkContext->UefiHiiHandle = UefiHiiHandle;\r
	230	\r
	231	Status = HiiLibExtractGuidFromHiiHandle (UefiHiiHandle, &PackageGuid);\r
	232	ASSERT_EFI_ERROR (Status);\r
	233	\r
	234	CopyGuid(&ThunkContext->TagGuid, &PackageGuid);\r
	235	\r
	236	InitializeListHead (&ThunkContext->QuestionIdMapListHead);\r
	237	InitializeListHead (&ThunkContext->OneOfOptionMapListHead);\r
	238	\r
	239	InsertTailList (&Private->ThunkContextListHead, &ThunkContext->Link);\r
	240	\r
	241	return ThunkContext;\r
	242	}\r
	243	\r
	244	\r
245	UINTN\r
246	GetPackageCountByType (\r
247	IN CONST EFI_HII_PACKAGE_LIST_HEADER *PackageListHeader,\r
248	IN UINT8 PackageType\r
ea58467b	249	)\r
ea58467b	250	{\r
0368663f	251	UINTN Count;\r
	252	EFI_HII_PACKAGE_HEADER *PackageHeader;\r
	253	\r
	254	PackageHeader = (EFI_HII_PACKAGE_HEADER ) ((UINT8 ) PackageListHeader + sizeof (EFI_HII_PACKAGE_LIST_HEADER));\r
	255	Count = 0;\r
	256	\r
	257	while (PackageHeader->Type != EFI_HII_PACKAGE_END) {\r
	258	if (PackageHeader->Type == PackageType ) {\r
	259	Count++;\r
	260	}\r
	261	PackageHeader = (EFI_HII_PACKAGE_HEADER ) ((UINT8 ) PackageHeader + PackageHeader->Length);\r
	262	}\r
	263	\r
	264	\r
	265	return Count;\r
	266	}\r
	267	\r
	268	LIST_ENTRY *\r
	269	GetOneOfOptionMapEntryListHead (\r
	270	IN CONST HII_THUNK_CONTEXT *ThunkContext,\r
	271	IN UINT16 QuestionId\r
	272	)\r
	273	{\r
	274	LIST_ENTRY *Link;\r
	275	ONE_OF_OPTION_MAP *Map;\r
	276	\r
	277	Link = GetFirstNode (&ThunkContext->OneOfOptionMapListHead);\r
	278	\r
	279	while (!IsNull (&ThunkContext->OneOfOptionMapListHead, Link)) {\r
	280	Map = ONE_OF_OPTION_MAP_FROM_LINK (Link);\r
	281	if (QuestionId == Map->QuestionId) {\r
	282	return &Map->OneOfOptionMapEntryListHead;\r
	283	}\r
	284	Link = GetNextNode (&ThunkContext->OneOfOptionMapListHead, Link);\r
	285	}\r
	286	\r
	287	return NULL;\r
	288	}\r
99a83b4c	289	\r
99a83b4c	290	\r
0368663f	291	EFI_STATUS\r
	292	CreateQuestionIdMap (\r
	293	IN OUT HII_THUNK_CONTEXT *ThunkContext\r
	294	)\r
	295	{\r
	296	EFI_STATUS Status;\r
	297	EFI_HII_PACKAGE_LIST_HEADER *List;\r
	298	EFI_HII_PACKAGE_HEADER *Package;\r
	299	UINTN Size;\r
	300	EFI_IFR_OP_HEADER *OpCode;\r
	301	UINTN Offset;\r
	302	QUESTION_ID_MAP *IdMap;\r
	303	EFI_IFR_VARSTORE *VarStore;\r
	304	EFI_IFR_FORM_SET *FormSet;\r
	305	EFI_IFR_QUESTION_HEADER *Question;\r
	306	LIST_ENTRY *QuestionIdMapEntryListHead;\r
	307	LIST_ENTRY *OneOfOptinMapEntryListHead;\r
	308	QUESTION_ID_MAP_ENTRY *IdMapEntry;\r
	309	EFI_IFR_GUID_OPTIONKEY *OptionMap;\r
	310	ONE_OF_OPTION_MAP *OneOfOptionMap;\r
	311	ONE_OF_OPTION_MAP_ENTRY *OneOfOptionMapEntry;\r
	312	EFI_IFR_GUID_CLASS *Class;\r
	313	\r
	314	\r
	315	Status = HiiLibExportPackageLists (ThunkContext->UefiHiiHandle, &List, &Size);\r
	316	if (EFI_ERROR (Status)) {\r
	317	return Status;\r
ea58467b	318	}\r
99a83b4c	319	\r
0368663f	320	//\r
	321	// Get all VarStoreId and build the the QuestionId map.\r
	322	// EFI_IFR_QUESTION_HEADER.VarStoreInfo.VarOffset -> Framework Question ID\r
	323	// EFI_IFR_QUESTION_HEADER.QuestionId -> UEFI Question ID\r
	324	//\r
	325	\r
	326	//\r
	327	// Skip the package list header.\r
	328	//\r
	329	Package = (EFI_HII_PACKAGE_HEADER *) (List + 1);\r
	330	\r
	331	while (Package->Type != EFI_HII_PACKAGE_END) {\r
	332	\r
	333	if (Package->Type == EFI_HII_PACKAGE_FORM) {\r
	334	\r
	335	//\r
	336	// Skip the package header\r
	337	//\r
	338	Offset = sizeof (EFI_HII_PACKAGE_HEADER);\r
	339	while (Offset < Package->Length) {\r
	340	OpCode = (EFI_IFR_OP_HEADER )((UINT8 ) Package + Offset);\r
	341	\r
	342	switch (OpCode->OpCode) {\r
	343	case EFI_IFR_FORM_SET_OP:\r
	344	FormSet = (EFI_IFR_FORM_SET *) OpCode;\r
	345	ThunkContext->FormSetTitle = FormSet->FormSetTitle;\r
	346	ThunkContext->FormSetHelp = FormSet->Help;\r
	347	break;\r
	348	\r
	349	case EFI_IFR_VARSTORE_OP:\r
	350	//\r
	351	// IFR built from Framework VFR only has UEFI Buffer Type Storage\r
	352	//\r
	353	VarStore = (EFI_IFR_VARSTORE *) OpCode;\r
	354	IdMap = AllocateZeroPool (sizeof (QUESTION_ID_MAP));\r
	355	ASSERT (IdMap != NULL);\r
	356	\r
	357	IdMap->Signature = QUESTION_ID_MAP_SIGNATURE;\r
	358	IdMap->VarStoreId = VarStore->VarStoreId;\r
	359	IdMap->VarSize = VarStore->Size;\r
	360	InitializeListHead (&IdMap->MapEntryListHead);\r
	361	InsertTailList (&ThunkContext->QuestionIdMapListHead, &IdMap->Link);\r
	362	break;\r
	363	\r
	364	case EFI_IFR_NUMERIC_OP:\r
	365	case EFI_IFR_CHECKBOX_OP:\r
	366	case EFI_IFR_ONE_OF_OP:\r
	367	case EFI_IFR_ORDERED_LIST_OP:\r
	368	case EFI_IFR_STRING_OP:\r
	369	//case EFI_IFR_PASSWORD_OP:\r
	370	Question = (EFI_IFR_QUESTION_HEADER *)(OpCode + 1);\r
	371	QuestionIdMapEntryListHead = GetMapEntryListHead (ThunkContext, Question->VarStoreId);\r
	372	\r
	373	if (QuestionIdMapEntryListHead != NULL) {\r
	374	//\r
	375	// If the Question is using Buffer (EFI_IFR_VARSTORE_OP) type VarStore.\r
	376	//\r
	377	IdMapEntry = AllocateZeroPool (sizeof (QUESTION_ID_MAP_ENTRY));\r
	378	ASSERT (IdMapEntry != NULL);\r
	379	\r
	380	IdMapEntry->FwQId = Question->VarStoreInfo.VarOffset;\r
	381	IdMapEntry->UefiQid = Question->QuestionId;\r
	382	IdMapEntry->Signature = QUESTION_ID_MAP_ENTRY_SIGNATURE;\r
	383	\r
384	InsertTailList (QuestionIdMapEntryListHead, &IdMapEntry->Link);\r
385	}\r
386	\r
387	break;\r
388	\r
389	case EFI_IFR_GUID_OP:\r
390	OptionMap = (EFI_IFR_GUID_OPTIONKEY *) OpCode;\r
391	if (CompareGuid (&OptionMap->Guid, &gFrameworkHiiCompatbilityGuid)) {\r
392	if (OptionMap->ExtendOpCode == EFI_IFR_EXTEND_OP_OPTIONKEY) {\r
393	OneOfOptinMapEntryListHead = GetOneOfOptionMapEntryListHead (ThunkContext, OptionMap->QuestionId);\r
394	if (OneOfOptinMapEntryListHead == NULL) {\r
395	OneOfOptionMap = AllocateZeroPool (sizeof (ONE_OF_OPTION_MAP));\r
396	ASSERT (OneOfOptionMap != NULL);\r
397	\r
398	OneOfOptionMap->Signature = ONE_OF_OPTION_MAP_SIGNATURE;\r
399	OneOfOptionMap->QuestionId = OptionMap->QuestionId;\r
400	OneOfOptionMap->ValueType = EFI_IFR_TYPE_NUM_SIZE_8;\r
401	InitializeListHead (&OneOfOptionMap->OneOfOptionMapEntryListHead);\r
402	OneOfOptinMapEntryListHead = &OneOfOptionMap->OneOfOptionMapEntryListHead;\r
403	InsertTailList (&ThunkContext->OneOfOptionMapListHead, &OneOfOptionMap->Link);\r
404	}\r
405	OneOfOptionMapEntry = AllocateZeroPool (sizeof (ONE_OF_OPTION_MAP_ENTRY));\r
406	ASSERT (OneOfOptionMapEntry != NULL);\r
407	\r
408	OneOfOptionMapEntry->Signature = ONE_OF_OPTION_MAP_ENTRY_SIGNATURE;\r
409	OneOfOptionMapEntry->FwKey = OptionMap->KeyValue;\r
410	CopyMem (&OneOfOptionMapEntry->Value, &OptionMap->OptionValue, sizeof (EFI_IFR_TYPE_VALUE));\r
411	\r
412	InsertTailList (OneOfOptinMapEntryListHead, &OneOfOptionMapEntry->Link);\r
413	}\r
414	}else if (CompareGuid (&OptionMap->Guid, &gTianoHiiIfrGuid)) {\r
415	Class = (EFI_IFR_GUID_CLASS *) OpCode;\r
416	\r
417	switch (Class->ExtendOpCode) {\r
418	case EFI_IFR_EXTEND_OP_CLASS:\r
419	ThunkContext->FormSetClass = Class->Class;\r
420	break;\r
421	case EFI_IFR_EXTEND_OP_SUBCLASS:\r
422	ThunkContext->FormSetSubClass = ((EFI_IFR_GUID_SUBCLASS *) Class)->SubClass;\r
423	break;\r
424	\r
425	default:\r
426	break;\r
427	}\r
428	}\r
429	break;\r
430	\r
431	default:\r
432	break;\r
433	\r
434	}\r
435	\r
436	Offset += OpCode->Length;\r
437	}\r
438	//\r
439	// Only Form Package is in a Package List.\r
440	//\r
441	break;\r
442	}\r
443	\r
444	Package = (EFI_HII_PACKAGE_HEADER ) (UINT8 ) Package + Package->Length;\r
445	}\r
446	\r
447	FreePool (List);\r
ea58467b	448	return EFI_SUCCESS;\r
ea58467b	449	}\r
99a83b4c	450	\r
0368663f	451	\r
	452	LIST_ENTRY *\r
	453	GetMapEntryListHead (\r
	454	IN CONST HII_THUNK_CONTEXT *ThunkContext,\r
	455	IN UINT16 VarStoreId\r
	456	)\r
	457	{\r
	458	LIST_ENTRY *Link;\r
	459	QUESTION_ID_MAP *Map;\r
	460	\r
	461	Link = GetFirstNode (&ThunkContext->QuestionIdMapListHead);\r
	462	\r
	463	while (!IsNull (&ThunkContext->QuestionIdMapListHead, Link)) {\r
	464	Map = QUESTION_ID_MAP_FROM_LINK (Link);\r
	465	if (VarStoreId == Map->VarStoreId) {\r
	466	return &Map->MapEntryListHead;\r
	467	}\r
	468	Link = GetNextNode (&ThunkContext->QuestionIdMapListHead, Link);\r
	469	}\r
	470	return NULL;\r
	471	}\r
	472	\r
	473	\r