#include "InternalHiiLib.h"

Data Structures
struct	IFR_BLOCK_DATA

struct	IFR_VARSTORAGE_DATA

struct	HII_LIB_OPCODE_BUFFER

Macros
#define	GUID_CONFIG_STRING_TYPE 0x00

#define	NAME_CONFIG_STRING_TYPE 0x01

#define	PATH_CONFIG_STRING_TYPE 0x02

#define	ACTION_SET_DEFAUTL_VALUE 0x01

#define	ACTION_VALIDATE_SETTING 0x02

#define	HII_LIB_DEFAULT_VARSTORE_SIZE 0x200

#define	HII_LIB_OPCODE_ALLOCATION_SIZE 0x200

Functions
EFI_STATUS EFIAPI	InternalHiiExtractGuidFromHiiHandle (IN EFI_HII_HANDLE Handle, OUT EFI_GUID *Guid)

EFI_HII_HANDLE EFIAPI	HiiAddPackages (IN CONST EFI_GUID *PackageListGuid, IN EFI_HANDLE DeviceHandle OPTIONAL,...)

VOID EFIAPI	HiiRemovePackages (IN EFI_HII_HANDLE HiiHandle)

EFI_HII_HANDLE *EFIAPI	HiiGetHiiHandles (IN CONST EFI_GUID *PackageListGuid OPTIONAL)

EFI_STATUS EFIAPI	HiiGetFormSetFromHiiHandle (IN EFI_HII_HANDLE Handle, OUT EFI_IFR_FORM_SET *Buffer, OUT UINTN BufferSize)

EFI_STRING EFIAPI	InternalHiiLowerConfigString (IN EFI_STRING ConfigString)

EFI_STRING EFIAPI	InternalHiiBlockToConfig (IN CONST EFI_STRING ConfigRequest, IN CONST UINT8 *Block, IN UINTN BlockSize)

EFI_STRING EFIAPI	InternalHiiBrowserCallback (IN CONST EFI_GUID VariableGuid OPTIONAL, IN CONST CHAR16 VariableName OPTIONAL, IN CONST EFI_STRING SetResultsData OPTIONAL)

EFI_STRING EFIAPI	HiiConstructConfigHdr (IN CONST EFI_GUID Guid OPTIONAL, IN CONST CHAR16 Name OPTIONAL, IN EFI_HANDLE DriverHandle)

EFI_STATUS	InternalHiiGetBufferFromString (IN EFI_STRING String, IN UINT8 Flag, OUT UINT8 **Buffer)

BOOLEAN	BlockArrayCheck (IN IFR_BLOCK_DATA *BlockArray, IN UINT16 VarOffset, IN UINT16 VarWidth)

EFI_STATUS EFIAPI	InternalHiiGetValueOfNumber (IN EFI_STRING ValueString, OUT UINT8 *ValueData, OUT UINTN ValueLength)

EFI_STATUS	GetValueFromRequest (IN CHAR16 ConfigElement, IN CHAR16 VarName, OUT UINT64 *VarValue)

EFI_STATUS	ValidateQuestionFromVfr (IN EFI_HII_PACKAGE_LIST_HEADER HiiPackageList, IN UINTN PackageListLength, IN EFI_GUID VarGuid, IN CHAR16 VarName, IN UINT8 VarBuffer, IN IFR_BLOCK_DATA CurrentBlockArray, IN CHAR16 RequestElement, IN EFI_HII_HANDLE HiiHandle, IN BOOLEAN NameValueType)

EFI_STATUS	GetBlockDataInfo (IN CHAR16 ConfigElement, OUT IFR_BLOCK_DATA CurrentBlockArray, OUT UINT8 *VarBuffer)

EFI_STATUS EFIAPI	InternalHiiValidateCurrentSetting (IN EFI_STRING ConfigResp, IN EFI_HII_PACKAGE_LIST_HEADER HiiPackageList, IN UINTN PackageListLength, IN EFI_GUID VarGuid, IN CHAR16 *VarName, IN EFI_HII_HANDLE HiiHandle)

BOOLEAN	GetElementsFromRequest (IN EFI_STRING ConfigRequest)

BOOLEAN EFIAPI	InternalHiiIfrValueAction (IN CONST EFI_STRING Request OPTIONAL, IN UINT16 DefaultId, IN UINT8 ActionType)

BOOLEAN EFIAPI	HiiValidateSettings (IN CONST EFI_STRING Request OPTIONAL)

BOOLEAN EFIAPI	HiiSetToDefaults (IN CONST EFI_STRING Request OPTIONAL, IN UINT16 DefaultId)

BOOLEAN EFIAPI	InternalHiiCompareSubString (IN CHAR16 FirstString, IN CHAR16 SecondString, IN CHAR16 StartSearchString, IN CHAR16 StopSearchString)

BOOLEAN EFIAPI	HiiIsConfigHdrMatch (IN CONST EFI_STRING ConfigHdr, IN CONST EFI_GUID Guid OPTIONAL, IN CONST CHAR16 Name OPTIONAL)

BOOLEAN EFIAPI	HiiGetBrowserData (IN CONST EFI_GUID VariableGuid OPTIONAL, IN CONST CHAR16 VariableName OPTIONAL, IN UINTN BufferSize, OUT UINT8 *Buffer)

BOOLEAN EFIAPI	HiiSetBrowserData (IN CONST EFI_GUID VariableGuid OPTIONAL, IN CONST CHAR16 VariableName OPTIONAL, IN UINTN BufferSize, IN CONST UINT8 Buffer, IN CONST CHAR16 RequestElement OPTIONAL)

VOID *EFIAPI	HiiAllocateOpCodeHandle (VOID)

VOID EFIAPI	HiiFreeOpCodeHandle (VOID *OpCodeHandle)

UINTN EFIAPI	InternalHiiOpCodeHandlePosition (IN VOID *OpCodeHandle)

UINT8 *EFIAPI	InternalHiiOpCodeHandleBuffer (IN VOID *OpCodeHandle)

UINT8 *EFIAPI	InternalHiiGrowOpCodeHandle (IN VOID *OpCodeHandle, IN UINTN Size)

UINT8 *EFIAPI	InternalHiiCreateOpCodeExtended (IN VOID OpCodeHandle, IN VOID OpCodeTemplate, IN UINT8 OpCode, IN UINTN OpCodeSize, IN UINTN ExtensionSize, IN UINT8 Scope)

UINT8 *EFIAPI	InternalHiiCreateOpCode (IN VOID OpCodeHandle, IN VOID OpCodeTemplate, IN UINT8 OpCode, IN UINTN OpCodeSize)

UINT8 *EFIAPI	HiiCreateRawOpCodes (IN VOID OpCodeHandle, IN UINT8 RawBuffer, IN UINTN RawBufferSize)

UINT8 *EFIAPI	InternalHiiAppendOpCodes (IN VOID OpCodeHandle, IN VOID RawOpCodeHandle)

UINT8 *EFIAPI	HiiCreateEndOpCode (IN VOID *OpCodeHandle)

UINT8 *EFIAPI	HiiCreateOneOfOptionOpCode (IN VOID *OpCodeHandle, IN UINT16 StringId, IN UINT8 Flags, IN UINT8 Type, IN UINT64 Value)

UINT8 *EFIAPI	HiiCreateDefaultOpCode (IN VOID *OpCodeHandle, IN UINT16 DefaultId, IN UINT8 Type, IN UINT64 Value)

UINT8 *EFIAPI	HiiCreateGuidOpCode (IN VOID OpCodeHandle, IN CONST EFI_GUID Guid, IN CONST VOID *GuidOpCode OPTIONAL, IN UINTN OpCodeSize)

UINT8 *EFIAPI	HiiCreateActionOpCode (IN VOID *OpCodeHandle, IN EFI_QUESTION_ID QuestionId, IN EFI_STRING_ID Prompt, IN EFI_STRING_ID Help, IN UINT8 QuestionFlags, IN EFI_STRING_ID QuestionConfig)

UINT8 *EFIAPI	HiiCreateSubTitleOpCode (IN VOID *OpCodeHandle, IN EFI_STRING_ID Prompt, IN EFI_STRING_ID Help, IN UINT8 Flags, IN UINT8 Scope)

UINT8 *EFIAPI	HiiCreateGotoOpCode (IN VOID *OpCodeHandle, IN EFI_FORM_ID FormId, IN EFI_STRING_ID Prompt, IN EFI_STRING_ID Help, IN UINT8 QuestionFlags, IN EFI_QUESTION_ID QuestionId)

UINT8 *EFIAPI	HiiCreateGotoExOpCode (IN VOID OpCodeHandle, IN EFI_FORM_ID RefFormId, IN EFI_STRING_ID Prompt, IN EFI_STRING_ID Help, IN UINT8 QuestionFlags, IN EFI_QUESTION_ID QuestionId, IN EFI_QUESTION_ID RefQuestionId, IN EFI_GUID RefFormSetId OPTIONAL, IN EFI_STRING_ID RefDevicePath)

