#include <Guid/HiiPlatformSetupFormset.h>

Data Structures
struct	EFI_SCREEN_DESCRIPTOR

struct	_EFI_FORM_BROWSER2_PROTOCOL

Macros
#define	EFI_FORM_BROWSER2_PROTOCOL_GUID {0xb9d4c360, 0xbcfb, 0x4f9b, {0x92, 0x98, 0x53, 0xc1, 0x36, 0x98, 0x22, 0x58 }}

#define	EFI_BROWSER_ACTION_REQUEST_NONE 0

#define	EFI_BROWSER_ACTION_REQUEST_RESET 1

#define	EFI_BROWSER_ACTION_REQUEST_SUBMIT 2

#define	EFI_BROWSER_ACTION_REQUEST_EXIT 3

#define	EFI_BROWSER_ACTION_REQUEST_FORM_SUBMIT_EXIT 4

#define	EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD_EXIT 5

#define	EFI_BROWSER_ACTION_REQUEST_FORM_APPLY 6

#define	EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD 7

#define	EFI_BROWSER_ACTION_REQUEST_RECONNECT 8

#define	EFI_BROWSER_ACTION_REQUEST_QUESTION_APPLY 9

Typedefs
typedef struct _EFI_FORM_BROWSER2_PROTOCOL	EFI_FORM_BROWSER2_PROTOCOL

typedef UINTN	EFI_BROWSER_ACTION_REQUEST

typedef EFI_STATUS(EFIAPI *	EFI_SEND_FORM2) (IN CONST EFI_FORM_BROWSER2_PROTOCOL This, IN EFI_HII_HANDLE Handle, IN UINTN HandleCount, IN EFI_GUID FormSetGuid OPTIONAL, IN EFI_FORM_ID FormId OPTIONAL, IN CONST EFI_SCREEN_DESCRIPTOR ScreenDimensions OPTIONAL, OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest OPTIONAL)

typedef EFI_STATUS(EFIAPI *	EFI_BROWSER_CALLBACK2) (IN CONST EFI_FORM_BROWSER2_PROTOCOL This, IN OUT UINTN ResultsDataSize, IN OUT EFI_STRING ResultsData, IN CONST BOOLEAN RetrieveData, IN CONST EFI_GUID VariableGuid OPTIONAL, IN CONST CHAR16 VariableName OPTIONAL)

Variables
EFI_GUID	gEfiFormBrowser2ProtocolGuid

Detailed Description

This protocol is defined in UEFI spec.

The EFI_FORM_BROWSER2_PROTOCOL is the interface to call for drivers to leverage the EFI configuration driver interface.

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

Definition in file FormBrowser2.h.

Macro Definition Documentation

◆ EFI_BROWSER_ACTION_REQUEST_EXIT

#define EFI_BROWSER_ACTION_REQUEST_EXIT 3

Definition at line 52 of file FormBrowser2.h.

◆ EFI_BROWSER_ACTION_REQUEST_FORM_APPLY

#define EFI_BROWSER_ACTION_REQUEST_FORM_APPLY 6

Definition at line 55 of file FormBrowser2.h.

◆ EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD

#define EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD 7

Definition at line 56 of file FormBrowser2.h.

◆ EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD_EXIT

#define EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD_EXIT 5

Definition at line 54 of file FormBrowser2.h.

◆ EFI_BROWSER_ACTION_REQUEST_FORM_SUBMIT_EXIT

#define EFI_BROWSER_ACTION_REQUEST_FORM_SUBMIT_EXIT 4

Definition at line 53 of file FormBrowser2.h.

◆ EFI_BROWSER_ACTION_REQUEST_NONE

#define EFI_BROWSER_ACTION_REQUEST_NONE 0

Definition at line 49 of file FormBrowser2.h.

◆ EFI_BROWSER_ACTION_REQUEST_QUESTION_APPLY

#define EFI_BROWSER_ACTION_REQUEST_QUESTION_APPLY 9

Definition at line 58 of file FormBrowser2.h.

