#include <Protocol/FormBrowser2.h>

Data Structures
struct	EFI_HII_VALUE

struct	DISPLAY_QUESTION_OPTION

struct	STATEMENT_ERROR_INFO

struct	_FORM_DISPLAY_ENGINE_STATEMENT

struct	BROWSER_HOT_KEY

struct	_FORM_DISPLAY_ENGINE_FORM

struct	USER_INPUT

struct	EDKII_FORM_DISPLAY_ENGINE_PROTOCOL

Macros
#define	EDKII_FORM_DISPLAY_ENGINE_PROTOCOL_GUID { 0x9bbe29e9, 0xfda1, 0x41ec, { 0xad, 0x52, 0x45, 0x22, 0x13, 0x74, 0x2d, 0x2e } }

#define	BROWSER_ACTION_NONE BIT16

#define	BROWSER_ACTION_FORM_EXIT BIT17

#define	BROWSER_SUCCESS 0x0

#define	BROWSER_ERROR BIT31

#define	BROWSER_SUBMIT_FAIL BROWSER_ERROR \| 0x01

#define	BROWSER_NO_SUBMIT_IF BROWSER_ERROR \| 0x02

#define	BROWSER_FORM_NOT_FOUND BROWSER_ERROR \| 0x03

#define	BROWSER_FORM_SUPPRESS BROWSER_ERROR \| 0x04

#define	BROWSER_PROTOCOL_NOT_FOUND BROWSER_ERROR \| 0x05

#define	BROWSER_INCONSISTENT_IF BROWSER_ERROR \| 0x06

#define	BROWSER_WARNING_IF BROWSER_ERROR \| 0x07

#define	BROWSER_SUBMIT_FAIL_NO_SUBMIT_IF BROWSER_ERROR \| 0x08

#define	BROWSER_RECONNECT_REQUIRED BROWSER_ERROR \| 0x09

#define	BROWSER_RECONNECT_FAIL BROWSER_ERROR \| 0x0A

#define	BROWSER_RECONNECT_SAVE_CHANGES BROWSER_ERROR \| 0x0B

#define	FORM_DISPLAY_ENGINE_STATEMENT_VERSION_1 0x10000

#define	FORM_DISPLAY_ENGINE_VERSION_1 0x10000

#define	DISPLAY_QUESTION_OPTION_SIGNATURE SIGNATURE_32 ('Q', 'O', 'P', 'T')

#define	DISPLAY_QUESTION_OPTION_FROM_LINK(a) CR (a, DISPLAY_QUESTION_OPTION, Link, DISPLAY_QUESTION_OPTION_SIGNATURE)

#define	STATEMENT_VALID 0x0

#define	STATEMENT_INVALID BIT31

#define	INCOSISTENT_IF_TRUE STATEMENT_INVALID \| 0x01

#define	WARNING_IF_TRUE STATEMENT_INVALID \| 0x02

#define	STRING_TOO_LONG STATEMENT_INVALID \| 0x03

#define	FORM_DISPLAY_ENGINE_STATEMENT_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'A')

#define	HII_DISPLAY_NONE 0

#define	HII_DISPLAY_GRAYOUT BIT0

#define	HII_DISPLAY_LOCK BIT1

#define	HII_DISPLAY_READONLY BIT2

#define	HII_DISPLAY_MODAL BIT3

#define	HII_DISPLAY_SUPPRESS BIT4

#define	FORM_DISPLAY_ENGINE_STATEMENT_FROM_LINK(a) CR (a, FORM_DISPLAY_ENGINE_STATEMENT, DisplayLink, FORM_DISPLAY_ENGINE_STATEMENT_SIGNATURE)

#define	BROWSER_HOT_KEY_SIGNATURE SIGNATURE_32 ('B', 'H', 'K', 'S')

#define	BROWSER_HOT_KEY_FROM_LINK(a) CR (a, BROWSER_HOT_KEY, Link, BROWSER_HOT_KEY_SIGNATURE)

#define	FORM_DISPLAY_ENGINE_FORM_SIGNATURE SIGNATURE_32 ('F', 'F', 'R', 'M')

#define	FORM_DISPLAY_ENGINE_FORM_FROM_LINK(a) CR (a, FORM_DISPLAY_ENGINE_FORM, Link, FORM_DISPLAY_ENGINE_FORM_SIGNATURE)

Typedefs
typedef struct _FORM_DISPLAY_ENGINE_STATEMENT	FORM_DISPLAY_ENGINE_STATEMENT

typedef struct _FORM_DISPLAY_ENGINE_FORM	FORM_DISPLAY_ENGINE_FORM