UINT8 *EFIAPI	HiiCreateCheckBoxOpCode (IN VOID OpCodeHandle, IN EFI_QUESTION_ID QuestionId, IN EFI_VARSTORE_ID VarStoreId, IN UINT16 VarOffset, IN EFI_STRING_ID Prompt, IN EFI_STRING_ID Help, IN UINT8 QuestionFlags, IN UINT8 CheckBoxFlags, IN VOID DefaultsOpCodeHandle OPTIONAL)

UINT8 *EFIAPI	HiiCreateNumericOpCode (IN VOID OpCodeHandle, IN EFI_QUESTION_ID QuestionId, IN EFI_VARSTORE_ID VarStoreId, IN UINT16 VarOffset, IN EFI_STRING_ID Prompt, IN EFI_STRING_ID Help, IN UINT8 QuestionFlags, IN UINT8 NumericFlags, IN UINT64 Minimum, IN UINT64 Maximum, IN UINT64 Step, IN VOID DefaultsOpCodeHandle OPTIONAL)

UINT8 *EFIAPI	HiiCreateStringOpCode (IN VOID OpCodeHandle, IN EFI_QUESTION_ID QuestionId, IN EFI_VARSTORE_ID VarStoreId, IN UINT16 VarOffset, IN EFI_STRING_ID Prompt, IN EFI_STRING_ID Help, IN UINT8 QuestionFlags, IN UINT8 StringFlags, IN UINT8 MinSize, IN UINT8 MaxSize, IN VOID DefaultsOpCodeHandle OPTIONAL)

UINT8 *EFIAPI	HiiCreateOneOfOpCode (IN VOID OpCodeHandle, IN EFI_QUESTION_ID QuestionId, IN EFI_VARSTORE_ID VarStoreId, IN UINT16 VarOffset, IN EFI_STRING_ID Prompt, IN EFI_STRING_ID Help, IN UINT8 QuestionFlags, IN UINT8 OneOfFlags, IN VOID OptionsOpCodeHandle, IN VOID *DefaultsOpCodeHandle OPTIONAL)

UINT8 *EFIAPI	HiiCreateOrderedListOpCode (IN VOID OpCodeHandle, IN EFI_QUESTION_ID QuestionId, IN EFI_VARSTORE_ID VarStoreId, IN UINT16 VarOffset, IN EFI_STRING_ID Prompt, IN EFI_STRING_ID Help, IN UINT8 QuestionFlags, IN UINT8 OrderedListFlags, IN UINT8 DataType, IN UINT8 MaxContainers, IN VOID OptionsOpCodeHandle, IN VOID *DefaultsOpCodeHandle OPTIONAL)

UINT8 *EFIAPI	HiiCreateTextOpCode (IN VOID *OpCodeHandle, IN EFI_STRING_ID Prompt, IN EFI_STRING_ID Help, IN EFI_STRING_ID TextTwo)

UINT8 *EFIAPI	HiiCreateDateOpCode (IN VOID OpCodeHandle, IN EFI_QUESTION_ID QuestionId, IN EFI_VARSTORE_ID VarStoreId OPTIONAL, IN UINT16 VarOffset OPTIONAL, IN EFI_STRING_ID Prompt, IN EFI_STRING_ID Help, IN UINT8 QuestionFlags, IN UINT8 DateFlags, IN VOID DefaultsOpCodeHandle OPTIONAL)

UINT8 *EFIAPI	HiiCreateTimeOpCode (IN VOID OpCodeHandle, IN EFI_QUESTION_ID QuestionId, IN EFI_VARSTORE_ID VarStoreId OPTIONAL, IN UINT16 VarOffset OPTIONAL, IN EFI_STRING_ID Prompt, IN EFI_STRING_ID Help, IN UINT8 QuestionFlags, IN UINT8 TimeFlags, IN VOID DefaultsOpCodeHandle OPTIONAL)

EFI_STATUS EFIAPI	InternalHiiUpdateFormPackageData (IN EFI_GUID FormSetGuid OPTIONAL, IN EFI_FORM_ID FormId, IN EFI_HII_PACKAGE_HEADER Package, IN HII_LIB_OPCODE_BUFFER OpCodeBufferStart, IN HII_LIB_OPCODE_BUFFER OpCodeBufferEnd OPTIONAL, OUT EFI_HII_PACKAGE_HEADER *TempPackage)

EFI_STATUS EFIAPI	HiiUpdateForm (IN EFI_HII_HANDLE HiiHandle, IN EFI_GUID FormSetGuid OPTIONAL, IN EFI_FORM_ID FormId, IN VOID StartOpCodeHandle, IN VOID *EndOpCodeHandle OPTIONAL)

Variables
GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR16	mConfigHdrTemplate [] = L"GUID=00000000000000000000000000000000&NAME=0000&PATH=00"

EFI_FORM_BROWSER2_PROTOCOL *	mUefiFormBrowser2 = NULL

GLOBAL_REMOVE_IF_UNREFERENCED CONST EFI_HII_PACKAGE_HEADER	mEndOfPakageList

GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT8	mHiiDefaultTypeToWidth []

Detailed Description

HII Library implementation that uses DXE protocols and services.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file HiiLib.c.

Macro Definition Documentation

◆ ACTION_SET_DEFAUTL_VALUE

#define ACTION_SET_DEFAUTL_VALUE 0x01

Definition at line 15 of file HiiLib.c.

◆ ACTION_VALIDATE_SETTING

#define ACTION_VALIDATE_SETTING 0x02

Definition at line 16 of file HiiLib.c.

◆ GUID_CONFIG_STRING_TYPE

#define GUID_CONFIG_STRING_TYPE 0x00

Definition at line 11 of file HiiLib.c.

◆ HII_LIB_DEFAULT_VARSTORE_SIZE

#define HII_LIB_DEFAULT_VARSTORE_SIZE 0x200

Definition at line 18 of file HiiLib.c.

◆ HII_LIB_OPCODE_ALLOCATION_SIZE

#define HII_LIB_OPCODE_ALLOCATION_SIZE 0x200

IFR Functions

Definition at line 3019 of file HiiLib.c.

◆ NAME_CONFIG_STRING_TYPE

#define NAME_CONFIG_STRING_TYPE 0x01

Definition at line 12 of file HiiLib.c.

◆ PATH_CONFIG_STRING_TYPE

#define PATH_CONFIG_STRING_TYPE 0x02

Definition at line 13 of file HiiLib.c.

Function Documentation

◆ BlockArrayCheck()

BOOLEAN BlockArrayCheck	(	IN IFR_BLOCK_DATA *	BlockArray,
		IN UINT16	VarOffset,
		IN UINT16	VarWidth
	)

This function checks VarOffset and VarWidth is in the block range.

Parameters

BlockArray	The block array is to be checked.
VarOffset	Offset of var to the structure
VarWidth	Width of var.

Return values

TRUE	This Var is in the block range.
FALSE	This Var is not in the block range.

Definition at line 974 of file HiiLib.c.

◆ GetBlockDataInfo()

EFI_STATUS GetBlockDataInfo	(	IN CHAR16 *	ConfigElement,
		OUT IFR_BLOCK_DATA **	CurrentBlockArray,
		OUT UINT8 **	VarBuffer
	)

This internal function parses IFR data to validate current setting.

Parameters

ConfigElement	ConfigResp element string contains the current setting.
CurrentBlockArray	Current block array.
VarBuffer	Data buffer for this varstore.

Return values

EFI_SUCCESS	The current setting is valid.
EFI_OUT_OF_RESOURCES	The memory is not enough.
EFI_INVALID_PARAMETER	The config string or the Hii package is invalid.

Definition at line 1913 of file HiiLib.c.

◆ GetElementsFromRequest()

BOOLEAN GetElementsFromRequest ( IN EFI_STRING ConfigRequest )

Check whether the ConfigRequest string has the request elements. For EFI_HII_VARSTORE_BUFFER type, the request has "&OFFSET=****&WIDTH=****..." format. For EFI_HII_VARSTORE_NAME_VALUE type, the request has "&NAME1**&NAME2..." format.

Parameters

ConfigRequest The input config request string.

Return values

TRUE	The input include config request elements.
FALSE	The input string not includes.

Definition at line 2269 of file HiiLib.c.

◆ GetValueFromRequest()

EFI_STATUS GetValueFromRequest	(	IN CHAR16 *	ConfigElement,
		IN CHAR16 *	VarName,
		OUT UINT64 *	VarValue
	)

Get value from config request resp string.

Parameters

ConfigElement	ConfigResp string contains the current setting.
VarName	The variable name which need to get value.
VarValue	The return value.

Return values

EFI_SUCCESS	Get the value for the VarName
EFI_OUT_OF_RESOURCES	The memory is not enough.

Definition at line 1089 of file HiiLib.c.

◆ HiiAddPackages()

EFI_HII_HANDLE EFIAPI HiiAddPackages	(	IN CONST EFI_GUID *	PackageListGuid,
		IN EFI_HANDLE DeviceHandle	OPTIONAL,
			...
	)

