[mirror_edk2.git] / EdkCompatibilityPkg / Compatibility / FrameworkHiiToUefiHiiThunk / HiiDatabase.h

/**@file\r
\r
  This file contains global defines and prototype definitions\r
  for 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
#ifndef _HIIDATABASE_H\r
#define _HIIDATABASE_H\r
\r
\r
#include <FrameworkDxe.h>\r
\r
#include <Guid/GlobalVariable.h>\r
#include <Protocol/FrameworkFormCallback.h>\r
#include <Protocol/FrameworkHii.h>\r
#include <Protocol/FrameworkFormBrowser.h>\r
\r
//\r
// UEFI HII Protocols\r
//\r
#include <Protocol/HiiFont.h>\r
#include <Protocol/HiiImage.h>\r
#include <Protocol/HiiString.h>\r
#include <Protocol/HiiDatabase.h>\r
#include <Protocol/HiiConfigRouting.h>\r
#include <Protocol/HiiConfigAccess.h>\r
\r
\r
#include <Library/BaseLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/HiiLib.h>\r
#include <Library/ExtendedHiiLib.h>\r
\r
#include <Library/IfrSupportLib.h>\r
#include <Library/ExtendedIfrSupportLib.h>\r
\r
#include <MdeModuleHii.h>\r
\r
#pragma pack (push, 1)\r
typedef struct {\r
  UINT32                  BinaryLength;\r
  EFI_HII_PACKAGE_HEADER  PackageHeader;\r
} TIANO_AUTOGEN_PACKAGES_HEADER;\r
#pragma pack (pop)\r
\r
#define HII_THUNK_PRIVATE_DATA_FROM_THIS(Record)  CR(Record, HII_THUNK_PRIVATE_DATA, Hii, HII_THUNK_PRIVATE_DATA_SIGNATURE)\r
#define HII_THUNK_PRIVATE_DATA_SIGNATURE            EFI_SIGNATURE_32 ('H', 'i', 'I', 'T')\r
typedef struct {\r
  UINTN                    Signature;\r
  EFI_HANDLE               Handle;\r
  EFI_HII_PROTOCOL         Hii;\r
  FRAMEWORK_EFI_HII_HANDLE StaticHiiHandle;\r
  FRAMEWORK_EFI_HII_HANDLE StaticPureUefiHiiHandle;\r
\r
  //\r
  // The head of link list for all HII_THUNK_CONTEXT.\r
  //\r
  LIST_ENTRY               ThunkContextListHead;\r
\r
  EFI_HANDLE               RemovePackNotifyHandle;\r
  EFI_HANDLE               AddPackNotifyHandle;\r
} HII_THUNK_PRIVATE_DATA;\r
\r
\r
\r
#define ONE_OF_OPTION_MAP_ENTRY_FROM_LINK(Record) CR(Record, ONE_OF_OPTION_MAP_ENTRY, Link, ONE_OF_OPTION_MAP_ENTRY_SIGNATURE)\r
#define ONE_OF_OPTION_MAP_ENTRY_SIGNATURE            EFI_SIGNATURE_32 ('O', 'O', 'M', 'E')\r
typedef struct {\r
  UINT32          Signature;\r
  LIST_ENTRY      Link;\r
\r
  UINT16             FwKey;\r
  EFI_IFR_TYPE_VALUE Value;\r
  \r
} ONE_OF_OPTION_MAP_ENTRY;\r
\r
\r
\r
#define ONE_OF_OPTION_MAP_FROM_LINK(Record) CR(Record, ONE_OF_OPTION_MAP, Link, ONE_OF_OPTION_MAP_SIGNATURE)\r
#define ONE_OF_OPTION_MAP_SIGNATURE            EFI_SIGNATURE_32 ('O', 'O', 'O', 'M')\r
typedef struct {\r
  UINT32          Signature;\r
  LIST_ENTRY      Link;       \r
\r
  UINT8           ValueType; //EFI_IFR_TYPE_NUM_* \r
\r
  EFI_QUESTION_ID     QuestionId;\r
\r
  LIST_ENTRY      OneOfOptionMapEntryListHead; //ONE_OF_OPTION_MAP_ENTRY\r
} ONE_OF_OPTION_MAP;\r
\r
\r
\r
#define QUESTION_ID_MAP_ENTRY_FROM_LINK(Record) CR(Record, QUESTION_ID_MAP_ENTRY, Link, QUESTION_ID_MAP_ENTRY_SIGNATURE)\r
#define QUESTION_ID_MAP_ENTRY_SIGNATURE            EFI_SIGNATURE_32 ('Q', 'I', 'M', 'E')\r
typedef struct {\r
  UINT32            Signature;\r
  LIST_ENTRY        Link;\r
  UINT16            FwQId;\r
  EFI_QUESTION_ID   UefiQid;\r
} QUESTION_ID_MAP_ENTRY;\r
\r
\r
\r
#define QUESTION_ID_MAP_FROM_LINK(Record) CR(Record, QUESTION_ID_MAP, Link, QUESTION_ID_MAP_SIGNATURE)\r
#define QUESTION_ID_MAP_SIGNATURE            EFI_SIGNATURE_32 ('Q', 'I', 'M', 'P')\r
typedef struct {\r
  UINT32            Signature;\r
  LIST_ENTRY        Link;\r
  UINT16            VarStoreId;\r
  UINTN             VarSize;\r
  LIST_ENTRY        MapEntryListHead;\r
} QUESTION_ID_MAP;\r
\r
\r
\r
#define HII_THUNK_CONTEXT_FROM_LINK(Record) CR(Record, HII_THUNK_CONTEXT, Link, HII_THUNK_CONTEXT_SIGNATURE)\r
#define HII_THUNK_CONTEXT_SIGNATURE            EFI_SIGNATURE_32 ('H', 'T', 'H', 'M')\r
typedef struct {\r
  LIST_ENTRY                Link;\r
  UINT32                    Signature;\r
  FRAMEWORK_EFI_HII_HANDLE  FwHiiHandle;\r
  EFI_HII_HANDLE            UefiHiiHandle;\r
  EFI_HANDLE                UefiHiiDriverHandle;\r
\r
  UINTN                     IfrPackageCount;\r
  UINTN                     StringPackageCount;\r
\r
  //\r
  // The field below is only valid if IsPackageListWithOnlyStringPack is TRUE.\r
  // The HII 0.92 version of HII data implementation in EDK 1.03 and 1.04 make an the following assumption\r
  // in both HII Database implementation and all modules that registering packages:\r
  // If a Package List has only IFR package and no String Package, the IFR package will reference \r
  // String in another Package List registered with the HII database with the same EFI_HII_PACKAGES.GuidId.\r
  // TagGuid is the used to record this GuidId.\r
  EFI_GUID                   TagGuid;\r
\r
  LIST_ENTRY                 QuestionIdMapListHead; //QUESTION_ID_MAP\r
\r
  LIST_ENTRY                 OneOfOptionMapListHead; //ONE_OF_OPTION_MAP\r
\r
  UINT8                      *NvMapOverride;\r
\r
  UINT16                     FormSetClass;\r
  UINT16                     FormSetSubClass;\r
  STRING_REF                 FormSetTitle;\r
  STRING_REF                 FormSetHelp;\r
  \r
} HII_THUNK_CONTEXT;\r
\r
\r
\r
#define BUFFER_STORAGE_ENTRY_SIGNATURE              EFI_SIGNATURE_32 ('H', 'T', 's', 'k')\r
#define BUFFER_STORAGE_ENTRY_FROM_LINK(Record) CR(Record, BUFFER_STORAGE_ENTRY, Link, BUFFER_STORAGE_ENTRY_SIGNATURE)\r
typedef struct {\r
  LIST_ENTRY Link;\r
  UINT32     Signature;\r
  EFI_GUID   Guid;\r
  CHAR16     *Name;\r
  UINTN      Size;\r
  UINT16     VarStoreId;\r
} BUFFER_STORAGE_ENTRY;\r
\r
\r
\r
#define CONFIG_ACCESS_PRIVATE_SIGNATURE            EFI_SIGNATURE_32 ('H', 'T', 'c', 'a')\r
#define CONFIG_ACCESS_PRIVATE_FROM_PROTOCOL(Record) CR(Record, CONFIG_ACCESS_PRIVATE, ConfigAccessProtocol, CONFIG_ACCESS_PRIVATE_SIGNATURE)\r
typedef struct {\r
  UINT32                         Signature;\r
  EFI_HII_CONFIG_ACCESS_PROTOCOL ConfigAccessProtocol;\r
  //\r
  // Framework's callback\r
  //\r
  EFI_FORM_CALLBACK_PROTOCOL     *FormCallbackProtocol;\r
\r
  LIST_ENTRY                     BufferStorageListHead;\r
\r
  HII_THUNK_CONTEXT              *ThunkContext;\r
} CONFIG_ACCESS_PRIVATE;\r
\r
\r
\r
#define EFI_FORMBROWSER_THUNK_PRIVATE_DATA_SIGNATURE            EFI_SIGNATURE_32 ('F', 'B', 'T', 'd')\r
#define EFI_FORMBROWSER_THUNK_PRIVATE_DATA_FROM_THIS(Record)   CR(Record, EFI_FORMBROWSER_THUNK_PRIVATE_DATA, FormBrowser, EFI_FORMBROWSER_THUNK_PRIVATE_DATA_SIGNATURE)\r
typedef struct {\r
  UINTN                     Signature;\r
  EFI_HANDLE                Handle;\r
  HII_THUNK_PRIVATE_DATA    *ThunkPrivate;\r
  EFI_FORM_BROWSER_PROTOCOL FormBrowser;\r
} EFI_FORMBROWSER_THUNK_PRIVATE_DATA;\r
\r
\r
//\r
// Extern Variables\r
//\r
extern CONST EFI_HII_DATABASE_PROTOCOL            *mHiiDatabase;\r
extern CONST EFI_HII_IMAGE_PROTOCOL               *mHiiImageProtocol;\r
extern CONST EFI_HII_STRING_PROTOCOL              *mHiiStringProtocol;\r
extern CONST EFI_HII_FONT_PROTOCOL                *mHiiFontProtocol;\r
extern CONST EFI_HII_CONFIG_ROUTING_PROTOCOL      *mHiiConfigRoutingProtocol;\r
extern CONST EFI_FORM_BROWSER2_PROTOCOL           *mFormBrowser2Protocol;\r
\r
extern HII_THUNK_PRIVATE_DATA                     *mHiiThunkPrivateData;\r
\r
extern BOOLEAN                                    mInFrameworkUpdatePakcage;\r
\r
\r
//\r
// Prototypes\r
//\r
\r
//\r
// Public Interface Prototypes\r
//\r
EFI_STATUS\r
EFIAPI\r
InitializeHiiDatabase (\r
  IN EFI_HANDLE             ImageHandle,\r
  IN EFI_SYSTEM_TABLE       *SystemTable\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
HiiNewPack (\r
  IN  EFI_HII_PROTOCOL      *This,\r
  IN  EFI_HII_PACKAGES      *PackageList,\r
  OUT FRAMEWORK_EFI_HII_HANDLE         *Handle\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
HiiRemovePack (\r
  IN EFI_HII_PROTOCOL    *This,\r
  IN FRAMEWORK_EFI_HII_HANDLE       Handle\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
HiiFindHandles (\r
  IN     EFI_HII_PROTOCOL    *This,\r
  IN OUT UINT16              *HandleBufferLength,\r
  OUT    FRAMEWORK_EFI_HII_HANDLE       *Handle\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
HiiExportDatabase (\r
  IN     EFI_HII_PROTOCOL *This,\r
  IN     FRAMEWORK_EFI_HII_HANDLE    Handle,\r
  IN OUT UINTN            *BufferSize,\r
  OUT    VOID             *Buffer\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
HiiGetGlyph (\r
  IN     EFI_HII_PROTOCOL    *This,\r
  IN     CHAR16              *Source,\r
  IN OUT UINT16              *Index,\r
  OUT    UINT8               **GlyphBuffer,\r
  OUT    UINT16              *BitWidth,\r
  IN OUT UINT32              *InternalStatus\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
HiiGlyphToBlt (\r
  IN     EFI_HII_PROTOCOL              *This,\r
  IN     UINT8                         *GlyphBuffer,\r
  IN     EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground,\r
  IN     EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background,\r
  IN     UINTN                         Count,\r
  IN     UINTN                         Width,\r
  IN     UINTN                         Height,\r
  IN OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
HiiNewString (\r
  IN     EFI_HII_PROTOCOL        *This,\r
  IN     CHAR16                  *Language,\r
  IN     FRAMEWORK_EFI_HII_HANDLE Handle,\r
  IN OUT STRING_REF              *Reference,\r
  IN     CHAR16                  *NewString\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
HiiGetString (\r
  IN     EFI_HII_PROTOCOL    *This,\r
  IN     FRAMEWORK_EFI_HII_HANDLE       Handle,\r
  IN     STRING_REF          Token,\r
  IN     BOOLEAN             Raw,\r
  IN     CHAR16              *LanguageString,\r
  IN OUT UINTN               *BufferLength,\r
  OUT    EFI_STRING          StringBuffer\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
HiiResetStrings (\r
  IN     EFI_HII_PROTOCOL    *This,\r
  IN     FRAMEWORK_EFI_HII_HANDLE       Handle\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
HiiTestString (\r
  IN     EFI_HII_PROTOCOL    *This,\r
  IN     CHAR16              *StringToTest,\r
  IN OUT UINT32              *FirstMissing,\r
  OUT    UINT32              *GlyphBufferSize\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
HiiGetPrimaryLanguages (\r
  IN  EFI_HII_PROTOCOL      *This,\r
  IN  FRAMEWORK_EFI_HII_HANDLE         Handle,\r
  OUT EFI_STRING            *LanguageString\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
HiiGetSecondaryLanguages (\r
  IN  EFI_HII_PROTOCOL      *This,\r
  IN  FRAMEWORK_EFI_HII_HANDLE         Handle,\r
  IN  CHAR16                *PrimaryLanguage,\r
  OUT EFI_STRING            *LanguageString\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
HiiGetLine (\r
  IN     EFI_HII_PROTOCOL    *This,\r
  IN     FRAMEWORK_EFI_HII_HANDLE       Handle,\r
  IN     STRING_REF          Token,\r
  IN OUT UINT16              *Index,\r
  IN     UINT16              LineWidth,\r
  IN     CHAR16              *LanguageString,\r
  IN OUT UINT16              *BufferLength,\r
  OUT    EFI_STRING          StringBuffer\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
HiiGetForms (\r
  IN     EFI_HII_PROTOCOL    *This,\r
  IN     FRAMEWORK_EFI_HII_HANDLE       Handle,\r
  IN     EFI_FORM_ID         FormId,\r
  IN OUT UINTN               *BufferLength,\r
  OUT    UINT8               *Buffer\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
HiiGetDefaultImage (\r
  IN     EFI_HII_PROTOCOL           *This,\r
  IN     FRAMEWORK_EFI_HII_HANDLE   Handle,\r
  IN     UINTN                      DefaultMask,\r
  OUT    EFI_HII_VARIABLE_PACK_LIST **VariablePackList\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
HiiUpdateForm (\r
  IN EFI_HII_PROTOCOL       *This,\r
  IN FRAMEWORK_EFI_HII_HANDLE          Handle,\r
  IN EFI_FORM_LABEL         Label,\r
  IN BOOLEAN                AddData,\r
  IN FRAMEWORK_EFI_HII_UPDATE_DATA    *Data\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
HiiGetKeyboardLayout (\r
  IN     EFI_HII_PROTOCOL    *This,\r
  OUT    UINT16              *DescriptorCount,\r
  OUT    FRAMEWORK_EFI_KEY_DESCRIPTOR  *Descriptor\r
  )\r
;\r
\r
EFI_STATUS\r
HiiCompareLanguage (\r
  IN  CHAR16                *LanguageStringLocation,\r
  IN  CHAR16                *Language\r
  )\r
;\r
\r
\r
\r
EFI_STATUS\r
EFIAPI \r
ThunkSendForm (\r
  IN  EFI_FORM_BROWSER_PROTOCOL       *This,\r
  IN  BOOLEAN                         UseDatabase,\r
  IN  FRAMEWORK_EFI_HII_HANDLE        *Handle,\r
  IN  UINTN                           HandleCount,\r
  IN  FRAMEWORK_EFI_IFR_PACKET                  *Packet, OPTIONAL\r
  IN  EFI_HANDLE                      CallbackHandle, OPTIONAL\r
  IN  UINT8                           *NvMapOverride, OPTIONAL\r
  IN  FRAMEWORK_EFI_SCREEN_DESCRIPTOR            *ScreenDimensions, OPTIONAL\r
  OUT BOOLEAN                         *ResetRequired OPTIONAL\r
  );\r
\r
EFI_STATUS\r
EFIAPI \r
ThunkCreatePopUp (\r
  IN  UINTN                           NumberOfLines,\r
  IN  BOOLEAN                         HotKey,\r
  IN  UINTN                           MaximumStringSize,\r
  OUT CHAR16                          *StringBuffer,\r
  OUT EFI_INPUT_KEY                   *KeyValue,\r
  IN  CHAR16                          *String,\r
  ...\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
RemovePackNotify (\r
  IN UINT8                              PackageType,\r
  IN CONST EFI_GUID                     *PackageGuid,\r
  IN CONST EFI_HII_PACKAGE_HEADER       *Package,\r
  IN EFI_HII_HANDLE                     Handle,\r
  IN EFI_HII_DATABASE_NOTIFY_TYPE       NotifyType\r
  )\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
NewOrAddPackNotify (\r
  IN UINT8                              PackageType,\r
  IN CONST EFI_GUID                     *PackageGuid,\r
  IN CONST EFI_HII_PACKAGE_HEADER       *Package,\r
  IN EFI_HII_HANDLE                     Handle,\r
  IN EFI_HII_DATABASE_NOTIFY_TYPE       NotifyType\r
  )\r
;\r
\r
#include "Utility.h"\r
#include "ConfigAccess.h"\r
\r
#endif\r
Commit	Line	Data
4259256b	1	/**@file\r
	2	\r
	3	This file contains global defines and prototype definitions\r
	4	for the HII database.\r
	5	\r
	6	Copyright (c) 2006 - 2008, Intel Corporation\r
	7	All rights reserved. This program and the accompanying materials\r
	8	are licensed and made available under the terms and conditions of the BSD License\r
	9	which accompanies this distribution. The full text of the license may be found at\r
	10	http://opensource.org/licenses/bsd-license.php\r
	11	\r
	12	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	13	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	14	\r
	15	**/\r
	16	\r
	17	#ifndef _HIIDATABASE_H\r
	18	#define _HIIDATABASE_H\r
	19	\r
	20	\r
	21	#include <FrameworkDxe.h>\r
	22	\r
	23	#include <Guid/GlobalVariable.h>\r
	24	#include <Protocol/FrameworkFormCallback.h>\r
	25	#include <Protocol/FrameworkHii.h>\r
