#include <Library/UefiBootServicesTableLib.h>
#include <Library/DebugLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/BaseLib.h>
#include <Library/HiiLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/PrintLib.h>
#include <Library/CustomizedDisplayLib.h>
#include <Protocol/FormBrowserEx2.h>
#include <Protocol/SimpleTextIn.h>
#include <Protocol/DisplayProtocol.h>
#include <Protocol/HiiPopup.h>
#include <Guid/MdeModuleHii.h>

Data Structures
struct	FORM_DISPLAY_DRIVER_PRIVATE_DATA

struct	SCAN_CODE_TO_SCREEN_OPERATION

struct	SCREEN_OPERATION_T0_CONTROL_FLAG

struct	DISPLAY_HIGHLIGHT_MENU_INFO

struct	WARNING_IF_CONTEXT

struct	UI_MENU_OPTION

struct	USER_SELECTABLE_OPTION

Macros
#define	LEFT_SKIPPED_COLUMNS 3

#define	SCROLL_ARROW_HEIGHT 1

#define	POPUP_PAD_SPACE_COUNT 5

#define	POPUP_FRAME_WIDTH 2

#define	UPPER_LOWER_CASE_OFFSET 0x20

#define	LEFT_ONEOF_DELIMITER L'<'

#define	RIGHT_ONEOF_DELIMITER L'>'

#define	LEFT_NUMERIC_DELIMITER L'['

#define	RIGHT_NUMERIC_DELIMITER L']'

#define	LEFT_CHECKBOX_DELIMITER L'['

#define	RIGHT_CHECKBOX_DELIMITER L']'

#define	CHECK_ON L'X'

#define	CHECK_OFF L' '

#define	TIME_SEPARATOR L':'

#define	DATE_SEPARATOR L'/'

#define	SUBTITLE_INDENT 2

#define	INPUT_ERROR 1

#define	NV_UPDATE_REQUIRED 2

#define	ONE_SECOND 10000000

#define	MAX_NUMERIC_INPUT_WIDTH 24

#define	EFI_HII_EXPRESSION_INCONSISTENT_IF 0

#define	EFI_HII_EXPRESSION_NO_SUBMIT_IF 1

#define	EFI_HII_EXPRESSION_GRAY_OUT_IF 2

#define	EFI_HII_EXPRESSION_SUPPRESS_IF 3

#define	EFI_HII_EXPRESSION_DISABLE_IF 4

#define	CHAR_SPACE 0x0020

#define	FORM_DISPLAY_DRIVER_SIGNATURE SIGNATURE_32 ('F', 'D', 'D', 'V')

#define	UI_MENU_OPTION_SIGNATURE SIGNATURE_32 ('u', 'i', 'm', 'm')

#define	MENU_OPTION_FROM_LINK(a) CR (a, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE)

#define	USER_SELECTABLE_OPTION_OK_WIDTH StrLen (gOkOption)

#define	USER_SELECTABLE_OPTION_OK_CAL_WIDTH (StrLen (gOkOption) + StrLen (gCancelOption))

#define	USER_SELECTABLE_OPTION_YES_NO_WIDTH (StrLen (gYesOption) + StrLen (gNoOption))

#define	USER_SELECTABLE_OPTION_YES_NO_CAL_WIDTH (StrLen (gYesOption) + StrLen (gNoOption) + StrLen (gCancelOption))

#define	USER_SELECTABLE_OPTION_SKIP_WIDTH 2

#define	POPUP_BORDER 1

#define	POPUP_EMPTY_LINE_HEIGHT 1

#define	POPUP_STYLE_STRING_HEIGHT 1

#define	POPUP_USER_SELECTABLE_OPTION_HEIGHT 1

#define	POPUP_HEADER_HEIGHT (POPUP_BORDER + POPUP_STYLE_STRING_HEIGHT + POPUP_EMPTY_LINE_HEIGHT)

#define	POPUP_FOOTER_HEIGHT (POPUP_EMPTY_LINE_HEIGHT + POPUP_USER_SELECTABLE_OPTION_HEIGHT + POPUP_BORDER)

#define	USER_SELECTABLE_OPTION_SIGNATURE SIGNATURE_32 ('u', 's', 's', 'o')

#define	SELECTABLE_OPTION_FROM_LINK(a) CR (a, USER_SELECTABLE_OPTION, Link, USER_SELECTABLE_OPTION_SIGNATURE)

Enumerations
enum	UI_SCREEN_OPERATION { UiNoOperation , UiSelect , UiUp , UiDown , UiLeft , UiRight , UiReset , UiPrevious , UiPageUp , UiPageDown , UiHotKey , UiMaxOperation }

enum	UI_CONTROL_FLAG { CfInitialization , CfCheckSelection , CfRepaint , CfRefreshHighLight , CfUpdateHelpString , CfPrepareToReadKey , CfReadKey , CfScreenOperation , CfUiSelect , CfUiReset , CfUiLeft , CfUiRight , CfUiUp , CfUiPageUp , CfUiPageDown , CfUiDown , CfUiNoOperation , CfExit , CfUiHotKey , CfMaxControlFlag }