Registers a list of packages in the HII Database and returns the HII Handle associated with that registration. If an HII Handle has already been registered with the same PackageListGuid and DeviceHandle, then NULL is returned. If there are not enough resources to perform the registration, then NULL is returned. If an empty list of packages is passed in, then NULL is returned. If the size of the list of package is 0, then NULL is returned.

The variable arguments are pointers which point to package header that defined by UEFI VFR compiler and StringGather tool.

#pragma pack (push, 1) typedef struct { UINT32 BinaryLength; EFI_HII_PACKAGE_HEADER PackageHeader; } EDKII_AUTOGEN_PACKAGES_HEADER; #pragma pack (pop)

Parameters

[in]	PackageListGuid	The GUID of the package list.
[in]	DeviceHandle	If not NULL, the Device Handle on which an instance of DEVICE_PATH_PROTOCOL is installed. This Device Handle uniquely defines the device that the added packages are associated with.
[in]	...	The variable argument list that contains pointers to packages terminated by a NULL.

Return values

NULL	A HII Handle has already been registered in the HII Database with the same PackageListGuid and DeviceHandle.
NULL	The HII Handle could not be created.
NULL	An empty list of packages was passed in.
NULL	All packages are empty.
Other	The HII Handle associated with the newly registered package list.

Definition at line 141 of file HiiLib.c.

◆ HiiAllocateOpCodeHandle()

VOID *EFIAPI HiiAllocateOpCodeHandle ( VOID )

Allocates and returns a new OpCode Handle. OpCode Handles must be freed with HiiFreeOpCodeHandle().

Return values

NULL	There are not enough resources to allocate a new OpCode Handle.
Other	A new OpCode handle.

Definition at line 3051 of file HiiLib.c.

◆ HiiConstructConfigHdr()

EFI_STRING EFIAPI HiiConstructConfigHdr	(	IN CONST EFI_GUID *Guid	OPTIONAL,
		IN CONST CHAR16 *Name	OPTIONAL,
		IN EFI_HANDLE	DriverHandle
	)

Allocates and returns a Null-terminated Unicode <ConfigHdr> string using routing information that includes a GUID, an optional Unicode string name, and a device path. The string returned is allocated with AllocatePool(). The caller is responsible for freeing the allocated string with FreePool().

The format of a <ConfigHdr> is as follows:

GUID=<HexCh>32&NAME=<Char>NameLength&PATH=<HexChar>DevicePathSize<Null>

Parameters

[in]	Guid	Pointer to an EFI_GUID that is the routing information GUID. Each of the 16 bytes in Guid is converted to a 2 Unicode character hexadecimal string. This is an optional parameter that may be NULL.
[in]	Name	Pointer to a Null-terminated Unicode string that is the routing information NAME. This is an optional parameter that may be NULL. Each 16-bit Unicode character in Name is converted to a 4 character Unicode hexadecimal string.
[in]	DriverHandle	The driver handle which supports a Device Path Protocol that is the routing information PATH. Each byte of the Device Path associated with DriverHandle is converted to a 2 Unicode character hexadecimal string.

Return values

NULL	DriverHandle does not support the Device Path Protocol.
Other	A pointer to the Null-terminate Unicode <ConfigHdr> string

Definition at line 723 of file HiiLib.c.

◆ HiiCreateActionOpCode()

UINT8 *EFIAPI HiiCreateActionOpCode	(	IN VOID *	OpCodeHandle,
		IN EFI_QUESTION_ID	QuestionId,
		IN EFI_STRING_ID	Prompt,
		IN EFI_STRING_ID	Help,
		IN UINT8	QuestionFlags,
		IN EFI_STRING_ID	QuestionConfig
	)

Create EFI_IFR_ACTION_OP opcode.

If OpCodeHandle is NULL, then ASSERT(). If any reserved bits are set in QuestionFlags, then ASSERT().

Parameters

[in]	OpCodeHandle	Handle to the buffer of opcodes.
[in]	QuestionId	Question ID
[in]	Prompt	String ID for Prompt
[in]	Help	String ID for Help
[in]	QuestionFlags	Flags in Question Header
[in]	QuestionConfig	String ID for configuration

Return values

NULL	There is not enough space left in Buffer to add the opcode.
Other	A pointer to the created opcode.

Definition at line 3461 of file HiiLib.c.

◆ HiiCreateCheckBoxOpCode()

UINT8 *EFIAPI HiiCreateCheckBoxOpCode	(	IN VOID *	OpCodeHandle,
		IN EFI_QUESTION_ID	QuestionId,
		IN EFI_VARSTORE_ID	VarStoreId,
		IN UINT16	VarOffset,
		IN EFI_STRING_ID	Prompt,
		IN EFI_STRING_ID	Help,
		IN UINT8	QuestionFlags,
		IN UINT8	CheckBoxFlags,
		IN VOID *DefaultsOpCodeHandle	OPTIONAL
	)

Create EFI_IFR_CHECKBOX_OP opcode.

If OpCodeHandle is NULL, then ASSERT(). If any reserved bits are set in QuestionFlags, then ASSERT(). If any reserved bits are set in CheckBoxFlags, then ASSERT().

Parameters

[in]	OpCodeHandle	Handle to the buffer of opcodes.
[in]	QuestionId	Question ID
[in]	VarStoreId	Storage ID
[in]	VarOffset	Offset in Storage or String ID of the name (VarName) for this name/value pair.
[in]	Prompt	String ID for Prompt
[in]	Help	String ID for Help
[in]	QuestionFlags	Flags in Question Header
[in]	CheckBoxFlags	Flags for checkbox opcode
[in]	DefaultsOpCodeHandle	Handle for a buffer of DEFAULT opcodes. This is an optional parameter that may be NULL.

Return values

NULL	There is not enough space left in Buffer to add the opcode.
Other	A pointer to the created opcode.

Definition at line 3675 of file HiiLib.c.

◆ HiiCreateDateOpCode()

UINT8 *EFIAPI HiiCreateDateOpCode	(	IN VOID *	OpCodeHandle,
		IN EFI_QUESTION_ID	QuestionId,
		IN EFI_VARSTORE_ID VarStoreId	OPTIONAL,
		IN UINT16 VarOffset	OPTIONAL,
		IN EFI_STRING_ID	Prompt,
		IN EFI_STRING_ID	Help,
		IN UINT8	QuestionFlags,
		IN UINT8	DateFlags,
		IN VOID *DefaultsOpCodeHandle	OPTIONAL
	)

Create EFI_IFR_DATE_OP opcode.

If OpCodeHandle is NULL, then ASSERT(). If any reserved bits are set in QuestionFlags, then ASSERT(). If any reserved bits are set in DateFlags, then ASSERT().

Parameters

[in]	OpCodeHandle	Handle to the buffer of opcodes.
[in]	QuestionId	Question ID
[in]	VarStoreId	Storage ID, optional. If DateFlags is not QF_DATE_STORAGE_NORMAL, this parameter is ignored.
[in]	VarOffset	Offset in Storage or String ID of the name (VarName) for this name/value pair, optional. If DateFlags is not QF_DATE_STORAGE_NORMAL, this parameter is ignored.
[in]	Prompt	String ID for Prompt
[in]	Help	String ID for Help
[in]	QuestionFlags	Flags in Question Header
[in]	DateFlags	Flags for date opcode
[in]	DefaultsOpCodeHandle	Handle for a buffer of DEFAULT opcodes. This is an optional parameter that may be NULL.

Return values

NULL	There is not enough space left in Buffer to add the opcode.
Other	A pointer to the created opcode.

Definition at line 4081 of file HiiLib.c.

◆ HiiCreateDefaultOpCode()

UINT8 *EFIAPI HiiCreateDefaultOpCode	(	IN VOID *	OpCodeHandle,
		IN UINT16	DefaultId,
		IN UINT8	Type,
		IN UINT64	Value
	)

Create EFI_IFR_DEFAULT_OP opcode.

If OpCodeHandle is NULL, then ASSERT(). If Type is invalid, then ASSERT().

Parameters

[in]	OpCodeHandle	Handle to the buffer of opcodes.
[in]	DefaultId	DefaultId for the default
[in]	Type	Type for the default
[in]	Value	Value for the default

Return values

NULL	There is not enough space left in Buffer to add the opcode.
Other	A pointer to the created opcode.

Definition at line 3367 of file HiiLib.c.

◆ HiiCreateEndOpCode()

UINT8 *EFIAPI HiiCreateEndOpCode ( IN VOID * OpCodeHandle )

Create EFI_IFR_END_OP opcode.

If OpCodeHandle is NULL, then ASSERT().

Parameters

[in] OpCodeHandle Handle to the buffer of opcodes.

Return values

NULL	There is not enough space left in Buffer to add the opcode.
Other	A pointer to the created opcode.

Definition at line 3301 of file HiiLib.c.

◆ HiiCreateGotoExOpCode()

UINT8 *EFIAPI HiiCreateGotoExOpCode	(	IN VOID *	OpCodeHandle,
		IN EFI_FORM_ID	RefFormId,
		IN EFI_STRING_ID	Prompt,
		IN EFI_STRING_ID	Help,
		IN UINT8	QuestionFlags,
		IN EFI_QUESTION_ID	QuestionId,
		IN EFI_QUESTION_ID	RefQuestionId,
		IN EFI_GUID *RefFormSetId	OPTIONAL,
		IN EFI_STRING_ID	RefDevicePath
	)