137c54ac	26	#include <Protocol/FrameworkFormBrowser.h>\r
4259256b	27	\r
	28	//\r
	29	// UEFI HII Protocols\r
	30	//\r
	31	#include <Protocol/HiiFont.h>\r
	32	#include <Protocol/HiiImage.h>\r
	33	#include <Protocol/HiiString.h>\r
	34	#include <Protocol/HiiDatabase.h>\r
	35	#include <Protocol/HiiConfigRouting.h>\r
	36	#include <Protocol/HiiConfigAccess.h>\r
	37	\r
	38	\r
	39	#include <Library/BaseLib.h>\r
	40	#include <Library/DebugLib.h>\r
	41	#include <Library/UefiDriverEntryPoint.h>\r
	42	#include <Library/MemoryAllocationLib.h>\r
	43	#include <Library/BaseMemoryLib.h>\r
	44	#include <Library/UefiBootServicesTableLib.h>\r
	45	#include <Library/UefiRuntimeServicesTableLib.h>\r
4259256b	46	#include <Library/HiiLib.h>\r
ebbd2793	47	#include <Library/ExtendedHiiLib.h>\r
4259256b	48	\r
99a83b4c	49	#include <Library/IfrSupportLib.h>\r
	50	#include <Library/ExtendedIfrSupportLib.h>\r
	51	\r
