DisplayProtocol.h File Reference

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 IN FORM_DISPLAY_ENGINE_STATEMENT *	Statement
typedef IN FORM_DISPLAY_ENGINE_STATEMENT IN EFI_HII_VALUE *	Value
typedef IN FORM_DISPLAY_ENGINE_STATEMENT IN EFI_HII_VALUE OUT STATEMENT_ERROR_INFO *	ErrorInfo
typedef IN FORM_DISPLAY_ENGINE_STATEMENT IN EFI_STRING	PasswordString
typedef OUT USER_INPUT *	UserInputData

Functions
typedef	UINT32 (EFIAPI *VALIDATE_QUESTION)(IN FORM_DISPLAY_ENGINE_FORM *Form
typedef	EFI_STATUS (EFIAPI *PASSWORD_CHECK)(IN FORM_DISPLAY_ENGINE_FORM *Form
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

Macro Definition Documentation

#define BROWSER_ACTION_FORM_EXIT   BIT17

#define BROWSER_ACTION_NONE   BIT16

#define BROWSER_ERROR   BIT31

#define BROWSER_FORM_NOT_FOUND   BROWSER_ERROR | 0x03

#define BROWSER_FORM_SUPPRESS   BROWSER_ERROR | 0x04

#define BROWSER_HOT_KEY_FROM_LINK

(

a

)

CR (a, BROWSER_HOT_KEY, Link, BROWSER_HOT_KEY_SIGNATURE)

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

#define BROWSER_INCONSISTENT_IF   BROWSER_ERROR | 0x06

#define BROWSER_NO_SUBMIT_IF   BROWSER_ERROR | 0x02

#define BROWSER_PROTOCOL_NOT_FOUND   BROWSER_ERROR | 0x05

#define BROWSER_RECONNECT_FAIL   BROWSER_ERROR | 0x0A

#define BROWSER_RECONNECT_REQUIRED   BROWSER_ERROR | 0x09

#define BROWSER_RECONNECT_SAVE_CHANGES   BROWSER_ERROR | 0x0B

#define BROWSER_SUBMIT_FAIL   BROWSER_ERROR | 0x01

#define BROWSER_SUBMIT_FAIL_NO_SUBMIT_IF   BROWSER_ERROR | 0x08

#define BROWSER_SUCCESS   0x0

#define BROWSER_WARNING_IF   BROWSER_ERROR | 0x07

#define DISPLAY_QUESTION_OPTION_FROM_LINK

(

a

)

CR (a, DISPLAY_QUESTION_OPTION, Link, DISPLAY_QUESTION_OPTION_SIGNATURE)

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

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

#define FORM_DISPLAY_ENGINE_FORM_FROM_LINK

(

a

)

CR (a, FORM_DISPLAY_ENGINE_FORM, Link, FORM_DISPLAY_ENGINE_FORM_SIGNATURE)

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

#define FORM_DISPLAY_ENGINE_STATEMENT_FROM_LINK

(

a

)

CR (a, FORM_DISPLAY_ENGINE_STATEMENT, DisplayLink, FORM_DISPLAY_ENGINE_STATEMENT_SIGNATURE)

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

#define FORM_DISPLAY_ENGINE_STATEMENT_VERSION_1   0x10000

#define FORM_DISPLAY_ENGINE_VERSION_1   0x10000

#define HII_DISPLAY_GRAYOUT   BIT0

#define HII_DISPLAY_LOCK   BIT1

#define HII_DISPLAY_MODAL   BIT3

#define HII_DISPLAY_NONE   0

#define HII_DISPLAY_READONLY   BIT2

#define HII_DISPLAY_SUPPRESS   BIT4

#define INCOSISTENT_IF_TRUE   STATEMENT_INVALID | 0x01

#define STATEMENT_INVALID   BIT31

#define STATEMENT_VALID   0x0

#define STRING_TOO_LONG   STATEMENT_INVALID | 0x03

#define WARNING_IF_TRUE   STATEMENT_INVALID | 0x02

Typedef Documentation

typedef IN FORM_DISPLAY_ENGINE_STATEMENT IN EFI_HII_VALUE OUT STATEMENT_ERROR_INFO* ErrorInfo

typedef struct _FORM_DISPLAY_ENGINE_FORM FORM_DISPLAY_ENGINE_FORM

typedef struct _FORM_DISPLAY_ENGINE_STATEMENT FORM_DISPLAY_ENGINE_STATEMENT

typedef IN FORM_DISPLAY_ENGINE_STATEMENT IN EFI_STRING PasswordString

typedef IN FORM_DISPLAY_ENGINE_STATEMENT * Statement

typedef OUT USER_INPUT* UserInputData

typedef IN FORM_DISPLAY_ENGINE_STATEMENT IN EFI_HII_VALUE* Value

Function Documentation

typedef EFI_STATUS

(

EFIAPI *

FORM_DISPLAY

)

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.

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.

typedef UINT32

(

EFIAPI *

VALIDATE_QUESTION

)

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

typedef UINTN

(

EFIAPI *

CONFIRM_DATA_CHANGE

)

Confirm how to handle the changed data.

Returns

Action of Submit, Discard and None

typedef VOID

(

EFIAPI *

EBC_DEBUGGER_DEBUG

)

Exit Display and Clear Screen to the original state.

Given a pointer to a new VM context, debug one or more instructions.

Parameters

[in]	This	A pointer to the EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL structure.
[in]	VmPtr	A pointer to a VM context.

Return values

EFI_UNSUPPORTED	No support for it.
EFI_SUCCESS	Debug one or more instructions.

Variable Documentation

EFI_GUID gEdkiiFormDisplayEngineProtocolGuid