Create EFI_IFR_REF_OP, EFI_IFR_REF2_OP, EFI_IFR_REF3_OP and EFI_IFR_REF4_OP opcode.

When RefDevicePath is not zero, EFI_IFR_REF4 opcode will be created. When RefDevicePath is zero and RefFormSetId is not NULL, EFI_IFR_REF3 opcode will be created. When RefDevicePath is zero, RefFormSetId is NULL and RefQuestionId is not zero, EFI_IFR_REF2 opcode will be created. When RefDevicePath is zero, RefFormSetId is NULL and RefQuestionId is zero, EFI_IFR_REF opcode will be created.

If OpCodeHandle is NULL, then ASSERT(). If any reserved bits are set in QuestionFlags, then ASSERT().

Parameters

[in]	OpCodeHandle	The handle to the buffer of opcodes.
[in]	RefFormId	The Destination Form ID.
[in]	Prompt	The string ID for Prompt.
[in]	Help	The string ID for Help.
[in]	QuestionFlags	The flags in Question Header
[in]	QuestionId	Question ID.
[in]	RefQuestionId	The question on the form to which this link is referring. If its value is zero, then the link refers to the top of the form.
[in]	RefFormSetId	The form set to which this link is referring. If its value is NULL, and RefDevicePath is zero, then the link is to the current form set.
[in]	RefDevicePath	The string identifier that specifies the string containing the text representation of the device path to which the form set containing the form specified by FormId. If its value is zero, then the link refers to the current page.

Return values

NULL	There is not enough space left in Buffer to add the opcode.
Other	A pointer to the created opcode.

Definition at line 3605 of file HiiLib.c.

◆ HiiCreateGotoOpCode()

UINT8 *EFIAPI HiiCreateGotoOpCode	(	IN VOID *	OpCodeHandle,
		IN EFI_FORM_ID	FormId,
		IN EFI_STRING_ID	Prompt,
		IN EFI_STRING_ID	Help,
		IN UINT8	QuestionFlags,
		IN EFI_QUESTION_ID	QuestionId
	)

Create EFI_IFR_REF_OP opcode.

If OpCodeHandle is NULL, then ASSERT(). If any reserved bits are set in QuestionFlags, then ASSERT().

Parameters

[in]	OpCodeHandle	Handle to the buffer of opcodes.
[in]	FormId	Destination Form ID
[in]	Prompt	String ID for Prompt
[in]	Help	String ID for Help
[in]	QuestionFlags	Flags in Question Header
[in]	QuestionId	Question ID

Return values

NULL	There is not enough space left in Buffer to add the opcode.
Other	A pointer to the created opcode.

Definition at line 3551 of file HiiLib.c.

◆ HiiCreateGuidOpCode()

UINT8 *EFIAPI HiiCreateGuidOpCode	(	IN VOID *	OpCodeHandle,
		IN CONST EFI_GUID *	Guid,
		IN CONST VOID *GuidOpCode	OPTIONAL,
		IN UINTN	OpCodeSize
	)

Create EFI_IFR_GUID opcode.

If OpCodeHandle is NULL, then ASSERT(). If Guid is NULL, then ASSERT(). If OpCodeSize < sizeof (EFI_IFR_GUID), then ASSERT().

Parameters

[in]	OpCodeHandle	Handle to the buffer of opcodes.
[in]	Guid	Pointer to EFI_GUID of this guided opcode.
[in]	GuidOpCode	Pointer to an EFI_IFR_GUID opcode. This is an optional parameter that may be NULL. If this parameter is NULL, then the GUID extension region of the created opcode is filled with zeros. If this parameter is not NULL, then the GUID extension region of GuidData will be copied to the GUID extension region of the created opcode.
[in]	OpCodeSize	The size, in bytes, of created opcode. This value must be >= sizeof(EFI_IFR_GUID).

Return values

NULL	There is not enough space left in Buffer to add the opcode.
Other	A pointer to the created opcode.

Definition at line 3411 of file HiiLib.c.

◆ HiiCreateNumericOpCode()

UINT8 *EFIAPI HiiCreateNumericOpCode	(	IN VOID *	OpCodeHandle,
		IN EFI_QUESTION_ID	QuestionId,
		IN EFI_VARSTORE_ID	VarStoreId,
		IN UINT16	VarOffset,
		IN EFI_STRING_ID	Prompt,
		IN EFI_STRING_ID	Help,
		IN UINT8	QuestionFlags,
		IN UINT8	NumericFlags,
		IN UINT64	Minimum,
		IN UINT64	Maximum,
		IN UINT64	Step,
		IN VOID *DefaultsOpCodeHandle	OPTIONAL
	)

Create EFI_IFR_NUMERIC_OP opcode.

If OpCodeHandle is NULL, then ASSERT(). If any reserved bits are set in QuestionFlags, then ASSERT(). If any reserved bits are set in NumericFlags, then ASSERT().

Parameters

[in]	OpCodeHandle	Handle to the buffer of opcodes.
[in]	QuestionId	Question ID
[in]	VarStoreId	Storage ID
[in]	VarOffset	Offset in Storage or String ID of the name (VarName) for this name/value pair.
[in]	Prompt	String ID for Prompt
[in]	Help	String ID for Help
[in]	QuestionFlags	Flags in Question Header
[in]	NumericFlags	Flags for numeric opcode
[in]	Minimum	Numeric minimum value
[in]	Maximum	Numeric maximum value
[in]	Step	Numeric step for edit
[in]	DefaultsOpCodeHandle	Handle for a buffer of DEFAULT opcodes. This is an optional parameter that may be NULL.

Return values

NULL	There is not enough space left in Buffer to add the opcode.
Other	A pointer to the created opcode.

Definition at line 3740 of file HiiLib.c.

◆ HiiCreateOneOfOpCode()

UINT8 *EFIAPI HiiCreateOneOfOpCode	(	IN VOID *	OpCodeHandle,
		IN EFI_QUESTION_ID	QuestionId,
		IN EFI_VARSTORE_ID	VarStoreId,
		IN UINT16	VarOffset,
		IN EFI_STRING_ID	Prompt,
		IN EFI_STRING_ID	Help,
		IN UINT8	QuestionFlags,
		IN UINT8	OneOfFlags,
		IN VOID *	OptionsOpCodeHandle,
		IN VOID *DefaultsOpCodeHandle	OPTIONAL
	)

Create EFI_IFR_ONE_OF_OP opcode.

If OpCodeHandle is NULL, then ASSERT(). If any reserved bits are set in QuestionFlags, then ASSERT(). If any reserved bits are set in OneOfFlags, then ASSERT().

Parameters

[in]	OpCodeHandle	Handle to the buffer of opcodes.
[in]	QuestionId	Question ID
[in]	VarStoreId	Storage ID
[in]	VarOffset	Offset in Storage or String ID of the name (VarName) for this name/value pair.
[in]	Prompt	String ID for Prompt
[in]	Help	String ID for Help
[in]	QuestionFlags	Flags in Question Header
[in]	OneOfFlags	Flags for oneof opcode
[in]	OptionsOpCodeHandle	Handle for a buffer of ONE_OF_OPTION opcodes.
[in]	DefaultsOpCodeHandle	Handle for a buffer of DEFAULT opcodes. This is an optional parameter that may be NULL.

Return values

NULL	There is not enough space left in Buffer to add the opcode.
Other	A pointer to the created opcode.

Definition at line 3908 of file HiiLib.c.

◆ HiiCreateOneOfOptionOpCode()

UINT8 *EFIAPI HiiCreateOneOfOptionOpCode	(	IN VOID *	OpCodeHandle,
		IN UINT16	StringId,
		IN UINT8	Flags,
		IN UINT8	Type,
		IN UINT64	Value
	)

Create EFI_IFR_ONE_OF_OPTION_OP opcode.

If OpCodeHandle is NULL, then ASSERT(). If Type is invalid, then ASSERT(). If Flags is invalid, then ASSERT().

Parameters

[in]	OpCodeHandle	Handle to the buffer of opcodes.
[in]	StringId	StringId for the option
[in]	Flags	Flags for the option
[in]	Type	Type for the option
[in]	Value	Value for the option

Return values

NULL	There is not enough space left in Buffer to add the opcode.
Other	A pointer to the created opcode.

Definition at line 3329 of file HiiLib.c.

◆ HiiCreateOrderedListOpCode()

UINT8 *EFIAPI HiiCreateOrderedListOpCode	(	IN VOID *	OpCodeHandle,
		IN EFI_QUESTION_ID	QuestionId,
		IN EFI_VARSTORE_ID	VarStoreId,
		IN UINT16	VarOffset,
		IN EFI_STRING_ID	Prompt,
		IN EFI_STRING_ID	Help,
		IN UINT8	QuestionFlags,
		IN UINT8	OrderedListFlags,
		IN UINT8	DataType,
		IN UINT8	MaxContainers,
		IN VOID *	OptionsOpCodeHandle,
		IN VOID *DefaultsOpCodeHandle	OPTIONAL
	)