59336178	52	#include <MdeModuleHii.h>\r
59336178	53	\r
99a83b4c	54	#pragma pack (push, 1)\r
4259256b	55	typedef struct {\r
	56	UINT32 BinaryLength;\r
	57	EFI_HII_PACKAGE_HEADER PackageHeader;\r
	58	} TIANO_AUTOGEN_PACKAGES_HEADER;\r
99a83b4c	59	#pragma pack (pop)\r
4259256b	60	\r
0368663f	61	#define HII_THUNK_PRIVATE_DATA_FROM_THIS(Record) CR(Record, HII_THUNK_PRIVATE_DATA, Hii, HII_THUNK_PRIVATE_DATA_SIGNATURE)\r
0368663f	62	#define HII_THUNK_PRIVATE_DATA_SIGNATURE EFI_SIGNATURE_32 ('H', 'i', 'I', 'T')\r
4259256b	63	typedef struct {\r
	64	UINTN Signature;\r
	65	EFI_HANDLE Handle;\r
	66	EFI_HII_PROTOCOL Hii;\r
	67	FRAMEWORK_EFI_HII_HANDLE StaticHiiHandle;\r
ea58467b	68	FRAMEWORK_EFI_HII_HANDLE StaticPureUefiHiiHandle;\r
4259256b	69	\r
4259256b	70	//\r
0368663f	71	// The head of link list for all HII_THUNK_CONTEXT.\r
4259256b	72	//\r
0368663f	73	LIST_ENTRY ThunkContextListHead;\r
ea58467b	74	\r
ea58467b	75	EFI_HANDLE RemovePackNotifyHandle;\r
ea58467b	76	EFI_HANDLE AddPackNotifyHandle;\r
0368663f	77	} HII_THUNK_PRIVATE_DATA;\r
0368663f	78	\r
4259256b	79	\r
4259256b	80	\r
0368663f	81	#define ONE_OF_OPTION_MAP_ENTRY_FROM_LINK(Record) CR(Record, ONE_OF_OPTION_MAP_ENTRY, Link, ONE_OF_OPTION_MAP_ENTRY_SIGNATURE)\r
0368663f	82	#define ONE_OF_OPTION_MAP_ENTRY_SIGNATURE EFI_SIGNATURE_32 ('O', 'O', 'M', 'E')\r
4259256b	83	typedef struct {\r
0368663f	84	UINT32 Signature;\r
	85	LIST_ENTRY Link;\r
	86	\r
	87	UINT16 FwKey;\r
	88	EFI_IFR_TYPE_VALUE Value;\r
	89	\r
	90	} ONE_OF_OPTION_MAP_ENTRY;\r
	91	\r
	92	\r
	93	\r
	94	#define ONE_OF_OPTION_MAP_FROM_LINK(Record) CR(Record, ONE_OF_OPTION_MAP, Link, ONE_OF_OPTION_MAP_SIGNATURE)\r
	95	#define ONE_OF_OPTION_MAP_SIGNATURE EFI_SIGNATURE_32 ('O', 'O', 'O', 'M')\r
	96	typedef struct {\r
	97	UINT32 Signature;\r
	98	LIST_ENTRY Link; \r
	99	\r
	100	UINT8 ValueType; //EFI_IFR_TYPE_NUM_* \r
	101	\r
	102	EFI_QUESTION_ID QuestionId;\r
	103	\r
	104	LIST_ENTRY OneOfOptionMapEntryListHead; //ONE_OF_OPTION_MAP_ENTRY\r
	105	} ONE_OF_OPTION_MAP;\r
	106	\r
	107	\r
	108	\r
	109	#define QUESTION_ID_MAP_ENTRY_FROM_LINK(Record) CR(Record, QUESTION_ID_MAP_ENTRY, Link, QUESTION_ID_MAP_ENTRY_SIGNATURE)\r
	110	#define QUESTION_ID_MAP_ENTRY_SIGNATURE EFI_SIGNATURE_32 ('Q', 'I', 'M', 'E')\r
	111	typedef struct {\r
	112	UINT32 Signature;\r
	113	LIST_ENTRY Link;\r
	114	UINT16 FwQId;\r
	115	EFI_QUESTION_ID UefiQid;\r
	116	} QUESTION_ID_MAP_ENTRY;\r
	117	\r
	118	\r
	119	\r
	120	#define QUESTION_ID_MAP_FROM_LINK(Record) CR(Record, QUESTION_ID_MAP, Link, QUESTION_ID_MAP_SIGNATURE)\r
	121	#define QUESTION_ID_MAP_SIGNATURE EFI_SIGNATURE_32 ('Q', 'I', 'M', 'P')\r
	122	typedef struct {\r
	123	UINT32 Signature;\r
	124	LIST_ENTRY Link;\r
	125	UINT16 VarStoreId;\r
	126	UINTN VarSize;\r
	127	LIST_ENTRY MapEntryListHead;\r
	128	} QUESTION_ID_MAP;\r
	129	\r
	130	\r
	131	\r
	132	#define HII_THUNK_CONTEXT_FROM_LINK(Record) CR(Record, HII_THUNK_CONTEXT, Link, HII_THUNK_CONTEXT_SIGNATURE)\r
	133	#define HII_THUNK_CONTEXT_SIGNATURE EFI_SIGNATURE_32 ('H', 'T', 'H', 'M')\r
	134	typedef struct {\r
	135	LIST_ENTRY Link;\r
4259256b	136	UINT32 Signature;\r
0368663f	137	FRAMEWORK_EFI_HII_HANDLE FwHiiHandle;\r
4259256b	138	EFI_HII_HANDLE UefiHiiHandle;\r
63dd6a96	139	EFI_HANDLE UefiHiiDriverHandle;\r
4259256b	140	\r
0368663f	141	UINTN IfrPackageCount;\r
	142	UINTN StringPackageCount;\r
	143	\r
4259256b	144	//\r
	145	// The field below is only valid if IsPackageListWithOnlyStringPack is TRUE.\r
	146	// The HII 0.92 version of HII data implementation in EDK 1.03 and 1.04 make an the following assumption\r
	147	// in both HII Database implementation and all modules that registering packages:\r
0368663f	148	// If a Package List has only IFR package and no String Package, the IFR package will reference \r
	149	// String in another Package List registered with the HII database with the same EFI_HII_PACKAGES.GuidId.\r
	150	// TagGuid is the used to record this GuidId.\r
4259256b	151	EFI_GUID TagGuid;\r
0368663f	152	\r
	153	LIST_ENTRY QuestionIdMapListHead; //QUESTION_ID_MAP\r
	154	\r
	155	LIST_ENTRY OneOfOptionMapListHead; //ONE_OF_OPTION_MAP\r
	156	\r
	157	UINT8 *NvMapOverride;\r
	158	\r
	159	UINT16 FormSetClass;\r
	160	UINT16 FormSetSubClass;\r
	161	STRING_REF FormSetTitle;\r
	162	STRING_REF FormSetHelp;\r
ebbd2793	163	\r
0368663f	164	} HII_THUNK_CONTEXT;\r
0368663f	165	\r
4259256b	166	\r
0368663f	167	\r
	168	#define BUFFER_STORAGE_ENTRY_SIGNATURE EFI_SIGNATURE_32 ('H', 'T', 's', 'k')\r
	169	#define BUFFER_STORAGE_ENTRY_FROM_LINK(Record) CR(Record, BUFFER_STORAGE_ENTRY, Link, BUFFER_STORAGE_ENTRY_SIGNATURE)\r