enum	UI_EVENT_TYPE { UIEventNone , UIEventKey , UIEventTimeOut , UIEventDriver }

Functions
EFI_STATUS	PrintFormattedNumber (IN FORM_DISPLAY_ENGINE_STATEMENT Question, IN OUT CHAR16 FormattedNumber, IN UINTN BufferSize)

VOID	SetArrayData (IN VOID *Array, IN UINT8 Type, IN UINTN Index, IN UINT64 Value)

UINT64	GetArrayData (IN VOID *Array, IN UINT8 Type, IN UINTN Index)

DISPLAY_QUESTION_OPTION *	ValueToOption (IN FORM_DISPLAY_ENGINE_STATEMENT Question, IN EFI_HII_VALUE OptionValue)

EFI_STATUS	CompareHiiValue (IN EFI_HII_VALUE Value1, IN EFI_HII_VALUE Value2, OUT INTN *Result, IN EFI_HII_HANDLE HiiHandle OPTIONAL)

VOID EFIAPI	CreateMultiStringPopUp (IN UINTN RequestedWidth, IN UINTN NumberOfLines,...)

UINT16	GetLineByWidth (IN CHAR16 InputString, IN UINT16 LineWidth, IN OUT UINT16 GlyphWidth, IN OUT UINTN Index, OUT CHAR16 *OutputString)

CHAR16 *	GetToken (IN EFI_STRING_ID Token, IN EFI_HII_HANDLE HiiHandle)

UINTN	GetStringWidth (IN CHAR16 *String)

EFI_STATUS	GetNumericInput (IN UI_MENU_OPTION *MenuOption)

EFI_STATUS	ReadString (IN UI_MENU_OPTION MenuOption, IN CHAR16 Prompt, IN OUT CHAR16 *StringPtr)

VOID	CreateSharedPopUp (IN UINTN RequestedWidth, IN UINTN NumberOfLines, IN VA_LIST Marker)

EFI_STATUS	WaitForKeyStroke (OUT EFI_INPUT_KEY *Key)

EFI_STATUS	GetSelectionInputPopUp (IN UI_MENU_OPTION *MenuOption)

UINTN	ProcessHelpString (IN CHAR16 StringPtr, OUT CHAR16 FormattedString, OUT UINT16 EachLineWidth, IN UINTN RowCount)

EFI_STATUS	ProcessOptions (IN UI_MENU_OPTION MenuOption, IN BOOLEAN Selected, OUT CHAR16 *OptionString, IN BOOLEAN SkipErrorValue)

VOID	SetUnicodeMem (IN VOID *Buffer, IN UINTN Size, IN CHAR16 Value)

EFI_STATUS EFIAPI	FormDisplay (IN FORM_DISPLAY_ENGINE_FORM FormData, OUT USER_INPUT UserInputData)

VOID EFIAPI	DriverClearDisplayPage (VOID)

VOID EFIAPI	ExitDisplay (VOID)

VOID EFIAPI	EmptyEventProcess (IN EFI_EVENT Event, IN VOID *Context)

VOID EFIAPI	RefreshTimeOutProcess (IN EFI_EVENT Event, IN VOID *Context)

VOID	UpdateHighlightMenuInfo (IN LIST_ENTRY Highlight, IN LIST_ENTRY TopOfScreen, IN UINTN SkipValue)

EFI_STATUS EFIAPI	CreatePopup (IN EFI_HII_POPUP_PROTOCOL This, IN EFI_HII_POPUP_STYLE PopupStyle, IN EFI_HII_POPUP_TYPE PopupType, IN EFI_HII_HANDLE HiiHandle, IN EFI_STRING_ID Message, OUT EFI_HII_POPUP_SELECTION UserSelection OPTIONAL)

Variables
UINT8	DisplayEngineStrings []

EFI_SCREEN_DESCRIPTOR	gStatementDimensions

USER_INPUT *	gUserInput

FORM_DISPLAY_ENGINE_FORM *	gFormData

EFI_HII_HANDLE	gHiiHandle

UINT16	gDirection

LIST_ENTRY	gMenuOption

CHAR16 *	gConfirmOptYes

CHAR16 *	gConfirmOptNo

CHAR16 *	gConfirmOptOk

CHAR16 *	gConfirmOptCancel

CHAR16 *	gYesOption

CHAR16 *	gNoOption

CHAR16 *	gOkOption

CHAR16 *	gCancelOption

CHAR16 *	gErrorPopup

CHAR16 *	gWarningPopup

CHAR16 *	gInfoPopup

CHAR16 *	gSaveFailed

CHAR16 *	gPromptForData

CHAR16 *	gPromptForPassword

CHAR16 *	gPromptForNewPassword

CHAR16 *	gConfirmPassword

CHAR16 *	gConfirmError

CHAR16 *	gPassowordInvalid

CHAR16 *	gPressEnter

CHAR16 *	gEmptyString

