iPXE
Data Structures | Defines | Typedefs | Functions | Variables
FormBrowser2.h File Reference

This protocol is defined in UEFI spec. More...

#include <ipxe/efi/Guid/HiiPlatformSetupFormset.h>

Go to the source code of this file.

Data Structures

struct  EFI_SCREEN_DESCRIPTOR
struct  _EFI_FORM_BROWSER2_PROTOCOL
 This interface will allow the caller to direct the configuration driver to use either the HII database or use the passed-in packet of data. More...

Defines

#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

Typedefs

typedef struct
_EFI_FORM_BROWSER2_PROTOCOL 
EFI_FORM_BROWSER2_PROTOCOL
typedef UINTN EFI_BROWSER_ACTION_REQUEST
typedef EFI_STATUS(EFIAPIEFI_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.
typedef EFI_STATUS(EFIAPIEFI_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.

Functions

 FILE_LICENCE (BSD3)

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 - 2015, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Definition in file FormBrowser2.h.


Define Documentation

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

Definition at line 25 of file FormBrowser2.h.

Definition at line 60 of file FormBrowser2.h.

Definition at line 61 of file FormBrowser2.h.

Definition at line 62 of file FormBrowser2.h.

Definition at line 63 of file FormBrowser2.h.

Definition at line 64 of file FormBrowser2.h.

Definition at line 65 of file FormBrowser2.h.

Definition at line 66 of file FormBrowser2.h.

Definition at line 67 of file FormBrowser2.h.

Definition at line 68 of file FormBrowser2.h.


Typedef Documentation

Definition at line 29 of file FormBrowser2.h.

Definition at line 58 of file FormBrowser2.h.

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.

Parameters:
ThisA pointer to the EFI_FORM_BROWSER2_PROTOCOL instance
HandlesA pointer to an array of Handles. This value should correspond to the value of the HII form package that is required to be displayed.
HandleCountThe number of Handles specified in Handle.
FormSetGuidThis field points to the EFI_GUID which must match the Guid field or one of the elements of the ClassId field in the EFI_IFR_FORM_SET op-code. If FormsetGuid is NULL, then this function will display the form set class EFI_HII_PLATFORM_SETUP_FORMSET_GUID.
FormIdThis field specifies the identifier of the form within the form set to render as the first displayable page. If this field has a value of 0x0000, then the Forms Browser will render the first enabled form in the form set.
ScreenDimensionsPoints to recommended form dimensions, including any non-content area, in characters.
ActionRequestPoints to the action recommended by the form.
Return values:
EFI_SUCCESSThe function completed successfully
EFI_NOT_FOUNDThe variable was not found.
EFI_INVALID_PARAMETEROne of the parameters has an invalid value.

Definition at line 109 of file FormBrowser2.h.

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:
ThisA pointer to the EFI_FORM_BROWSER2_PROTOCOL instance.
ResultsDataSizeA 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.
ResultsDataA string returned from an IFR browser or equivalent. The results string will have no routing information in them.
RetrieveDataA 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.
VariableGuidAn optional field to indicate the target variable GUID name to use.
VariableNameAn optional field to indicate the target human-readable variable name.
Return values:
EFI_SUCCESSThe results have been distributed or are awaiting distribution.
EFI_OUT_OF_RESOURCESThe ResultsDataSize specified was too small to contain the results data.

Definition at line 161 of file FormBrowser2.h.


Function Documentation

FILE_LICENCE ( BSD3  )

Variable Documentation