EdkCompatibilityPkg/Compatibility/FrameworkHiiToUefiHiiThunk/Utility.h

   1 /**@file
   2
   3   This file contains utility functions by HII Thunk Modules.
   4
   5 Copyright (c) 2006 - 2008, Intel Corporation
   6 All rights reserved. This program and the accompanying materials
   7 are licensed and made available under the terms and conditions of the BSD License
   8 which accompanies this distribution.  The full text of the license may be found at
   9 http://opensource.org/licenses/bsd-license.php
  10
  11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef _HII_THUNK_UTILITY_H
  17 #define _HII_THUNK_UTILITY_H
  18
  19 /**
  20   Find the UefiHiiHandle based on a Framework HII Handle returned by
  21   the HII Thunk to Framework HII code.
  22
  23   @param Private                        The pointer to the private data of Hii Thunk.
  24   @param FwHiiHandle     Framework HII Handle returned by  the HII Thunk to Framework HII code.
  25
  26   @retval  NULL                           If Framework HII Handle passed in does not have matching UEFI HII handle.
  27   @retval  !NULL                         If the match is found.
  28
  29 **/
  30 EFI_HII_HANDLE
  31 FwHiiHandleToUefiHiiHandle (
  32   IN CONST HII_THUNK_PRIVATE_DATA *Private,
  33   IN FRAMEWORK_EFI_HII_HANDLE          FwHiiHandle
  34   )
  35 ;
  36
  37 HII_THUNK_CONTEXT *
  38 FwHiiHandleToThunkContext (
  39   IN CONST HII_THUNK_PRIVATE_DATA *Private,
  40   IN FRAMEWORK_EFI_HII_HANDLE          FwHiiHandle
  41   )
  42 ;
  43
  44 HII_THUNK_CONTEXT *
  45 UefiHiiHandleToThunkContext (
  46   IN CONST HII_THUNK_PRIVATE_DATA *Private,
  47   IN EFI_HII_HANDLE                   UefiHiiHandle
  48   )
  49 ;
  50
  51 EFI_HII_HANDLE *
  52 TagGuidToUefiHiiHandle (
  53   IN CONST HII_THUNK_PRIVATE_DATA *Private,
  54   IN CONST EFI_GUID                   *Guid
  55   )
  56 ;
  57
  58 HII_THUNK_CONTEXT *
  59 CreateThunkContextForUefiHiiHandle (
  60   IN  EFI_HII_HANDLE             UefiHiiHandle
  61  )
  62 ;
  63
  64 VOID
  65 DestroyThunkContextForUefiHiiHandle (
  66   IN HII_THUNK_PRIVATE_DATA     *Private,
  67   IN EFI_HII_HANDLE             UefiHiiHandle
  68  )
  69 ;
  70
  71 UINTN
  72 GetPackageCountByType (
  73   IN CONST EFI_HII_PACKAGE_LIST_HEADER     *PackageListHeader,
  74   IN       UINT8                           PackageType
  75   )
  76 ;
  77
  78 EFI_STATUS
  79 CreateQuestionIdMap (
  80   IN    OUT HII_THUNK_CONTEXT  *ThunkContext
  81   )
  82 ;
  83
  84 VOID
  85 GetAttributesOfFirstFormSet (
  86   IN    OUT HII_THUNK_CONTEXT  *ThunkContext
  87   )
  88 ;
  89
  90 LIST_ENTRY *
  91 GetMapEntryListHead (
  92   IN CONST HII_THUNK_CONTEXT  *ThunkContext,
  93   IN       UINT16             VarStoreId
  94   )
  95 ;
  96
  97 HII_THUNK_CONTEXT *
  98 CreateThunkContext (
  99   IN  HII_THUNK_PRIVATE_DATA      *Private,
 100   IN  UINTN                       StringPackageCount,
 101   IN  UINTN                       IfrPackageCount
 102   )
 103 ;
 104
 105 VOID
 106 DestroyThunkContext (
 107   IN HII_THUNK_CONTEXT          *ThunkContext
 108   )
 109 ;
 110
 111 VOID
 112 DestroyQuestionIdMap (
 113   IN LIST_ENTRY     *QuestionIdMapListHead
 114   )
 115 ;
 116
 117
 118 VOID
 119 DestoryOneOfOptionMap (
 120   IN LIST_ENTRY     *OneOfOptionMapListHead
 121   )
 122 ;
 123
 124 #endif