ebbd2793	170	typedef struct {\r
0368663f	171	LIST_ENTRY Link;\r
ebbd2793	172	UINT32 Signature;\r
	173	EFI_GUID Guid;\r
	174	CHAR16 *Name;\r
	175	UINTN Size;\r
	176	UINT16 VarStoreId;\r
0368663f	177	} BUFFER_STORAGE_ENTRY;\r
0368663f	178	\r
ebbd2793	179	\r
0368663f	180	\r
	181	#define CONFIG_ACCESS_PRIVATE_SIGNATURE EFI_SIGNATURE_32 ('H', 'T', 'c', 'a')\r
	182	#define CONFIG_ACCESS_PRIVATE_FROM_PROTOCOL(Record) CR(Record, CONFIG_ACCESS_PRIVATE, ConfigAccessProtocol, CONFIG_ACCESS_PRIVATE_SIGNATURE)\r
ebbd2793	183	typedef struct {\r
	184	UINT32 Signature;\r
	185	EFI_HII_CONFIG_ACCESS_PROTOCOL ConfigAccessProtocol;\r
0368663f	186	//\r
	187	// Framework's callback\r
	188	//\r
	189	EFI_FORM_CALLBACK_PROTOCOL *FormCallbackProtocol;\r
	190	\r
	191	LIST_ENTRY BufferStorageListHead;\r
	192	\r
	193	HII_THUNK_CONTEXT *ThunkContext;\r
	194	} CONFIG_ACCESS_PRIVATE;\r
	195	\r
	196	\r