typedef UINT32(EFIAPI *	VALIDATE_QUESTION) (IN FORM_DISPLAY_ENGINE_FORM Form, IN FORM_DISPLAY_ENGINE_STATEMENT Statement, IN EFI_HII_VALUE Value, OUT STATEMENT_ERROR_INFO ErrorInfo)

typedef EFI_STATUS(EFIAPI *	PASSWORD_CHECK) (IN FORM_DISPLAY_ENGINE_FORM Form, IN FORM_DISPLAY_ENGINE_STATEMENT Statement, IN EFI_STRING PasswordString OPTIONAL)

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

typedef VOID(EFIAPI *	EXIT_DISPLAY) (VOID)

typedef UINTN(EFIAPI *	CONFIRM_DATA_CHANGE) (VOID)

Variables
EFI_GUID	gEdkiiFormDisplayEngineProtocolGuid

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 DisplayProtocol.h.

Macro Definition Documentation

◆ BROWSER_ACTION_FORM_EXIT

#define BROWSER_ACTION_FORM_EXIT BIT17

Definition at line 24 of file DisplayProtocol.h.

◆ BROWSER_ACTION_NONE

#define BROWSER_ACTION_NONE BIT16

Definition at line 20 of file DisplayProtocol.h.

◆ BROWSER_ERROR

#define BROWSER_ERROR BIT31

Definition at line 27 of file DisplayProtocol.h.

◆ BROWSER_FORM_NOT_FOUND

#define BROWSER_FORM_NOT_FOUND BROWSER_ERROR | 0x03

Definition at line 30 of file DisplayProtocol.h.

◆ BROWSER_FORM_SUPPRESS

#define BROWSER_FORM_SUPPRESS BROWSER_ERROR | 0x04

Definition at line 31 of file DisplayProtocol.h.

◆ BROWSER_HOT_KEY_FROM_LINK

#define BROWSER_HOT_KEY_FROM_LINK ( a ) CR (a, BROWSER_HOT_KEY, Link, BROWSER_HOT_KEY_SIGNATURE)

Definition at line 222 of file DisplayProtocol.h.

◆ BROWSER_HOT_KEY_SIGNATURE

#define BROWSER_HOT_KEY_SIGNATURE SIGNATURE_32 ('B', 'H', 'K', 'S')

Definition at line 204 of file DisplayProtocol.h.

◆ BROWSER_INCONSISTENT_IF

#define BROWSER_INCONSISTENT_IF BROWSER_ERROR | 0x06

Definition at line 33 of file DisplayProtocol.h.

◆ BROWSER_NO_SUBMIT_IF

#define BROWSER_NO_SUBMIT_IF BROWSER_ERROR | 0x02

Definition at line 29 of file DisplayProtocol.h.

◆ BROWSER_PROTOCOL_NOT_FOUND

#define BROWSER_PROTOCOL_NOT_FOUND BROWSER_ERROR | 0x05

Definition at line 32 of file DisplayProtocol.h.

◆ BROWSER_RECONNECT_FAIL

#define BROWSER_RECONNECT_FAIL BROWSER_ERROR | 0x0A

Definition at line 37 of file DisplayProtocol.h.

◆ BROWSER_RECONNECT_REQUIRED

#define BROWSER_RECONNECT_REQUIRED BROWSER_ERROR | 0x09

Definition at line 36 of file DisplayProtocol.h.

◆ BROWSER_RECONNECT_SAVE_CHANGES

#define BROWSER_RECONNECT_SAVE_CHANGES BROWSER_ERROR | 0x0B

Definition at line 38 of file DisplayProtocol.h.

◆ BROWSER_SUBMIT_FAIL

#define BROWSER_SUBMIT_FAIL BROWSER_ERROR | 0x01

Definition at line 28 of file DisplayProtocol.h.

◆ BROWSER_SUBMIT_FAIL_NO_SUBMIT_IF

#define BROWSER_SUBMIT_FAIL_NO_SUBMIT_IF BROWSER_ERROR | 0x08

Definition at line 35 of file DisplayProtocol.h.

◆ BROWSER_SUCCESS

#define BROWSER_SUCCESS 0x0

Definition at line 26 of file DisplayProtocol.h.

◆ BROWSER_WARNING_IF

#define BROWSER_WARNING_IF BROWSER_ERROR | 0x07

Definition at line 34 of file DisplayProtocol.h.

◆ DISPLAY_QUESTION_OPTION_FROM_LINK

#define DISPLAY_QUESTION_OPTION_FROM_LINK ( a ) CR (a, DISPLAY_QUESTION_OPTION, Link, DISPLAY_QUESTION_OPTION_SIGNATURE)