CHAR16 *	gMiniString

CHAR16 *	gOptionMismatch

CHAR16 *	gFormSuppress

CHAR16 *	gProtocolNotFound

CHAR16 *	gPasswordUnsupported

CHAR16	gPromptBlockWidth

CHAR16	gOptionBlockWidth

CHAR16	gHelpBlockWidth

CHAR16 *	mUnknownString

BOOLEAN	gMisMatch

Detailed Description

FormDiplay protocol to show Form

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

Definition in file FormDisplay.h.

Macro Definition Documentation

◆ CHAR_SPACE

#define CHAR_SPACE 0x0020

Definition at line 135 of file FormDisplay.h.

◆ CHECK_OFF

#define CHECK_OFF L' '

Definition at line 98 of file FormDisplay.h.

◆ CHECK_ON

#define CHECK_ON L'X'

Definition at line 97 of file FormDisplay.h.

◆ DATE_SEPARATOR

#define DATE_SEPARATOR L'/'

Definition at line 101 of file FormDisplay.h.

◆ EFI_HII_EXPRESSION_DISABLE_IF

#define EFI_HII_EXPRESSION_DISABLE_IF 4

Definition at line 130 of file FormDisplay.h.

◆ EFI_HII_EXPRESSION_GRAY_OUT_IF

#define EFI_HII_EXPRESSION_GRAY_OUT_IF 2

Definition at line 128 of file FormDisplay.h.

◆ EFI_HII_EXPRESSION_INCONSISTENT_IF

#define EFI_HII_EXPRESSION_INCONSISTENT_IF 0

Definition at line 126 of file FormDisplay.h.

◆ EFI_HII_EXPRESSION_NO_SUBMIT_IF

#define EFI_HII_EXPRESSION_NO_SUBMIT_IF 1

Definition at line 127 of file FormDisplay.h.

◆ EFI_HII_EXPRESSION_SUPPRESS_IF

#define EFI_HII_EXPRESSION_SUPPRESS_IF 3

Definition at line 129 of file FormDisplay.h.

◆ FORM_DISPLAY_DRIVER_SIGNATURE

#define FORM_DISPLAY_DRIVER_SIGNATURE SIGNATURE_32 ('F', 'D', 'D', 'V')

Definition at line 137 of file FormDisplay.h.

◆ INPUT_ERROR

#define INPUT_ERROR 1

Definition at line 108 of file FormDisplay.h.

◆ LEFT_CHECKBOX_DELIMITER

#define LEFT_CHECKBOX_DELIMITER L'['

Definition at line 94 of file FormDisplay.h.

◆ LEFT_NUMERIC_DELIMITER

#define LEFT_NUMERIC_DELIMITER L'['

Definition at line 91 of file FormDisplay.h.

◆ LEFT_ONEOF_DELIMITER

#define LEFT_ONEOF_DELIMITER L'<'

Definition at line 88 of file FormDisplay.h.

◆ LEFT_SKIPPED_COLUMNS

#define LEFT_SKIPPED_COLUMNS 3

Definition at line 78 of file FormDisplay.h.

◆ MAX_NUMERIC_INPUT_WIDTH

#define MAX_NUMERIC_INPUT_WIDTH 24

Definition at line 124 of file FormDisplay.h.

◆ MENU_OPTION_FROM_LINK

#define MENU_OPTION_FROM_LINK ( a ) CR (a, UI_MENU_OPTION, Link, UI_MENU_OPTION_SIGNATURE)

Definition at line 278 of file FormDisplay.h.

◆ NV_UPDATE_REQUIRED

#define NV_UPDATE_REQUIRED 2

Definition at line 113 of file FormDisplay.h.

◆ ONE_SECOND

#define ONE_SECOND 10000000

Definition at line 117 of file FormDisplay.h.

◆ POPUP_BORDER

#define POPUP_BORDER 1

Definition at line 296 of file FormDisplay.h.

◆ POPUP_EMPTY_LINE_HEIGHT

#define POPUP_EMPTY_LINE_HEIGHT 1

Definition at line 297 of file FormDisplay.h.

◆ POPUP_FOOTER_HEIGHT

#define POPUP_FOOTER_HEIGHT (POPUP_EMPTY_LINE_HEIGHT + POPUP_USER_SELECTABLE_OPTION_HEIGHT + POPUP_BORDER)

Definition at line 302 of file FormDisplay.h.

◆ POPUP_FRAME_WIDTH

#define POPUP_FRAME_WIDTH 2

Definition at line 81 of file FormDisplay.h.

◆ POPUP_HEADER_HEIGHT

#define POPUP_HEADER_HEIGHT (POPUP_BORDER + POPUP_STYLE_STRING_HEIGHT + POPUP_EMPTY_LINE_HEIGHT)

Definition at line 301 of file FormDisplay.h.

◆ POPUP_PAD_SPACE_COUNT

#define POPUP_PAD_SPACE_COUNT 5

Definition at line 80 of file FormDisplay.h.

◆ POPUP_STYLE_STRING_HEIGHT

