Add doxygen style comments for functions in DxeIpl.

[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 *\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
FrameworkHiiHandleToUefiHiiHandle (\r
  IN CONST EFI_HII_THUNK_PRIVATE_DATA *Private,\r
  IN FRAMEWORK_EFI_HII_HANDLE          FrameworkHiiHandle\r
  )\r
{\r
  HII_TRHUNK_HANDLE_MAPPING_DATABASE_ENTRY  *HandleMapEntry;\r
\r
  ASSERT (FrameworkHiiHandle != (FRAMEWORK_EFI_HII_HANDLE) 0);\r
  ASSERT (Private != NULL);\r
\r
  HandleMapEntry = FrameworkHiiHandleToMapDatabaseEntry (Private, FrameworkHiiHandle);\r
\r
  if (HandleMapEntry != NULL) {\r
    return HandleMapEntry->UefiHiiHandle;\r
  }\r
  \r
  return (EFI_HII_HANDLE) NULL;\r
}\r
\r
\r
HII_TRHUNK_HANDLE_MAPPING_DATABASE_ENTRY *\r
FrameworkHiiHandleToMapDatabaseEntry (\r
  IN CONST EFI_HII_THUNK_PRIVATE_DATA *Private,\r
  IN FRAMEWORK_EFI_HII_HANDLE          FrameworkHiiHandle\r
  )\r
{\r
  LIST_ENTRY                 *ListEntry;\r
  HII_TRHUNK_HANDLE_MAPPING_DATABASE_ENTRY *HandleMapEntry;\r
\r
  for (ListEntry = Private->HiiThunkHandleMappingDBListHead.ForwardLink;\r
       ListEntry != &Private->HiiThunkHandleMappingDBListHead;\r
       ListEntry = ListEntry->ForwardLink\r
       ) {\r
    HandleMapEntry = HII_TRHUNK_HANDLE_MAPPING_DATABASE_ENTRY_FROM_LISTENTRY (ListEntry);\r
\r
    if (FrameworkHiiHandle == HandleMapEntry->FrameworkHiiHandle) {\r
      return HandleMapEntry;\r
    }\r
  }\r
\r
  return (HII_TRHUNK_HANDLE_MAPPING_DATABASE_ENTRY *) NULL;\r
}\r
\r
\r
EFI_HII_HANDLE *\r
TagGuidToUefiIfrHiiHandle (\r
  IN CONST EFI_HII_THUNK_PRIVATE_DATA *Private,\r
  IN CONST EFI_GUID                   *Guid\r
  )\r
{\r
  LIST_ENTRY                 *ListEntry;\r
  HII_TRHUNK_HANDLE_MAPPING_DATABASE_ENTRY *HandleMapEntry;\r
\r
  for (ListEntry = Private->HiiThunkHandleMappingDBListHead.ForwardLink;\r
       ListEntry != &Private->HiiThunkHandleMappingDBListHead;\r
       ListEntry = ListEntry->ForwardLink\r
       ) {\r
    HandleMapEntry = HII_TRHUNK_HANDLE_MAPPING_DATABASE_ENTRY_FROM_LISTENTRY (ListEntry);\r
\r
    if (CompareGuid (Guid, &HandleMapEntry->TagGuid) && HandleMapEntry->DoesPackageListImportStringPackages) {\r
      return HandleMapEntry->UefiHiiHandle;\r
    }\r
  }\r
\r
  return (EFI_HII_HANDLE *) NULL;\r
  \r
}\r
\r
\r
\r
\r
\r