Definition at line 72 of file DisplayProtocol.h.

◆ DISPLAY_QUESTION_OPTION_SIGNATURE

#define DISPLAY_QUESTION_OPTION_SIGNATURE SIGNATURE_32 ('Q', 'O', 'P', 'T')

Definition at line 56 of file DisplayProtocol.h.

◆ EDKII_FORM_DISPLAY_ENGINE_PROTOCOL_GUID

#define EDKII_FORM_DISPLAY_ENGINE_PROTOCOL_GUID { 0x9bbe29e9, 0xfda1, 0x41ec, { 0xad, 0x52, 0x45, 0x22, 0x13, 0x74, 0x2d, 0x2e } }

Definition at line 14 of file DisplayProtocol.h.

◆ FORM_DISPLAY_ENGINE_FORM_FROM_LINK

#define FORM_DISPLAY_ENGINE_FORM_FROM_LINK ( a ) CR (a, FORM_DISPLAY_ENGINE_FORM, Link, FORM_DISPLAY_ENGINE_FORM_SIGNATURE)

Definition at line 297 of file DisplayProtocol.h.

◆ FORM_DISPLAY_ENGINE_FORM_SIGNATURE

#define FORM_DISPLAY_ENGINE_FORM_SIGNATURE SIGNATURE_32 ('F', 'F', 'R', 'M')

Definition at line 224 of file DisplayProtocol.h.

◆ FORM_DISPLAY_ENGINE_STATEMENT_FROM_LINK

#define FORM_DISPLAY_ENGINE_STATEMENT_FROM_LINK ( a ) CR (a, FORM_DISPLAY_ENGINE_STATEMENT, DisplayLink, FORM_DISPLAY_ENGINE_STATEMENT_SIGNATURE)

Definition at line 202 of file DisplayProtocol.h.

◆ FORM_DISPLAY_ENGINE_STATEMENT_SIGNATURE

#define FORM_DISPLAY_ENGINE_STATEMENT_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'A')

Definition at line 135 of file DisplayProtocol.h.

◆ FORM_DISPLAY_ENGINE_STATEMENT_VERSION_1

#define FORM_DISPLAY_ENGINE_STATEMENT_VERSION_1 0x10000

Definition at line 40 of file DisplayProtocol.h.

◆ FORM_DISPLAY_ENGINE_VERSION_1

#define FORM_DISPLAY_ENGINE_VERSION_1 0x10000

Definition at line 41 of file DisplayProtocol.h.

◆ HII_DISPLAY_GRAYOUT

#define HII_DISPLAY_GRAYOUT BIT0

Definition at line 141 of file DisplayProtocol.h.

◆ HII_DISPLAY_LOCK

#define HII_DISPLAY_LOCK BIT1

Definition at line 142 of file DisplayProtocol.h.

◆ HII_DISPLAY_MODAL

#define HII_DISPLAY_MODAL BIT3

Definition at line 144 of file DisplayProtocol.h.

◆ HII_DISPLAY_NONE

#define HII_DISPLAY_NONE 0

Definition at line 140 of file DisplayProtocol.h.

◆ HII_DISPLAY_READONLY

#define HII_DISPLAY_READONLY BIT2

Definition at line 143 of file DisplayProtocol.h.

◆ HII_DISPLAY_SUPPRESS

#define HII_DISPLAY_SUPPRESS BIT4

Definition at line 145 of file DisplayProtocol.h.

◆ INCOSISTENT_IF_TRUE

#define INCOSISTENT_IF_TRUE STATEMENT_INVALID | 0x01

Definition at line 80 of file DisplayProtocol.h.

◆ STATEMENT_INVALID

#define STATEMENT_INVALID BIT31

Definition at line 78 of file DisplayProtocol.h.

◆ STATEMENT_VALID

#define STATEMENT_VALID 0x0

Definition at line 77 of file DisplayProtocol.h.

◆ STRING_TOO_LONG

#define STRING_TOO_LONG STATEMENT_INVALID | 0x03

Definition at line 82 of file DisplayProtocol.h.

◆ WARNING_IF_TRUE

#define WARNING_IF_TRUE STATEMENT_INVALID | 0x02

Definition at line 81 of file DisplayProtocol.h.

Typedef Documentation

◆ CONFIRM_DATA_CHANGE

typedef UINTN(EFIAPI * CONFIRM_DATA_CHANGE) (VOID)

Confirm how to handle the changed data.

Returns: Action of Submit, Discard and None

Definition at line 340 of file DisplayProtocol.h.

◆ EXIT_DISPLAY

typedef VOID(EFIAPI * EXIT_DISPLAY) (VOID)