#define POPUP_STYLE_STRING_HEIGHT 1

Definition at line 298 of file FormDisplay.h.

◆ POPUP_USER_SELECTABLE_OPTION_HEIGHT

#define POPUP_USER_SELECTABLE_OPTION_HEIGHT 1

Definition at line 299 of file FormDisplay.h.

◆ RIGHT_CHECKBOX_DELIMITER

#define RIGHT_CHECKBOX_DELIMITER L']'

Definition at line 95 of file FormDisplay.h.

◆ RIGHT_NUMERIC_DELIMITER

#define RIGHT_NUMERIC_DELIMITER L']'

Definition at line 92 of file FormDisplay.h.

◆ RIGHT_ONEOF_DELIMITER

#define RIGHT_ONEOF_DELIMITER L'>'

Definition at line 89 of file FormDisplay.h.

◆ SCROLL_ARROW_HEIGHT

#define SCROLL_ARROW_HEIGHT 1

Definition at line 79 of file FormDisplay.h.

◆ SELECTABLE_OPTION_FROM_LINK

#define SELECTABLE_OPTION_FROM_LINK ( a ) CR (a, USER_SELECTABLE_OPTION, Link, USER_SELECTABLE_OPTION_SIGNATURE)

Definition at line 332 of file FormDisplay.h.

◆ SUBTITLE_INDENT

#define SUBTITLE_INDENT 2

Definition at line 103 of file FormDisplay.h.

◆ TIME_SEPARATOR

#define TIME_SEPARATOR L':'

Definition at line 100 of file FormDisplay.h.

◆ UI_MENU_OPTION_SIGNATURE

#define UI_MENU_OPTION_SIGNATURE SIGNATURE_32 ('u', 'i', 'm', 'm')

Definition at line 241 of file FormDisplay.h.

◆ UPPER_LOWER_CASE_OFFSET

#define UPPER_LOWER_CASE_OFFSET 0x20

Definition at line 83 of file FormDisplay.h.

◆ USER_SELECTABLE_OPTION_OK_CAL_WIDTH

#define USER_SELECTABLE_OPTION_OK_CAL_WIDTH (StrLen (gOkOption) + StrLen (gCancelOption))

Definition at line 281 of file FormDisplay.h.

◆ USER_SELECTABLE_OPTION_OK_WIDTH

#define USER_SELECTABLE_OPTION_OK_WIDTH StrLen (gOkOption)

Definition at line 280 of file FormDisplay.h.

◆ USER_SELECTABLE_OPTION_SIGNATURE

#define USER_SELECTABLE_OPTION_SIGNATURE SIGNATURE_32 ('u', 's', 's', 'o')

Definition at line 304 of file FormDisplay.h.

◆ USER_SELECTABLE_OPTION_SKIP_WIDTH

#define USER_SELECTABLE_OPTION_SKIP_WIDTH 2

Definition at line 285 of file FormDisplay.h.

◆ USER_SELECTABLE_OPTION_YES_NO_CAL_WIDTH

#define USER_SELECTABLE_OPTION_YES_NO_CAL_WIDTH (StrLen (gYesOption) + StrLen (gNoOption) + StrLen (gCancelOption))

Definition at line 283 of file FormDisplay.h.

◆ USER_SELECTABLE_OPTION_YES_NO_WIDTH

#define USER_SELECTABLE_OPTION_YES_NO_WIDTH (StrLen (gYesOption) + StrLen (gNoOption))

Definition at line 282 of file FormDisplay.h.

Enumeration Type Documentation

◆ UI_CONTROL_FLAG

enum UI_CONTROL_FLAG

Definition at line 165 of file FormDisplay.h.

◆ UI_EVENT_TYPE

enum UI_EVENT_TYPE

Definition at line 188 of file FormDisplay.h.

◆ UI_SCREEN_OPERATION

enum UI_SCREEN_OPERATION

Definition at line 150 of file FormDisplay.h.

Function Documentation

◆ CompareHiiValue()

EFI_STATUS CompareHiiValue	(	IN EFI_HII_VALUE *	Value1,
		IN EFI_HII_VALUE *	Value2,
		OUT INTN *	Result,
		IN EFI_HII_HANDLE HiiHandle	OPTIONAL
	)

Compare two Hii value.

Parameters

Value1	Expression value to compare on left-hand.
Value2	Expression value to compare on right-hand.
Result	Return value after compare. retval 0 Two operators equal. return Positive value if Value1 is greater than Value2. retval Negative value if Value1 is less than Value2.
HiiHandle	Only required for string compare.

Return values

other	Could not perform compare on two values.
EFI_SUCCESS	Compare the value success.

Compare two Hii value.

Parameters

[in]	Value1	Expression value to compare on left-hand.
[in]	Value2	Expression value to compare on right-hand.
[out]	Result	Return value after compare. retval 0 Two operators equal. return Positive value if Value1 is greater than Value2. retval Negative value if Value1 is less than Value2.
[in]	HiiHandle	Only required for string compare.

Return values