Create EFI_IFR_ORDERED_LIST_OP opcode.

If OpCodeHandle is NULL, then ASSERT(). If any reserved bits are set in QuestionFlags, then ASSERT(). If any reserved bits are set in OrderedListFlags, then ASSERT().

Parameters

[in]	OpCodeHandle	Handle to the buffer of opcodes.
[in]	QuestionId	Question ID
[in]	VarStoreId	Storage ID
[in]	VarOffset	Offset in Storage or String ID of the name (VarName) for this name/value pair.
[in]	Prompt	String ID for Prompt
[in]	Help	String ID for Help
[in]	QuestionFlags	Flags in Question Header
[in]	OrderedListFlags	Flags for ordered list opcode
[in]	DataType	Type for option value
[in]	MaxContainers	Maximum count for options in this ordered list
[in]	OptionsOpCodeHandle	Handle for a buffer of ONE_OF_OPTION opcodes.
[in]	DefaultsOpCodeHandle	Handle for a buffer of DEFAULT opcodes. This is an optional parameter that may be NULL.

Return values

NULL	There is not enough space left in Buffer to add the opcode.
Other	A pointer to the created opcode.

Definition at line 3979 of file HiiLib.c.

◆ HiiCreateRawOpCodes()

UINT8 *EFIAPI HiiCreateRawOpCodes	(	IN VOID *	OpCodeHandle,
		IN UINT8 *	RawBuffer,
		IN UINTN	RawBufferSize
	)

Append raw opcodes to an OpCodeHandle.

If OpCodeHandle is NULL, then ASSERT(). If RawBuffer is NULL, then ASSERT();

Parameters

[in]	OpCodeHandle	Handle to the buffer of opcodes.
[in]	RawBuffer	Buffer of opcodes to append.
[in]	RawBufferSize	The size, in bytes, of Buffer.

Return values

NULL	There is not enough space left in Buffer to add the opcode.
Other	A pointer to the appended opcodes.

Definition at line 3246 of file HiiLib.c.

◆ HiiCreateStringOpCode()

UINT8 *EFIAPI HiiCreateStringOpCode	(	IN VOID *	OpCodeHandle,
		IN EFI_QUESTION_ID	QuestionId,
		IN EFI_VARSTORE_ID	VarStoreId,
		IN UINT16	VarOffset,
		IN EFI_STRING_ID	Prompt,
		IN EFI_STRING_ID	Help,
		IN UINT8	QuestionFlags,
		IN UINT8	StringFlags,
		IN UINT8	MinSize,
		IN UINT8	MaxSize,
		IN VOID *DefaultsOpCodeHandle	OPTIONAL
	)

Create EFI_IFR_STRING_OP opcode.

If OpCodeHandle is NULL, then ASSERT(). If any reserved bits are set in QuestionFlags, then ASSERT(). If any reserved bits are set in StringFlags, then ASSERT().

Parameters

[in]	OpCodeHandle	Handle to the buffer of opcodes.
[in]	QuestionId	Question ID
[in]	VarStoreId	Storage ID
[in]	VarOffset	Offset in Storage or String ID of the name (VarName) for this name/value pair.
[in]	Prompt	String ID for Prompt
[in]	Help	String ID for Help
[in]	QuestionFlags	Flags in Question Header
[in]	StringFlags	Flags for string opcode
[in]	MinSize	String minimum length
[in]	MaxSize	String maximum length
[in]	DefaultsOpCodeHandle	Handle for a buffer of DEFAULT opcodes. This is an optional parameter that may be NULL.

Return values

NULL	There is not enough space left in Buffer to add the opcode.
Other	A pointer to the created opcode.

Definition at line 3841 of file HiiLib.c.

◆ HiiCreateSubTitleOpCode()

UINT8 *EFIAPI HiiCreateSubTitleOpCode	(	IN VOID *	OpCodeHandle,
		IN EFI_STRING_ID	Prompt,
		IN EFI_STRING_ID	Help,
		IN UINT8	Flags,
		IN UINT8	Scope
	)

Create EFI_IFR_SUBTITLE_OP opcode.

If OpCodeHandle is NULL, then ASSERT(). If any reserved bits are set in Flags, then ASSERT(). If Scope > 1, then ASSERT().

Parameters

[in]	OpCodeHandle	Handle to the buffer of opcodes.
[in]	Prompt	String ID for Prompt
[in]	Help	String ID for Help
[in]	Flags	Subtitle opcode flags
[in]	Scope	1 if this opcpde is the beginning of a new scope. 0 if this opcode is within the current scope.

Return values

NULL	There is not enough space left in Buffer to add the opcode.
Other	A pointer to the created opcode.

Definition at line 3504 of file HiiLib.c.

◆ HiiCreateTextOpCode()

UINT8 *EFIAPI HiiCreateTextOpCode	(	IN VOID *	OpCodeHandle,
		IN EFI_STRING_ID	Prompt,
		IN EFI_STRING_ID	Help,
		IN EFI_STRING_ID	TextTwo
	)

Create EFI_IFR_TEXT_OP opcode.

If OpCodeHandle is NULL, then ASSERT().

Parameters

[in]	OpCodeHandle	Handle to the buffer of opcodes.
[in]	Prompt	String ID for Prompt.
[in]	Help	String ID for Help.
[in]	TextTwo	String ID for TextTwo.

Return values

NULL	There is not enough space left in Buffer to add the opcode.
Other	A pointer to the created opcode.

Definition at line 4037 of file HiiLib.c.

◆ HiiCreateTimeOpCode()

UINT8 *EFIAPI HiiCreateTimeOpCode	(	IN VOID *	OpCodeHandle,
		IN EFI_QUESTION_ID	QuestionId,
		IN EFI_VARSTORE_ID VarStoreId	OPTIONAL,
		IN UINT16 VarOffset	OPTIONAL,
		IN EFI_STRING_ID	Prompt,
		IN EFI_STRING_ID	Help,
		IN UINT8	QuestionFlags,
		IN UINT8	TimeFlags,
		IN VOID *DefaultsOpCodeHandle	OPTIONAL
	)

Create EFI_IFR_TIME_OP opcode.

If OpCodeHandle is NULL, then ASSERT(). If any reserved bits are set in QuestionFlags, then ASSERT(). If any reserved bits are set in TimeFlags, then ASSERT().

Parameters

[in]	OpCodeHandle	Handle to the buffer of opcodes.
[in]	QuestionId	Question ID
[in]	VarStoreId	Storage ID, optional. If TimeFlags is not QF_TIME_STORAGE_NORMAL, this parameter is ignored.
[in]	VarOffset	Offset in Storage or String ID of the name (VarName) for this name/value pair, optional. If TimeFlags is not QF_TIME_STORAGE_NORMAL, this parameter is ignored.
[in]	Prompt	String ID for Prompt
[in]	Help	String ID for Help
[in]	QuestionFlags	Flags in Question Header
[in]	TimeFlags	Flags for time opcode
[in]	DefaultsOpCodeHandle	Handle for a buffer of DEFAULT opcodes. This is an optional parameter that may be NULL.

Return values

NULL	There is not enough space left in Buffer to add the opcode.
Other	A pointer to the created opcode.

Definition at line 4146 of file HiiLib.c.

◆ HiiFreeOpCodeHandle()

VOID EFIAPI HiiFreeOpCodeHandle ( VOID * OpCodeHandle )

Frees an OpCode Handle that was previously allocated with HiiAllocateOpCodeHandle(). When an OpCode Handle is freed, all of the opcodes associated with the OpCode Handle are also freed.

If OpCodeHandle is NULL, then ASSERT().

Parameters

[in] OpCodeHandle Handle to the buffer of opcodes.

Definition at line 3085 of file HiiLib.c.

◆ HiiGetBrowserData()

BOOLEAN EFIAPI HiiGetBrowserData	(	IN CONST EFI_GUID *VariableGuid	OPTIONAL,
		IN CONST CHAR16 *VariableName	OPTIONAL,
		IN UINTN	BufferSize,
		OUT UINT8 *	Buffer
	)

Retrieves uncommitted data from the Form Browser and converts it to a binary buffer.

Parameters

[in]	VariableGuid	Pointer to an EFI_GUID structure. This is an optional parameter that may be NULL.
[in]	VariableName	Pointer to a Null-terminated Unicode string. This is an optional parameter that may be NULL.
[in]	BufferSize	Length in bytes of buffer to hold retrieved data.
[out]	Buffer	Buffer of data to be updated.

Return values

FALSE	The uncommitted data could not be retrieved.
TRUE	The uncommitted data was retrieved.

Definition at line 2872 of file HiiLib.c.

◆ HiiGetFormSetFromHiiHandle()

EFI_STATUS EFIAPI HiiGetFormSetFromHiiHandle	(	IN EFI_HII_HANDLE	Handle,
		OUT EFI_IFR_FORM_SET **	Buffer,
		OUT UINTN *	BufferSize
	)