◆ EFI_BROWSER_ACTION_REQUEST_RECONNECT

#define EFI_BROWSER_ACTION_REQUEST_RECONNECT 8

Definition at line 57 of file FormBrowser2.h.

◆ EFI_BROWSER_ACTION_REQUEST_RESET

#define EFI_BROWSER_ACTION_REQUEST_RESET 1

Definition at line 50 of file FormBrowser2.h.

◆ EFI_BROWSER_ACTION_REQUEST_SUBMIT

#define EFI_BROWSER_ACTION_REQUEST_SUBMIT 2

Definition at line 51 of file FormBrowser2.h.

◆ EFI_FORM_BROWSER2_PROTOCOL_GUID

#define EFI_FORM_BROWSER2_PROTOCOL_GUID {0xb9d4c360, 0xbcfb, 0x4f9b, {0x92, 0x98, 0x53, 0xc1, 0x36, 0x98, 0x22, 0x58 }}

Definition at line 17 of file FormBrowser2.h.

Typedef Documentation

◆ EFI_BROWSER_ACTION_REQUEST

typedef UINTN EFI_BROWSER_ACTION_REQUEST

Definition at line 47 of file FormBrowser2.h.

◆ EFI_BROWSER_CALLBACK2

typedef EFI_STATUS(EFIAPI * EFI_BROWSER_CALLBACK2) (IN CONST EFI_FORM_BROWSER2_PROTOCOL *This, IN OUT UINTN *ResultsDataSize, IN OUT EFI_STRING ResultsData, IN CONST BOOLEAN RetrieveData, IN CONST EFI_GUID *VariableGuid OPTIONAL, IN CONST CHAR16 *VariableName OPTIONAL)

This function is called by a callback handler to retrieve uncommitted state data from the browser.

This routine is called by a routine which was called by the browser. This routine called this service in the browser to retrieve or set certain uncommitted state information.

Parameters

This	A pointer to the EFI_FORM_BROWSER2_PROTOCOL instance.
ResultsDataSize	A pointer to the size of the buffer associated with ResultsData. On input, the size in bytes of ResultsData. On output, the size of data returned in ResultsData.
ResultsData	A string returned from an IFR browser or equivalent. The results string will have no routing information in them.
RetrieveData	A BOOLEAN field which allows an agent to retrieve (if RetrieveData = TRUE) data from the uncommitted browser state information or set (if RetrieveData = FALSE) data in the uncommitted browser state information.
VariableGuid	An optional field to indicate the target variable GUID name to use.
VariableName	An optional field to indicate the target human-readable variable name.

Return values

EFI_SUCCESS	The results have been distributed or are awaiting distribution.
EFI_BUFFER_TOO_SMALL	The ResultsDataSize specified was too small to contain the results data.
EFI_UNSUPPORTED	Uncommitted browser state is not available at the current stage of execution.

Definition at line 151 of file FormBrowser2.h.

◆ EFI_FORM_BROWSER2_PROTOCOL

typedef struct _EFI_FORM_BROWSER2_PROTOCOL EFI_FORM_BROWSER2_PROTOCOL

Definition at line 20 of file FormBrowser2.h.

◆ EFI_SEND_FORM2

typedef EFI_STATUS(EFIAPI * EFI_SEND_FORM2) (IN CONST EFI_FORM_BROWSER2_PROTOCOL *This, IN EFI_HII_HANDLE *Handle, IN UINTN HandleCount, IN EFI_GUID *FormSetGuid OPTIONAL, IN EFI_FORM_ID FormId OPTIONAL, IN CONST EFI_SCREEN_DESCRIPTOR *ScreenDimensions OPTIONAL, OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest OPTIONAL)

Initialize the browser to display the specified configuration forms.

This function is the primary interface to the internal forms-based browser. The forms browser will display forms associated with the specified Handles. The browser will select all forms in packages which have the specified Type and (for EFI_HII_PACKAGE_TYPE_GUID) the specified PackageGuid.