other	Could not perform compare on two values.
EFI_SUCCESS	Compare the value success.
EFI_INVALID_PARAMETER	Value1, Value2 or Result is NULL.

Definition at line 214 of file ProcessOptions.c.

◆ CreateMultiStringPopUp()

VOID EFIAPI CreateMultiStringPopUp	(	IN UINTN	RequestedWidth,
		IN UINTN	NumberOfLines,
			...
	)

Draw a pop up windows based on the dimension, number of lines and strings specified.

Parameters

RequestedWidth	The width of the pop-up.
NumberOfLines	The number of lines.
...	A series of text strings that displayed in the pop-up.

Definition at line 689 of file ProcessOptions.c.

◆ CreatePopup()

EFI_STATUS EFIAPI CreatePopup	(	IN EFI_HII_POPUP_PROTOCOL *	This,
		IN EFI_HII_POPUP_STYLE	PopupStyle,
		IN EFI_HII_POPUP_TYPE	PopupType,
		IN EFI_HII_HANDLE	HiiHandle,
		IN EFI_STRING_ID	Message,
		OUT EFI_HII_POPUP_SELECTION *UserSelection	OPTIONAL
	)

Displays a popup window.

Parameters

This	A pointer to the EFI_HII_POPUP_PROTOCOL instance.
PopupStyle	Popup style to use.
PopupType	Type of the popup to display.
HiiHandle	HII handle of the string pack containing Message
Message	A message to display in the popup box.
UserSelection	User selection.

Return values

EFI_SUCCESS	The popup box was successfully displayed.
EFI_INVALID_PARAMETER	HiiHandle and Message do not define a valid HII string.
EFI_INVALID_PARAMETER	PopupType is not one of the values defined by this specification.
EFI_OUT_OF_RESOURCES	There are not enough resources available to display the popup box.

Definition at line 688 of file Popup.c.

◆ CreateSharedPopUp()

VOID CreateSharedPopUp	(	IN UINTN	RequestedWidth,
		IN UINTN	NumberOfLines,
		IN VA_LIST	Marker
	)

Draw a pop up windows based on the dimension, number of lines and strings specified.

Parameters

RequestedWidth	The width of the pop-up.
NumberOfLines	The number of lines.
Marker	The variable argument list for the list of string to be printed.

Definition at line 583 of file ProcessOptions.c.

◆ DriverClearDisplayPage()

VOID EFIAPI DriverClearDisplayPage ( VOID )

Clear Screen to the initial state.

Definition at line 4193 of file FormDisplay.c.

◆ EmptyEventProcess()

VOID EFIAPI EmptyEventProcess	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

Process nothing.

Parameters

Event	The Event need to be process
Context	The context of the event.

Definition at line 713 of file ProcessOptions.c.

◆ ExitDisplay()

VOID EFIAPI ExitDisplay ( VOID )

Exit Display and Clear Screen to the original state.

◆ FormDisplay()

EFI_STATUS EFIAPI FormDisplay	(	IN FORM_DISPLAY_ENGINE_FORM *	FormData,
		OUT USER_INPUT *	UserInputData
	)

Display one form, and return user input.

Parameters

FormData	Form Data to be shown.
UserInputData	User input data.

Return values

EFI_SUCCESS Form Data is shown, and user input is got.

Display one form, and return user input.

Parameters

FormData	Form Data to be shown.
UserInputData	User input data.

Return values

EFI_SUCCESS	1.Form Data is shown, and user input is got. 2.Error info has show and return.
EFI_INVALID_PARAMETER	The input screen dimension is not valid
EFI_NOT_FOUND	New form data has some error.

Definition at line 4111 of file FormDisplay.c.

◆ GetArrayData()

UINT64 GetArrayData	(	IN VOID *	Array,
		IN UINT8	Type,
		IN UINTN	Index
	)

Return data element in an Array by its Index.

Parameters

Array	The data array.
Type	Type of the data in this array.
Index	Zero based index for data in this array.

Return values

Value The data to be returned

Definition at line 354 of file ProcessOptions.c.

◆ GetLineByWidth()

UINT16 GetLineByWidth	(	IN CHAR16 *	InputString,
		IN UINT16	LineWidth,
		IN OUT UINT16 *	GlyphWidth,
		IN OUT UINTN *	Index,
		OUT CHAR16 **	OutputString
	)

Will copy LineWidth amount of a string in the OutputString buffer and return the number of CHAR16 characters that were copied into the OutputString buffer. The output string format is: Glyph Info + String info + '\0'.

In the code, it deals \r,
,\r
same as
\r, also it not process the \r or \g.

Parameters

InputString	String description for this option.
LineWidth	Width of the desired string to extract in CHAR16 characters
GlyphWidth	The glyph width of the begin of the char in the string.
Index	Where in InputString to start the copy process
OutputString	Buffer to copy the string into

Returns: Returns the number of CHAR16 characters that were copied into the OutputString buffer, include extra glyph info and '\0' info.

Definition at line 464 of file FormDisplay.c.