This function allows a caller to extract the form set opcode form the Hii Handle. The returned buffer is allocated using AllocatePool().The caller is responsible for freeing the allocated buffer using FreePool().

Parameters

Handle	The HII handle.
Buffer	On return, points to a pointer which point to the buffer that contain the formset opcode.
BufferSize	On return, points to the length of the buffer.

Return values

EFI_OUT_OF_RESOURCES	No enough memory resource is allocated.
EFI_NOT_FOUND	Can't find the package data for the input Handle.
EFI_INVALID_PARAMETER	The input parameters are not correct.
EFI_SUCCESS	Get the formset opcode from the hii handle successfully.

Definition at line 394 of file HiiLib.c.

◆ HiiGetHiiHandles()

EFI_HII_HANDLE *EFIAPI HiiGetHiiHandles ( IN CONST EFI_GUID *PackageListGuid OPTIONAL )

Retrieves the array of all the HII Handles or the HII handles of a specific package list GUID in the HII Database. This array is terminated with a NULL HII Handle. This function allocates the returned array using AllocatePool(). The caller is responsible for freeing the array with FreePool().

Parameters

[in] PackageListGuid An optional parameter that is used to request HII Handles associated with a specific Package List GUID. If this parameter is NULL, then all the HII Handles in the HII Database are returned. If this parameter is not NULL, then zero or more HII Handles associated with PackageListGuid are returned.

Return values

NULL	No HII handles were found in the HII database
NULL	The array of HII Handles could not be retrieved
Other	A pointer to the NULL terminated array of HII Handles

Definition at line 286 of file HiiLib.c.

◆ HiiIsConfigHdrMatch()

BOOLEAN EFIAPI HiiIsConfigHdrMatch	(	IN CONST EFI_STRING	ConfigHdr,
		IN CONST EFI_GUID *Guid	OPTIONAL,
		IN CONST CHAR16 *Name	OPTIONAL
	)

Determines if the routing data specified by GUID and NAME match a <ConfigHdr>.

If ConfigHdr is NULL, then ASSERT().

Parameters

[in]	ConfigHdr	Either <ConfigRequest> or <ConfigResp>.
[in]	Guid	GUID of the storage.
[in]	Name	NAME of the storage.

Return values

TRUE	Routing information matches <ConfigHdr>.
FALSE	Routing information does not match <ConfigHdr>.

Definition at line 2813 of file HiiLib.c.

◆ HiiRemovePackages()

VOID EFIAPI HiiRemovePackages ( IN EFI_HII_HANDLE HiiHandle )

Removes a package list from the HII database.

If HiiHandle is NULL, then ASSERT. If HiiHandle is not a valid EFI_HII_HANDLE in the HII database, then ASSERT.

Parameters

[in] HiiHandle The handle that was previously registered in the HII database

Definition at line 253 of file HiiLib.c.

◆ HiiSetBrowserData()

BOOLEAN EFIAPI HiiSetBrowserData	(	IN CONST EFI_GUID *VariableGuid	OPTIONAL,
		IN CONST CHAR16 *VariableName	OPTIONAL,
		IN UINTN	BufferSize,
		IN CONST UINT8 *	Buffer,
		IN CONST CHAR16 *RequestElement	OPTIONAL
	)

Updates uncommitted data in the Form Browser.

If Buffer is NULL, then ASSERT().

Parameters

[in]	VariableGuid	Pointer to an EFI_GUID structure. This is an optional parameter that may be NULL.
[in]	VariableName	Pointer to a Null-terminated Unicode string. This is an optional parameter that may be NULL.
[in]	BufferSize	Length, in bytes, of Buffer.
[in]	Buffer	Buffer of data to commit.
[in]	RequestElement	An optional field to specify which part of the buffer data will be send back to Browser. If NULL, the whole buffer of data will be committed to Browser. <RequestElement> ::= &OFFSET=<Number>&WIDTH=<Number>*

Return values

FALSE	The uncommitted data could not be updated.
TRUE	The uncommitted data was updated.

Definition at line 2954 of file HiiLib.c.

◆ HiiSetToDefaults()

BOOLEAN EFIAPI HiiSetToDefaults	(	IN CONST EFI_STRING Request	OPTIONAL,
		IN UINT16	DefaultId
	)

Reset the default value specified by DefaultId to the driver configuration got by Request string.

NULL request string support depends on the ExportConfig interface of HiiConfigRouting protocol in UEFI specification.

Parameters

Request	A null-terminated Unicode string in <MultiConfigRequest> format. It can be NULL. If it is NULL, all configuration for the entirety of the current HII database will be reset.
DefaultId	Specifies the type of defaults to retrieve.

Return values

TRUE	The default value is set successfully.
FALSE	The default value can't be found and set.

Definition at line 2714 of file HiiLib.c.

◆ HiiUpdateForm()

EFI_STATUS EFIAPI HiiUpdateForm	(	IN EFI_HII_HANDLE	HiiHandle,
		IN EFI_GUID *FormSetGuid	OPTIONAL,
		IN EFI_FORM_ID	FormId,
		IN VOID *	StartOpCodeHandle,
		IN VOID *EndOpCodeHandle	OPTIONAL
	)

This function updates a form that has previously been registered with the HII Database. This function will perform at most one update operation.

The form to update is specified by Handle, FormSetGuid, and FormId. Binary comparisons of IFR opcodes are performed from the beginning of the form being updated until an IFR opcode is found that exactly matches the first IFR opcode specified by StartOpCodeHandle. The following rules are used to determine if an insert, replace, or delete operation is performed.

1) If no matches are found, then NULL is returned. 2) If a match is found, and EndOpCodeHandle is NULL, then all of the IFR opcodes from StartOpCodeHandle except the first opcode are inserted immediately after the matching IFR opcode in the form to be updated. 3) If a match is found, and EndOpCodeHandle is not NULL, then a search is made from the matching IFR opcode until an IFR opcode exactly matches the first IFR opcode specified by EndOpCodeHandle. If no match is found for the first IFR opcode specified by EndOpCodeHandle, then NULL is returned. If a match is found, then all of the IFR opcodes between the start match and the end match are deleted from the form being updated and all of the IFR opcodes from StartOpCodeHandle except the first opcode are inserted immediately after the matching start IFR opcode. If StartOpCcodeHandle only contains one IFR instruction, then the result of this operation will delete all of the IFR opcodes between the start end matches.

If HiiHandle is NULL, then ASSERT(). If StartOpCodeHandle is NULL, then ASSERT().

Parameters

[in]	HiiHandle	The HII Handle of the form to update.
[in]	FormSetGuid	The Formset GUID of the form to update. This is an optional parameter that may be NULL. If it is NULL, all FormSet will be updated.
[in]	FormId	The ID of the form to update.
[in]	StartOpCodeHandle	An OpCode Handle that contains the set of IFR opcodes to be inserted or replaced in the form. The first IFR instruction in StartOpCodeHandle is used to find matching IFR opcode in the form.
[in]	EndOpCodeHandle	An OpCcode Handle that contains the IFR opcode that marks the end of a replace operation in the form. This is an optional parameter that may be NULL. If it is NULL, then an the IFR opcodes specified by StartOpCodeHandle are inserted into the form.

Return values

EFI_OUT_OF_RESOURCES	No enough memory resource is allocated.
EFI_NOT_FOUND	The following cases will return EFI_NOT_FOUND. 1) The form specified by HiiHandle, FormSetGuid, and FormId could not be found in the HII Database. 2) No IFR opcodes in the target form match the first IFR opcode in StartOpCodeHandle. 3) EndOpCOde is not NULL, and no IFR opcodes in the target form following a matching start opcode match the first IFR opcode in EndOpCodeHandle.
EFI_SUCCESS	The matched form is updated by StartOpcode.

Definition at line 4410 of file HiiLib.c.

◆ HiiValidateSettings()

BOOLEAN EFIAPI HiiValidateSettings ( IN CONST EFI_STRING Request OPTIONAL )

Validate the current configuration by parsing HII form IFR opcode.

NULL request string support depends on the ExportConfig interface of HiiConfigRouting protocol in UEFI specification.

Parameters

Request A null-terminated Unicode string in <MultiConfigRequest> format. It can be NULL. If it is NULL, all current configuration for the entirety of the current HII database will be validated.

Return values

TRUE	Current configuration is valid.
FALSE	Current configuration is invalid.

Definition at line 2689 of file HiiLib.c.

◆ InternalHiiAppendOpCodes()

UINT8 *EFIAPI InternalHiiAppendOpCodes	(	IN VOID *	OpCodeHandle,
		IN VOID *	RawOpCodeHandle
	)

Append opcodes from one OpCode Handle to another OpCode handle.

If OpCodeHandle is NULL, then ASSERT(). If RawOpCodeHandle is NULL, then ASSERT();

Parameters

[in]	OpCodeHandle	Handle to the buffer of opcodes.
[in]	RawOpCodeHandle	Handle to the buffer of opcodes.

Return values