ebbd2793	197	\r
137c54ac	198	#define EFI_FORMBROWSER_THUNK_PRIVATE_DATA_SIGNATURE EFI_SIGNATURE_32 ('F', 'B', 'T', 'd')\r
0368663f	199	#define EFI_FORMBROWSER_THUNK_PRIVATE_DATA_FROM_THIS(Record) CR(Record, EFI_FORMBROWSER_THUNK_PRIVATE_DATA, FormBrowser, EFI_FORMBROWSER_THUNK_PRIVATE_DATA_SIGNATURE)\r
137c54ac	200	typedef struct {\r
	201	UINTN Signature;\r
	202	EFI_HANDLE Handle;\r
0368663f	203	HII_THUNK_PRIVATE_DATA *ThunkPrivate;\r
137c54ac	204	EFI_FORM_BROWSER_PROTOCOL FormBrowser;\r
	205	} EFI_FORMBROWSER_THUNK_PRIVATE_DATA;\r
	206	\r
	207	\r
4259256b	208	//\r
	209	// Extern Variables\r
	210	//\r
59336178	211	extern CONST EFI_HII_DATABASE_PROTOCOL *mHiiDatabase;\r
59336178	212	extern CONST EFI_HII_IMAGE_PROTOCOL *mHiiImageProtocol;\r
59336178	213	extern CONST EFI_HII_STRING_PROTOCOL *mHiiStringProtocol;\r
133a9dfb	214	extern CONST EFI_HII_FONT_PROTOCOL *mHiiFontProtocol;\r
59336178	215	extern CONST EFI_HII_CONFIG_ROUTING_PROTOCOL *mHiiConfigRoutingProtocol;\r
0368663f	216	extern CONST EFI_FORM_BROWSER2_PROTOCOL *mFormBrowser2Protocol;\r
4259256b	217	\r
0368663f	218	extern HII_THUNK_PRIVATE_DATA *mHiiThunkPrivateData;\r
	219	\r
	220	extern BOOLEAN mInFrameworkUpdatePakcage;\r