◆ GetNumericInput()

EFI_STATUS GetNumericInput ( IN UI_MENU_OPTION * MenuOption )

This routine reads a numeric value from the user input.

Parameters

MenuOption Pointer to the current input menu.

Return values

EFI_SUCCESS	If numerical input is read successfully
EFI_DEVICE_ERROR	If operation fails

Definition at line 487 of file InputHandler.c.

◆ GetSelectionInputPopUp()

EFI_STATUS GetSelectionInputPopUp ( IN UI_MENU_OPTION * MenuOption )

Get selection for OneOf and OrderedList (Left/Right will be ignored).

Parameters

MenuOption Pointer to the current input menu.

Return values

EFI_SUCCESS	If Option input is processed successfully
EFI_DEVICE_ERROR	If operation fails

Definition at line 1280 of file InputHandler.c.

◆ GetStringWidth()

UINTN GetStringWidth ( IN CHAR16 * String )

Count the storage space of a Unicode string.

This function handles the Unicode string with NARROW_CHAR and WIDE_CHAR control characters. NARROW_HCAR and WIDE_CHAR does not count in the resultant output. If a WIDE_CHAR is hit, then 2 Unicode character will consume an output storage space with size of CHAR16 till a NARROW_CHAR is hit.

If String is NULL, then ASSERT ().

Parameters

String The input string to be counted.

Returns: Storage space for the input string.

Definition at line 830 of file FormDisplay.c.

◆ GetToken()

CHAR16 * GetToken	(	IN EFI_STRING_ID	Token,
		IN EFI_HII_HANDLE	HiiHandle
	)

Get the string based on the StringId and HII Package List Handle.

Parameters

Token	The String's ID.
HiiHandle	The Hii handle for this string package.

Returns: The output string.

Get the string based on the StringId and HII Package List Handle.

Parameters

Token	The String's ID.
HiiHandle	The package list in the HII database to search for the specified string.

Returns: The output string.

Definition at line 191 of file FormDisplay.c.

◆ PrintFormattedNumber()

EFI_STATUS PrintFormattedNumber	(	IN FORM_DISPLAY_ENGINE_STATEMENT *	Question,
		IN OUT CHAR16 *	FormattedNumber,
		IN UINTN	BufferSize
	)

Print Question Value according to it's storage width and display attributes.

Parameters

Question	The Question to be printed.
FormattedNumber	Buffer for output string.
BufferSize	The FormattedNumber buffer size in bytes.

Return values

EFI_SUCCESS	Print success.
EFI_BUFFER_TOO_SMALL	Buffer size is not enough for formatted number.

Definition at line 508 of file ProcessOptions.c.

◆ ProcessHelpString()

UINTN ProcessHelpString	(	IN CHAR16 *	StringPtr,
		OUT CHAR16 **	FormattedString,
		OUT UINT16 *	EachLineWidth,
		IN UINTN	RowCount
	)

Process the help string: Split StringPtr to several lines of strings stored in FormattedString and the glyph width of each line cannot exceed gHelpBlockWidth.

Parameters

StringPtr	The entire help string.
FormattedString	The oupput formatted string.
EachLineWidth	The max string length of each line in the formatted string.
RowCount	TRUE: if Question is selected.

Definition at line 1560 of file ProcessOptions.c.

◆ ProcessOptions()

EFI_STATUS ProcessOptions	(	IN UI_MENU_OPTION *	MenuOption,
		IN BOOLEAN	Selected,
		OUT CHAR16 **	OptionString,
		IN BOOLEAN	SkipErrorValue
	)

Process a Question's Option (whether selected or un-selected).

Parameters

MenuOption	The MenuOption for this Question.
Selected	TRUE: if Question is selected.
OptionString	Pointer of the Option String to be displayed.
SkipErrorValue	Whether need to return when value without option for it.

Return values

EFI_SUCCESS	Question Option process success.
Other	Question Option process fail.

Definition at line 1044 of file ProcessOptions.c.

◆ ReadString()

EFI_STATUS ReadString	(	IN UI_MENU_OPTION *	MenuOption,
		IN CHAR16 *	Prompt,
		IN OUT CHAR16 *	StringPtr
	)

Get string or password input from user.

Parameters

MenuOption	Pointer to the current input menu.
Prompt	The prompt string shown on popup window.
StringPtr	Old user input and destination for use input string.

Return values

EFI_SUCCESS	If string input is read successfully
EFI_DEVICE_ERROR	If operation fails

Definition at line 56 of file InputHandler.c.

◆ RefreshTimeOutProcess()

VOID EFIAPI RefreshTimeOutProcess	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

Process for the refresh interval statement.

Parameters

Event	The Event need to be process
Context	The context of the event.

Definition at line 729 of file ProcessOptions.c.

◆ SetArrayData()

VOID SetArrayData	(	IN VOID *	Array,
		IN UINT8	Type,
		IN UINTN	Index,
		IN UINT64	Value
	)

Set value of a data element in an Array by its Index.

Parameters