Exit Display and Clear Screen to the original state.

Definition at line 329 of file DisplayProtocol.h.

◆ FORM_DISPLAY

typedef EFI_STATUS(EFIAPI * FORM_DISPLAY) (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.

Definition at line 318 of file DisplayProtocol.h.

◆ FORM_DISPLAY_ENGINE_FORM

typedef struct _FORM_DISPLAY_ENGINE_FORM FORM_DISPLAY_ENGINE_FORM

Definition at line 75 of file DisplayProtocol.h.

◆ FORM_DISPLAY_ENGINE_STATEMENT

typedef struct _FORM_DISPLAY_ENGINE_STATEMENT FORM_DISPLAY_ENGINE_STATEMENT

Definition at line 74 of file DisplayProtocol.h.

◆ PASSWORD_CHECK

typedef EFI_STATUS(EFIAPI * PASSWORD_CHECK) (IN FORM_DISPLAY_ENGINE_FORM *Form, IN FORM_DISPLAY_ENGINE_STATEMENT *Statement, IN EFI_STRING PasswordString OPTIONAL)

Perform Password check. Passwork may be encrypted by driver that requires the specific check.

Parameters

Form	Form where Password Statement is in.
Statement	Password statement
PasswordString	Password string to be checked. It may be NULL. NULL means to restore password. "" string can be used to checked whether old password does exist.

Returns: Status Status of Password check.

Definition at line 128 of file DisplayProtocol.h.

◆ VALIDATE_QUESTION

typedef UINT32(EFIAPI * VALIDATE_QUESTION) (IN FORM_DISPLAY_ENGINE_FORM *Form, IN FORM_DISPLAY_ENGINE_STATEMENT *Statement, IN EFI_HII_VALUE *Value, OUT STATEMENT_ERROR_INFO *ErrorInfo)

Perform value check for a question.

Parameters

Form	Form where Statement is in.
Statement	Value will check for it.
Value	New value will be checked.

Return values

Status Value Status

Definition at line 107 of file DisplayProtocol.h.

Data Structures

Macros

Typedefs

Variables

Detailed Description

Macro Definition Documentation

◆ BROWSER_ACTION_FORM_EXIT

◆ BROWSER_ACTION_NONE

◆ BROWSER_ERROR

◆ BROWSER_FORM_NOT_FOUND

◆ BROWSER_FORM_SUPPRESS

◆ BROWSER_HOT_KEY_FROM_LINK

◆ BROWSER_HOT_KEY_SIGNATURE

◆ BROWSER_INCONSISTENT_IF

◆ BROWSER_NO_SUBMIT_IF

◆ BROWSER_PROTOCOL_NOT_FOUND

◆ BROWSER_RECONNECT_FAIL

◆ BROWSER_RECONNECT_REQUIRED

◆ BROWSER_RECONNECT_SAVE_CHANGES

◆ BROWSER_SUBMIT_FAIL

◆ BROWSER_SUBMIT_FAIL_NO_SUBMIT_IF

◆ BROWSER_SUCCESS

◆ BROWSER_WARNING_IF

◆ DISPLAY_QUESTION_OPTION_FROM_LINK

◆ DISPLAY_QUESTION_OPTION_SIGNATURE

◆ EDKII_FORM_DISPLAY_ENGINE_PROTOCOL_GUID

◆ FORM_DISPLAY_ENGINE_FORM_FROM_LINK

◆ FORM_DISPLAY_ENGINE_FORM_SIGNATURE

◆ FORM_DISPLAY_ENGINE_STATEMENT_FROM_LINK

◆ FORM_DISPLAY_ENGINE_STATEMENT_SIGNATURE

◆ FORM_DISPLAY_ENGINE_STATEMENT_VERSION_1

◆ FORM_DISPLAY_ENGINE_VERSION_1

◆ HII_DISPLAY_GRAYOUT

◆ HII_DISPLAY_LOCK

◆ HII_DISPLAY_MODAL

◆ HII_DISPLAY_NONE

◆ HII_DISPLAY_READONLY

◆ HII_DISPLAY_SUPPRESS

◆ INCOSISTENT_IF_TRUE

◆ STATEMENT_INVALID

◆ STATEMENT_VALID

◆ STRING_TOO_LONG

◆ WARNING_IF_TRUE

Typedef Documentation

◆ CONFIRM_DATA_CHANGE

◆ EXIT_DISPLAY

◆ FORM_DISPLAY

◆ FORM_DISPLAY_ENGINE_FORM

◆ FORM_DISPLAY_ENGINE_STATEMENT

◆ PASSWORD_CHECK

◆ VALIDATE_QUESTION