ea58467b	221	\r
ea58467b	222	\r
4259256b	223	//\r
	224	// Prototypes\r
	225	//\r
	226	\r
	227	//\r
	228	// Public Interface Prototypes\r
	229	//\r
	230	EFI_STATUS\r
	231	EFIAPI\r
	232	InitializeHiiDatabase (\r
	233	IN EFI_HANDLE ImageHandle,\r
	234	IN EFI_SYSTEM_TABLE *SystemTable\r
	235	)\r
	236	;\r
	237	\r
	238	EFI_STATUS\r
	239	EFIAPI\r
	240	HiiNewPack (\r
	241	IN EFI_HII_PROTOCOL *This,\r
	242	IN EFI_HII_PACKAGES *PackageList,\r
	243	OUT FRAMEWORK_EFI_HII_HANDLE *Handle\r
	244	)\r
	245	;\r
	246	\r
	247	EFI_STATUS\r
	248	EFIAPI\r
	249	HiiRemovePack (\r
	250	IN EFI_HII_PROTOCOL *This,\r
	251	IN FRAMEWORK_EFI_HII_HANDLE Handle\r
	252	)\r
	253	;\r
	254	\r
	255	EFI_STATUS\r
	256	EFIAPI\r
	257	HiiFindHandles (\r
	258	IN EFI_HII_PROTOCOL *This,\r
	259	IN OUT UINT16 *HandleBufferLength,\r
	260	OUT FRAMEWORK_EFI_HII_HANDLE *Handle\r
	261	)\r
	262	;\r
	263	\r
	264	EFI_STATUS\r
	265	EFIAPI\r
	266	HiiExportDatabase (\r
	267	IN EFI_HII_PROTOCOL *This,\r
	268	IN FRAMEWORK_EFI_HII_HANDLE Handle,\r
	269	IN OUT UINTN *BufferSize,\r
	270	OUT VOID *Buffer\r
	271	)\r
	272	;\r
	273	\r
	274	EFI_STATUS\r
	275	EFIAPI\r
	276	HiiGetGlyph (\r
	277	IN EFI_HII_PROTOCOL *This,\r
	278	IN CHAR16 *Source,\r
	279	IN OUT UINT16 *Index,\r
	280	OUT UINT8 **GlyphBuffer,\r
	281	OUT UINT16 *BitWidth,\r
	282	IN OUT UINT32 *InternalStatus\r
	283	)\r
	284	;\r
	285	\r
	286	EFI_STATUS\r