NULL	There is not enough space left in Buffer to add the opcode.
Other	A pointer to the appended opcodes.

Definition at line 3275 of file HiiLib.c.

◆ InternalHiiBlockToConfig()

EFI_STRING EFIAPI InternalHiiBlockToConfig	(	IN CONST EFI_STRING	ConfigRequest,
		IN CONST UINT8 *	Block,
		IN UINTN	BlockSize
	)

Uses the BlockToConfig() service of the Config Routing Protocol to convert <ConfigRequest> and a buffer to a <ConfigResp>

If ConfigRequest is NULL, then ASSERT(). If Block is NULL, then ASSERT().

Parameters

[in]	ConfigRequest	Pointer to a Null-terminated Unicode string.
[in]	Block	Pointer to a block of data.
[in]	BlockSize	The zie, in bytes, of Block.

Return values

NULL	The <ConfigResp> string could not be generated.
Other	Pointer to the Null-terminated Unicode <ConfigResp> string.

Definition at line 561 of file HiiLib.c.

◆ InternalHiiBrowserCallback()

EFI_STRING EFIAPI InternalHiiBrowserCallback	(	IN CONST EFI_GUID *VariableGuid	OPTIONAL,
		IN CONST CHAR16 *VariableName	OPTIONAL,
		IN CONST EFI_STRING SetResultsData	OPTIONAL
	)

Uses the BrowserCallback() service of the Form Browser Protocol to retrieve or set uncommitted data. If sata i being retrieved, then the buffer is allocated using AllocatePool(). The caller is then responsible for freeing the buffer using FreePool().

Parameters

[in]	VariableGuid	Pointer to an EFI_GUID structure. This is an optional parameter that may be NULL.
[in]	VariableName	Pointer to a Null-terminated Unicode string. This is an optional parameter that may be NULL.
[in]	SetResultsData	If not NULL, then this parameter specified the buffer of uncommited data to set. If this parameter is NULL, then the caller is requesting to get the uncommited data from the Form Browser.

Return values

NULL	The uncommitted data could not be retrieved.
Other	A pointer to a buffer containing the uncommitted data.

Definition at line 613 of file HiiLib.c.

◆ InternalHiiCompareSubString()

BOOLEAN EFIAPI InternalHiiCompareSubString	(	IN CHAR16 *	FirstString,
		IN CHAR16 *	SecondString,
		IN CHAR16 *	StartSearchString,
		IN CHAR16 *	StopSearchString
	)

Determines if two values in config strings match.

Compares the substring between StartSearchString and StopSearchString in FirstString to the substring between StartSearchString and StopSearchString in SecondString. If the two substrings match, then TRUE is returned. If the two substrings do not match, then FALSE is returned.

If FirstString is NULL, then ASSERT(). If SecondString is NULL, then ASSERT(). If StartSearchString is NULL, then ASSERT(). If StopSearchString is NULL, then ASSERT().

Parameters

FirstString	Pointer to the first Null-terminated Unicode string.
SecondString	Pointer to the second Null-terminated Unicode string.
StartSearchString	Pointer to the Null-terminated Unicode string that marks the start of the value string to compare.
StopSearchString	Pointer to the Null-terminated Unicode string that marks the end of the value string to compare.

Return values

FALSE	StartSearchString is not present in FirstString.
FALSE	StartSearchString is not present in SecondString.
FALSE	StopSearchString is not present in FirstString.
FALSE	StopSearchString is not present in SecondString.
FALSE	The length of the substring in FirstString is not the same length as the substring in SecondString.
FALSE	The value string in FirstString does not matche the value string in SecondString.
TRUE	The value string in FirstString matches the value string in SecondString.

Definition at line 2756 of file HiiLib.c.

◆ InternalHiiCreateOpCode()

UINT8 *EFIAPI InternalHiiCreateOpCode	(	IN VOID *	OpCodeHandle,
		IN VOID *	OpCodeTemplate,
		IN UINT8	OpCode,
		IN UINTN	OpCodeSize
	)

Internal function creates opcode based on the template opcode for the normal opcode.

Parameters

[in]	OpCodeHandle	Handle to the buffer of opcodes.
[in]	OpCodeTemplate	Pointer to the template buffer of opcode.
[in]	OpCode	OpCode IFR value.
[in]	OpCodeSize	Size of opcode.

Returns: Pointer to the current opcode with opcode data.

Definition at line 3220 of file HiiLib.c.

◆ InternalHiiCreateOpCodeExtended()

UINT8 *EFIAPI InternalHiiCreateOpCodeExtended	(	IN VOID *	OpCodeHandle,
		IN VOID *	OpCodeTemplate,
		IN UINT8	OpCode,
		IN UINTN	OpCodeSize,
		IN UINTN	ExtensionSize,
		IN UINT8	Scope
	)

Internal function creates opcode based on the template opcode.

Parameters

[in]	OpCodeHandle	Handle to the buffer of opcodes.
[in]	OpCodeTemplate	Pointer to the template buffer of opcode.
[in]	OpCode	OpCode IFR value.
[in]	OpCodeSize	Size of opcode.
[in]	ExtensionSize	Size of extended opcode.
[in]	Scope	Scope bit of opcode.

Returns: Pointer to the current opcode with opcode data.

Definition at line 3185 of file HiiLib.c.

◆ InternalHiiExtractGuidFromHiiHandle()

EFI_STATUS EFIAPI InternalHiiExtractGuidFromHiiHandle	(	IN EFI_HII_HANDLE	Handle,
		OUT EFI_GUID *	Guid
	)

Extract Hii package list GUID for given HII handle.

If HiiHandle could not be found in the HII database, then ASSERT. If Guid is NULL, then ASSERT.

Parameters

Handle	Hii handle
Guid	Package list GUID

Return values

EFI_SUCCESS Successfully extract GUID from Hii database.

Definition at line 62 of file HiiLib.c.

◆ InternalHiiGetBufferFromString()

EFI_STATUS InternalHiiGetBufferFromString	(	IN EFI_STRING	String,
		IN UINT8	Flag,
		OUT UINT8 **	Buffer
	)

Convert the hex UNICODE encoding string of UEFI GUID, NAME or device path to binary buffer from <ConfigHdr>.

This is a internal function.

Parameters

String	UEFI configuration string.
Flag	Flag specifies what type buffer will be retrieved.
Buffer	Binary of Guid, Name or Device path.

Return values

EFI_INVALID_PARAMETER	Any incoming parameter is invalid.
EFI_OUT_OF_RESOURCES	Lake of resources to store neccesary structures.
EFI_SUCCESS	The buffer data is retrieved and translated to binary format.

Definition at line 867 of file HiiLib.c.

◆ InternalHiiGetValueOfNumber()

EFI_STATUS EFIAPI InternalHiiGetValueOfNumber	(	IN EFI_STRING	ValueString,
		OUT UINT8 **	ValueData,
		OUT UINTN *	ValueLength
	)

Get the value of <Number> in <BlockConfig> format, i.e. the value of OFFSET or WIDTH or VALUE. <BlockConfig> ::= 'OFFSET='<Number>&'WIDTH='<Number>&'VALUE'=<Number>

Parameters

ValueString	String in <BlockConfig> format and points to the first character of <Number>.
ValueData	The output value. Caller takes the responsibility to free memory.
ValueLength	Length of the <Number>, in characters.

Return values

EFI_OUT_OF_RESOURCES	Insufficient resources to store neccessary structures.
EFI_SUCCESS	Value of <Number> is outputted in Number successfully.

Definition at line 1022 of file HiiLib.c.

◆ InternalHiiGrowOpCodeHandle()

UINT8 *EFIAPI InternalHiiGrowOpCodeHandle	(	IN VOID *	OpCodeHandle,
		IN UINTN	Size
	)

Internal function reserves the enough buffer for current opcode. When the buffer is not enough, Opcode buffer will be extended.

Parameters

[in]	OpCodeHandle	Handle to the buffer of opcodes.
[in]	Size	Size of current opcode.

Returns: Pointer to the current opcode.

Definition at line 3144 of file HiiLib.c.

◆ InternalHiiIfrValueAction()

BOOLEAN EFIAPI InternalHiiIfrValueAction	(	IN CONST EFI_STRING Request	OPTIONAL,
		IN UINT16	DefaultId,
		IN UINT8	ActionType
	)

This function parses the input ConfigRequest string and its matched IFR code string for setting default value and validating current setting.

For setting default action, Reset the default value specified by DefaultId to the driver configuration got by Request string.
For validating current setting, Validate the current configuration by parsing HII form IFR opcode.

NULL request string support depends on the ExportConfig interface of HiiConfigRouting protocol in UEFI specification.

Parameters

Request	A null-terminated Unicode string in <MultiConfigRequest> format. It can be NULL. If it is NULL, all current configuration for the entirety of the current HII database will be validated. If it is NULL, all configuration for the entirety of the current HII database will be reset.
DefaultId	Specifies the type of defaults to retrieve only for setting default action.
ActionType	Action supports setting defaults and validate current setting.

Return values

TRUE	Action runs successfully.
FALSE	Action is not valid or Action can't be executed successfully..