Array	The data array.
Type	Type of the data in this array.
Index	Zero based index for data in this array.
Value	The value to be set.

Set value of a data element in an Array by its Index.

Parameters

[in]	Array	The data array.
[in]	Type	Type of the data in this array.
[in]	Index	Zero based index for data in this array.
[in]	Value	The value to be set.

Definition at line 399 of file ProcessOptions.c.

◆ SetUnicodeMem()

VOID SetUnicodeMem	(	IN VOID *	Buffer,
		IN UINTN	Size,
		IN CHAR16	Value
	)

Set Buffer to Value for Size bytes.

Parameters

Buffer	Memory to set.
Size	Number of bytes to set
Value	Value of the set operation.

Definition at line 4210 of file FormDisplay.c.

◆ UpdateHighlightMenuInfo()

VOID UpdateHighlightMenuInfo	(	IN LIST_ENTRY *	Highlight,
		IN LIST_ENTRY *	TopOfScreen,
		IN UINTN	SkipValue
	)

Record the highlight menu and top of screen menu info.

Parameters

Highlight	The menu opton which is highlight.
TopOfScreen	The menu opton which is at the top of the form.
SkipValue	The skip line info for the top of screen menu.

Definition at line 2023 of file FormDisplay.c.

◆ ValueToOption()

DISPLAY_QUESTION_OPTION * ValueToOption	(	IN FORM_DISPLAY_ENGINE_STATEMENT *	Question,
		IN EFI_HII_VALUE *	OptionValue
	)

Search an Option of a Question by its value.

Parameters

Question	The Question
OptionValue	Value for Option to be searched.

Return values

Pointer	Pointer to the found Option.
NULL	Option not found.

Definition at line 315 of file ProcessOptions.c.

◆ WaitForKeyStroke()

EFI_STATUS WaitForKeyStroke ( OUT EFI_INPUT_KEY * Key )

Wait for a key to be pressed by user.

Parameters

Key	The key which is pressed by user.

Return values

EFI_SUCCESS The function always completed successfully.

Definition at line 791 of file CustomizedDisplayLibInternal.c.

Variable Documentation

◆ gCancelOption

CHAR16* gCancelOption

extern

Definition at line 153 of file FormDisplay.c.

◆ gConfirmError

CHAR16* gConfirmError

extern

Definition at line 128 of file FormDisplay.c.

◆ gConfirmOptCancel

CHAR16* gConfirmOptCancel

extern

Definition at line 149 of file FormDisplay.c.

◆ gConfirmOptNo

CHAR16* gConfirmOptNo

extern

Definition at line 147 of file FormDisplay.c.

◆ gConfirmOptOk

CHAR16* gConfirmOptOk

extern

Definition at line 148 of file FormDisplay.c.

◆ gConfirmOptYes

CHAR16* gConfirmOptYes

extern

Definition at line 146 of file FormDisplay.c.

◆ gConfirmPassword

CHAR16* gConfirmPassword

extern

Definition at line 127 of file FormDisplay.c.

◆ gDirection

UINT16 gDirection

extern

Definition at line 101 of file FormDisplay.c.

◆ gEmptyString

CHAR16* gEmptyString

extern

Definition at line 131 of file FormDisplay.c.

◆ gErrorPopup

CHAR16* gErrorPopup

extern

Definition at line 154 of file FormDisplay.c.

◆ gFormData

FORM_DISPLAY_ENGINE_FORM* gFormData

extern

Definition at line 99 of file FormDisplay.c.

◆ gFormSuppress

CHAR16* gFormSuppress

extern

Definition at line 134 of file FormDisplay.c.

◆ gHelpBlockWidth

CHAR16 gHelpBlockWidth

extern

Definition at line 163 of file FormDisplay.c.

◆ gHiiHandle

EFI_HII_HANDLE gHiiHandle

extern

Definition at line 100 of file FormDisplay.c.

◆ gInfoPopup

CHAR16* gInfoPopup

extern

Definition at line 156 of file FormDisplay.c.

◆ gMenuOption

LIST_ENTRY gMenuOption

extern

Definition at line 102 of file FormDisplay.c.

◆ gMiniString

CHAR16* gMiniString

extern

Definition at line 132 of file FormDisplay.c.

◆ gMisMatch

BOOLEAN gMisMatch

extern

Definition at line 95 of file FormDisplay.c.

◆ gNoOption

CHAR16* gNoOption

extern

Definition at line 151 of file FormDisplay.c.

◆ gOkOption

CHAR16* gOkOption

extern

Definition at line 152 of file FormDisplay.c.

◆ gOptionBlockWidth

CHAR16 gOptionBlockWidth

extern

Definition at line 162 of file FormDisplay.c.

◆ gOptionMismatch

CHAR16* gOptionMismatch

extern

Definition at line 133 of file FormDisplay.c.

◆ gPassowordInvalid

CHAR16* gPassowordInvalid

extern

Definition at line 129 of file FormDisplay.c.

◆ gPasswordUnsupported

CHAR16* gPasswordUnsupported

