FormBrowserEx2.h File Reference

Data Structures
struct	FORM_ENTRY_INFO
struct	QUESTION_ATTRIBUTE_OVERRIDE
struct	_EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL

Macros
#define	EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL_GUID   { 0xa770c357, 0xb693, 0x4e6d, { 0xa6, 0xcf, 0xd2, 0x1c, 0x72, 0x8e, 0x55, 0xb }}
#define	BROWSER_EXTENSION2_VERSION_1   0x10000
#define	BROWSER_EXTENSION2_VERSION_1_1   0x10001
#define	FORM_ENTRY_INFO_SIGNATURE   SIGNATURE_32 ('f', 'e', 'i', 's')
#define	FORM_ENTRY_INFO_FROM_LINK(a)   CR (a, FORM_ENTRY_INFO, Link, FORM_ENTRY_INFO_SIGNATURE)
#define	FORM_QUESTION_ATTRIBUTE_OVERRIDE_SIGNATURE   SIGNATURE_32 ('f', 'q', 'o', 's')
#define	FORM_QUESTION_ATTRIBUTE_OVERRIDE_FROM_LINK(a)   CR (a, QUESTION_ATTRIBUTE_OVERRIDE, Link, FORM_QUESTION_ATTRIBUTE_OVERRIDE_SIGNATURE)

Typedefs
typedef struct _EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL	EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL
typedef IN UINT16	DefaultId

Functions
typedef	BOOLEAN (EFIAPI *IS_BROWSER_DATA_MODIFIED)(VOID)
typedef	EFI_STATUS (EFIAPI *EXECUTE_ACTION)(IN UINT32 Action

Variables
EFI_GUID	gEdkiiFormBrowserEx2ProtocolGuid

Detailed Description

Extension Form Browser Protocol provides the services that can be used to register the different hot keys for the standard Browser actions described in UEFI specification.

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

Macro Definition Documentation

#define BROWSER_EXTENSION2_VERSION_1   0x10000

#define BROWSER_EXTENSION2_VERSION_1_1   0x10001

#define EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL_GUID   { 0xa770c357, 0xb693, 0x4e6d, { 0xa6, 0xcf, 0xd2, 0x1c, 0x72, 0x8e, 0x55, 0xb }}

#define FORM_ENTRY_INFO_FROM_LINK

(

a

)

CR (a, FORM_ENTRY_INFO, Link, FORM_ENTRY_INFO_SIGNATURE)

#define FORM_ENTRY_INFO_SIGNATURE   SIGNATURE_32 ('f', 'e', 'i', 's')

#define FORM_QUESTION_ATTRIBUTE_OVERRIDE_FROM_LINK

(

a

)

CR (a, QUESTION_ATTRIBUTE_OVERRIDE, Link, FORM_QUESTION_ATTRIBUTE_OVERRIDE_SIGNATURE)

#define FORM_QUESTION_ATTRIBUTE_OVERRIDE_SIGNATURE   SIGNATURE_32 ('f', 'q', 'o', 's')

Typedef Documentation

typedef IN UINT16 DefaultId

typedef struct _EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL

Function Documentation

typedef BOOLEAN

(

EFIAPI *

EDKII_PECOFF_IMAGE_EMULATOR_IS_IMAGE_SUPPORTED

)

Check whether the browser data has been modified.

Return values

TRUE	Browser data is modified.
FALSE	No browser data is modified.

Check whether required reset when exit the browser

Return values

TRUE	Browser required to reset after exit.
FALSE	Browser not need to reset after exit.

This function is to check if the remaining variable space is enough to set all Variables from argument list successfully. The purpose of the check is to keep the consistency of the Variables to be in variable storage.

Note: Variables are assumed to be in same storage. The set sequence of Variables will be same with the sequence of VariableEntry from argument list, so follow the argument sequence to check the Variables.

Parameters

[in]	Attributes	Variable attributes for Variable entries.
	...	The variable argument list with type VARIABLE_ENTRY_CONSISTENCY *. A NULL terminates the list. The VariableSize of VARIABLE_ENTRY_CONSISTENCY is the variable data size as input. It will be changed to variable total size as output.

Return values

TRUE	Have enough variable space to set the Variables successfully.
FALSE	No enough variable space to set the Variables successfully.

Check whether the emulator supports executing a certain PE/COFF image

Parameters

[in]	This	This pointer for EDKII_PECOFF_IMAGE_EMULATOR_PROTOCOL structure
[in]	ImageType	Whether the image is an application, a boot time driver or a runtime driver.
[in]	DevicePath	Path to device where the image originated (e.g., a PCI option ROM)

Return values

TRUE	The image is supported by the emulator
FALSE	The image is not supported by the emulator.

typedef EFI_STATUS

(

EFIAPI *

EXECUTE_ACTION

)

Execute the action requested by the Action parameter.

Parameters

[in]	Action	Execute the request action.
[in]	DefaultId	The default Id info when need to load default value.

Return values

EFI_SUCCESS

Execute the request action succss.

Variable Documentation

EFI_GUID gEdkiiFormBrowserEx2ProtocolGuid