Definition at line 2311 of file HiiLib.c.

◆ InternalHiiLowerConfigString()

EFI_STRING EFIAPI InternalHiiLowerConfigString ( IN EFI_STRING ConfigString )

Converts all hex dtring characters in range ['A'..'F'] to ['a'..'f'] for hex digits that appear between a '=' and a '&' in a config string.

If ConfigString is NULL, then ASSERT().

Parameters

[in] ConfigString Pointer to a Null-terminated Unicode string.

Returns: Pointer to the Null-terminated Unicode result string.

Definition at line 519 of file HiiLib.c.

◆ InternalHiiOpCodeHandleBuffer()

UINT8 *EFIAPI InternalHiiOpCodeHandleBuffer ( IN VOID * OpCodeHandle )

Internal function gets the start pointer of opcode buffer.

Parameters

[in] OpCodeHandle Handle to the buffer of opcodes.

Returns: Pointer to the opcode buffer base.

Definition at line 3126 of file HiiLib.c.

◆ InternalHiiOpCodeHandlePosition()

UINTN EFIAPI InternalHiiOpCodeHandlePosition ( IN VOID * OpCodeHandle )

Internal function gets the current position of opcode buffer.

Parameters

[in] OpCodeHandle Handle to the buffer of opcodes.

Returns: Current position of opcode buffer.

Definition at line 3110 of file HiiLib.c.

◆ InternalHiiUpdateFormPackageData()

EFI_STATUS EFIAPI InternalHiiUpdateFormPackageData	(	IN EFI_GUID *FormSetGuid	OPTIONAL,
		IN EFI_FORM_ID	FormId,
		IN EFI_HII_PACKAGE_HEADER *	Package,
		IN HII_LIB_OPCODE_BUFFER *	OpCodeBufferStart,
		IN HII_LIB_OPCODE_BUFFER *OpCodeBufferEnd	OPTIONAL,
		OUT EFI_HII_PACKAGE_HEADER *	TempPackage
	)

This is the internal worker function to update the data in a form specified by FormSetGuid, FormId and Label.

Parameters

[in]	FormSetGuid	The optional Formset GUID.
[in]	FormId	The Form ID.
[in]	Package	The package header.
[in]	OpCodeBufferStart	An OpCode buffer that contains the set of IFR opcodes to be inserted or replaced in the form.
[in]	OpCodeBufferEnd	An OpCcode buffer that contains the IFR opcode that marks the end of a replace operation in the form.
[out]	TempPackage	The resultant package.

Return values

EFI_SUCCESS	The function completes successfully.
EFI_NOT_FOUND	The updated opcode or endopcode is not found.

Definition at line 4203 of file HiiLib.c.

◆ InternalHiiValidateCurrentSetting()

EFI_STATUS EFIAPI InternalHiiValidateCurrentSetting	(	IN EFI_STRING	ConfigResp,
		IN EFI_HII_PACKAGE_LIST_HEADER *	HiiPackageList,
		IN UINTN	PackageListLength,
		IN EFI_GUID *	VarGuid,
		IN CHAR16 *	VarName,
		IN EFI_HII_HANDLE	HiiHandle
	)

This internal function parses IFR data to validate current setting.

Parameters

ConfigResp	ConfigResp string contains the current setting.
HiiPackageList	Point to Hii package list.
PackageListLength	The length of the pacakge.
VarGuid	Guid of the buffer storage.
VarName	Name of the buffer storage.
HiiHandle	The HiiHandle for this package.

Return values

EFI_SUCCESS	The current setting is valid.
EFI_OUT_OF_RESOURCES	The memory is not enough.
EFI_INVALID_PARAMETER	The config string or the Hii package is invalid.

Definition at line 2177 of file HiiLib.c.

◆ ValidateQuestionFromVfr()

EFI_STATUS ValidateQuestionFromVfr	(	IN EFI_HII_PACKAGE_LIST_HEADER *	HiiPackageList,
		IN UINTN	PackageListLength,
		IN EFI_GUID *	VarGuid,
		IN CHAR16 *	VarName,
		IN UINT8 *	VarBuffer,
		IN IFR_BLOCK_DATA *	CurrentBlockArray,
		IN CHAR16 *	RequestElement,
		IN EFI_HII_HANDLE	HiiHandle,
		IN BOOLEAN	NameValueType
	)

This internal function parses IFR data to validate current setting.

Base on the NameValueType, if it is TRUE, RequestElement and HiiHandle is valid; else the VarBuffer and CurrentBlockArray is valid.

Parameters

HiiPackageList	Point to Hii package list.
PackageListLength	The length of the pacakge.
VarGuid	Guid of the buffer storage.
VarName	Name of the buffer storage.
VarBuffer	The data buffer for the storage.
CurrentBlockArray	The block array from the config Requst string.
RequestElement	The config string for this storage.
HiiHandle	The HiiHandle for this formset.
NameValueType	Whether current storage is name/value varstore or not.

Return values

EFI_SUCCESS	The current setting is valid.
EFI_OUT_OF_RESOURCES	The memory is not enough.
EFI_INVALID_PARAMETER	The config string or the Hii package is invalid.

Definition at line 1148 of file HiiLib.c.

Variable Documentation

◆ mConfigHdrTemplate

GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR16 mConfigHdrTemplate[] = L"GUID=00000000000000000000000000000000&NAME=0000&PATH=00"

Definition at line 36 of file HiiLib.c.

◆ mEndOfPakageList

GLOBAL_REMOVE_IF_UNREFERENCED CONST EFI_HII_PACKAGE_HEADER mEndOfPakageList

Initial value:

= {
  sizeof (EFI_HII_PACKAGE_HEADER),
  EFI_HII_PACKAGE_END
}

Definition at line 43 of file HiiLib.c.

◆ mHiiDefaultTypeToWidth

GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT8 mHiiDefaultTypeToWidth[]

Initial value:

Lookup table that converts EFI_IFR_TYPE_X enum values to a width in bytes

Definition at line 3030 of file HiiLib.c.

◆ mUefiFormBrowser2

EFI_FORM_BROWSER2_PROTOCOL* mUefiFormBrowser2 = NULL

Definition at line 38 of file HiiLib.c.

Data Structures

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ ACTION_SET_DEFAUTL_VALUE

◆ ACTION_VALIDATE_SETTING

◆ GUID_CONFIG_STRING_TYPE

◆ HII_LIB_DEFAULT_VARSTORE_SIZE

◆ HII_LIB_OPCODE_ALLOCATION_SIZE

◆ NAME_CONFIG_STRING_TYPE

◆ PATH_CONFIG_STRING_TYPE

Function Documentation

◆ BlockArrayCheck()

◆ GetBlockDataInfo()

◆ GetElementsFromRequest()

◆ GetValueFromRequest()

◆ HiiAddPackages()

◆ HiiAllocateOpCodeHandle()

◆ HiiConstructConfigHdr()

◆ HiiCreateActionOpCode()

◆ HiiCreateCheckBoxOpCode()

◆ HiiCreateDateOpCode()

◆ HiiCreateDefaultOpCode()

◆ HiiCreateEndOpCode()

◆ HiiCreateGotoExOpCode()

◆ HiiCreateGotoOpCode()

◆ HiiCreateGuidOpCode()

◆ HiiCreateNumericOpCode()

◆ HiiCreateOneOfOpCode()

◆ HiiCreateOneOfOptionOpCode()

◆ HiiCreateOrderedListOpCode()

◆ HiiCreateRawOpCodes()

◆ HiiCreateStringOpCode()

◆ HiiCreateSubTitleOpCode()

◆ HiiCreateTextOpCode()

◆ HiiCreateTimeOpCode()

◆ HiiFreeOpCodeHandle()

◆ HiiGetBrowserData()

◆ HiiGetFormSetFromHiiHandle()

◆ HiiGetHiiHandles()

◆ HiiIsConfigHdrMatch()

◆ HiiRemovePackages()

◆ HiiSetBrowserData()

◆ HiiSetToDefaults()

◆ HiiUpdateForm()

◆ HiiValidateSettings()

◆ InternalHiiAppendOpCodes()

◆ InternalHiiBlockToConfig()

◆ InternalHiiBrowserCallback()

◆ InternalHiiCompareSubString()

◆ InternalHiiCreateOpCode()

◆ InternalHiiCreateOpCodeExtended()

◆ InternalHiiExtractGuidFromHiiHandle()

◆ InternalHiiGetBufferFromString()

◆ InternalHiiGetValueOfNumber()

◆ InternalHiiGrowOpCodeHandle()

◆ InternalHiiIfrValueAction()

◆ InternalHiiLowerConfigString()

◆ InternalHiiOpCodeHandleBuffer()

◆ InternalHiiOpCodeHandlePosition()

◆ InternalHiiUpdateFormPackageData()

◆ InternalHiiValidateCurrentSetting()

◆ ValidateQuestionFromVfr()

Variable Documentation

◆ mConfigHdrTemplate

◆ mEndOfPakageList

◆ mHiiDefaultTypeToWidth

◆ mUefiFormBrowser2