287	EFIAPI\r
288	HiiGlyphToBlt (\r
289	IN EFI_HII_PROTOCOL *This,\r
290	IN UINT8 *GlyphBuffer,\r
291	IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground,\r
292	IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background,\r
293	IN UINTN Count,\r
294	IN UINTN Width,\r
295	IN UINTN Height,\r
296	IN OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer\r
297	)\r
298	;\r
299	\r
300	EFI_STATUS\r
301	EFIAPI\r
302	HiiNewString (\r
303	IN EFI_HII_PROTOCOL *This,\r
304	IN CHAR16 *Language,\r
305	IN FRAMEWORK_EFI_HII_HANDLE Handle,\r
306	IN OUT STRING_REF *Reference,\r
307	IN CHAR16 *NewString\r
308	)\r
309	;\r
310	\r
311	EFI_STATUS\r
312	EFIAPI\r
313	HiiGetString (\r
314	IN EFI_HII_PROTOCOL *This,\r
315	IN FRAMEWORK_EFI_HII_HANDLE Handle,\r
316	IN STRING_REF Token,\r
317	IN BOOLEAN Raw,\r
318	IN CHAR16 *LanguageString,\r
319	IN OUT UINTN *BufferLength,\r
320	OUT EFI_STRING StringBuffer\r
321	)\r
322	;\r
323	\r
324	EFI_STATUS\r
325	EFIAPI\r
326	HiiResetStrings (\r
327	IN EFI_HII_PROTOCOL *This,\r
328	IN FRAMEWORK_EFI_HII_HANDLE Handle\r
329	)\r
330	;\r
331	\r
332	EFI_STATUS\r
333	EFIAPI\r
334	HiiTestString (\r
335	IN EFI_HII_PROTOCOL *This,\r
336	IN CHAR16 *StringToTest,\r
337	IN OUT UINT32 *FirstMissing,\r
338	OUT UINT32 *GlyphBufferSize\r
339	)\r
340	;\r
341	\r
342	EFI_STATUS\r
343	EFIAPI\r
344	HiiGetPrimaryLanguages (\r
345	IN EFI_HII_PROTOCOL *This,\r
346	IN FRAMEWORK_EFI_HII_HANDLE Handle,\r
347	OUT EFI_STRING *LanguageString\r
348	)\r
349	;\r
350	\r
351	EFI_STATUS\r
352	EFIAPI\r
353	HiiGetSecondaryLanguages (\r
354	IN EFI_HII_PROTOCOL *This,\r
355	IN FRAMEWORK_EFI_HII_HANDLE Handle,\r
356	IN CHAR16 *PrimaryLanguage,\r
357	OUT EFI_STRING *LanguageString\r
358	)\r
359	;\r
360	\r
361	EFI_STATUS\r
362	EFIAPI\r
363	HiiGetLine (\r
364	IN EFI_HII_PROTOCOL *This,\r
365	IN FRAMEWORK_EFI_HII_HANDLE Handle,\r
366	IN STRING_REF Token,\r
367	IN OUT UINT16 *Index,\r
368	IN UINT16 LineWidth,\r
369	IN CHAR16 *LanguageString,\r
370	IN OUT UINT16 *BufferLength,\r
371	OUT EFI_STRING StringBuffer\r
372	)\r
373	;\r
374	\r
375	EFI_STATUS\r
376	EFIAPI\r
377	HiiGetForms (\r
378	IN EFI_HII_PROTOCOL *This,\r
379	IN FRAMEWORK_EFI_HII_HANDLE Handle,\r
380	IN EFI_FORM_ID FormId,\r
381	IN OUT UINTN *BufferLength,\r
382	OUT UINT8 *Buffer\r
383	)\r
384	;\r
385	\r
386	EFI_STATUS\r
387	EFIAPI\r
388	HiiGetDefaultImage (\r
389	IN EFI_HII_PROTOCOL *This,\r
390	IN FRAMEWORK_EFI_HII_HANDLE Handle,\r
391	IN UINTN DefaultMask,\r
392	OUT EFI_HII_VARIABLE_PACK_LIST **VariablePackList\r
393	)\r
394	;\r
395	\r
396	EFI_STATUS\r
397	EFIAPI\r
398	HiiUpdateForm (\r
399	IN EFI_HII_PROTOCOL *This,\r
400	IN FRAMEWORK_EFI_HII_HANDLE Handle,\r
401	IN EFI_FORM_LABEL Label,\r
402	IN BOOLEAN AddData,\r
99a83b4c	403	IN FRAMEWORK_EFI_HII_UPDATE_DATA *Data\r
4259256b	404	)\r
	405	;\r
	406	\r
	407	EFI_STATUS\r
	408	EFIAPI\r
	409	HiiGetKeyboardLayout (\r
	410	IN EFI_HII_PROTOCOL *This,\r
	411	OUT UINT16 *DescriptorCount,\r
	412	OUT FRAMEWORK_EFI_KEY_DESCRIPTOR *Descriptor\r
	413	)\r
	414	;\r
	415	\r
	416	EFI_STATUS\r
	417	HiiCompareLanguage (\r
	418	IN CHAR16 *LanguageStringLocation,\r
	419	IN CHAR16 *Language\r
	420	)\r
	421	;\r
	422	\r