extern

Definition at line 159 of file FormDisplay.c.

◆ gPressEnter

CHAR16* gPressEnter

extern

Definition at line 130 of file FormDisplay.c.

◆ gPromptBlockWidth

CHAR16 gPromptBlockWidth

extern

Definition at line 161 of file FormDisplay.c.

◆ gPromptForData

CHAR16* gPromptForData

extern

Definition at line 124 of file FormDisplay.c.

◆ gPromptForNewPassword

CHAR16* gPromptForNewPassword

extern

Definition at line 126 of file FormDisplay.c.

◆ gPromptForPassword

CHAR16* gPromptForPassword

extern

Definition at line 125 of file FormDisplay.c.

◆ gProtocolNotFound

CHAR16* gProtocolNotFound

extern

Definition at line 135 of file FormDisplay.c.

◆ gSaveFailed

CHAR16* gSaveFailed

extern

Definition at line 117 of file FormDisplay.c.

◆ gStatementDimensions

EFI_SCREEN_DESCRIPTOR gStatementDimensions

extern

Definition at line 96 of file FormDisplay.c.

◆ gUserInput

USER_INPUT* gUserInput

extern

Definition at line 98 of file FormDisplay.c.

◆ gWarningPopup

CHAR16* gWarningPopup

extern

Definition at line 155 of file FormDisplay.c.

◆ gYesOption

CHAR16* gYesOption

extern

Definition at line 150 of file FormDisplay.c.

◆ mUnknownString

CHAR16* mUnknownString

extern

Definition at line 164 of file FormDisplay.c.

Data Structures

Macros

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ CHAR_SPACE

◆ CHECK_OFF

◆ CHECK_ON

◆ DATE_SEPARATOR

◆ EFI_HII_EXPRESSION_DISABLE_IF

◆ EFI_HII_EXPRESSION_GRAY_OUT_IF

◆ EFI_HII_EXPRESSION_INCONSISTENT_IF

◆ EFI_HII_EXPRESSION_NO_SUBMIT_IF

◆ EFI_HII_EXPRESSION_SUPPRESS_IF

◆ FORM_DISPLAY_DRIVER_SIGNATURE

◆ INPUT_ERROR

◆ LEFT_CHECKBOX_DELIMITER

◆ LEFT_NUMERIC_DELIMITER

◆ LEFT_ONEOF_DELIMITER

◆ LEFT_SKIPPED_COLUMNS

◆ MAX_NUMERIC_INPUT_WIDTH

◆ MENU_OPTION_FROM_LINK

◆ NV_UPDATE_REQUIRED

◆ ONE_SECOND

◆ POPUP_BORDER

◆ POPUP_EMPTY_LINE_HEIGHT

◆ POPUP_FOOTER_HEIGHT

◆ POPUP_FRAME_WIDTH

◆ POPUP_HEADER_HEIGHT

◆ POPUP_PAD_SPACE_COUNT

◆ POPUP_STYLE_STRING_HEIGHT

◆ POPUP_USER_SELECTABLE_OPTION_HEIGHT

◆ RIGHT_CHECKBOX_DELIMITER

◆ RIGHT_NUMERIC_DELIMITER

◆ RIGHT_ONEOF_DELIMITER

◆ SCROLL_ARROW_HEIGHT

◆ SELECTABLE_OPTION_FROM_LINK

◆ SUBTITLE_INDENT

◆ TIME_SEPARATOR

◆ UI_MENU_OPTION_SIGNATURE

◆ UPPER_LOWER_CASE_OFFSET

◆ USER_SELECTABLE_OPTION_OK_CAL_WIDTH

◆ USER_SELECTABLE_OPTION_OK_WIDTH

◆ USER_SELECTABLE_OPTION_SIGNATURE

◆ USER_SELECTABLE_OPTION_SKIP_WIDTH

◆ USER_SELECTABLE_OPTION_YES_NO_CAL_WIDTH

◆ USER_SELECTABLE_OPTION_YES_NO_WIDTH

Enumeration Type Documentation

◆ UI_CONTROL_FLAG

◆ UI_EVENT_TYPE

◆ UI_SCREEN_OPERATION

Function Documentation

◆ CompareHiiValue()

◆ CreateMultiStringPopUp()

◆ CreatePopup()

◆ CreateSharedPopUp()

◆ DriverClearDisplayPage()

◆ EmptyEventProcess()

◆ ExitDisplay()

◆ FormDisplay()

◆ GetArrayData()

◆ GetLineByWidth()

◆ GetNumericInput()

◆ GetSelectionInputPopUp()

◆ GetStringWidth()

◆ GetToken()

◆ PrintFormattedNumber()

◆ ProcessHelpString()

◆ ProcessOptions()

◆ ReadString()

◆ RefreshTimeOutProcess()

◆ SetArrayData()

◆ SetUnicodeMem()

◆ UpdateHighlightMenuInfo()

◆ ValueToOption()

◆ WaitForKeyStroke()

Variable Documentation

◆ gCancelOption