137c54ac	423	\r
	424	\r
	425	EFI_STATUS\r
	426	EFIAPI \r
	427	ThunkSendForm (\r
	428	IN EFI_FORM_BROWSER_PROTOCOL *This,\r
	429	IN BOOLEAN UseDatabase,\r
	430	IN FRAMEWORK_EFI_HII_HANDLE *Handle,\r
	431	IN UINTN HandleCount,\r
	432	IN FRAMEWORK_EFI_IFR_PACKET *Packet, OPTIONAL\r
	433	IN EFI_HANDLE CallbackHandle, OPTIONAL\r
	434	IN UINT8 *NvMapOverride, OPTIONAL\r
	435	IN FRAMEWORK_EFI_SCREEN_DESCRIPTOR *ScreenDimensions, OPTIONAL\r
	436	OUT BOOLEAN *ResetRequired OPTIONAL\r
	437	);\r
	438	\r
	439	EFI_STATUS\r
	440	EFIAPI \r
	441	ThunkCreatePopUp (\r
	442	IN UINTN NumberOfLines,\r
	443	IN BOOLEAN HotKey,\r
	444	IN UINTN MaximumStringSize,\r
	445	OUT CHAR16 *StringBuffer,\r
	446	OUT EFI_INPUT_KEY *KeyValue,\r
	447	IN CHAR16 *String,\r
	448	...\r
	449	);\r
	450	\r
0368663f	451	EFI_STATUS\r
	452	EFIAPI\r
	453	RemovePackNotify (\r
	454	IN UINT8 PackageType,\r
	455	IN CONST EFI_GUID *PackageGuid,\r
	456	IN CONST EFI_HII_PACKAGE_HEADER *Package,\r
	457	IN EFI_HII_HANDLE Handle,\r
	458	IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType\r
	459	)\r
	460	;\r
	461	\r
	462	EFI_STATUS\r
	463	EFIAPI\r
	464	NewOrAddPackNotify (\r
	465	IN UINT8 PackageType,\r
	466	IN CONST EFI_GUID *PackageGuid,\r
	467	IN CONST EFI_HII_PACKAGE_HEADER *Package,\r
	468	IN EFI_HII_HANDLE Handle,\r
	469	IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType\r
	470	)\r
	471	;\r
	472	\r
ee3428bb	473	#include "Utility.h"\r
ebbd2793	474	#include "ConfigAccess.h"\r
ee3428bb	475	\r
4259256b	476	#endif\r