IntelFrameworkPkg/Include/Protocol/FrameworkFormBrowser.h File Reference


Data Structures

struct  EFI_HII_PACKET
struct  EFI_IFR_PACKET
struct  FRAMEWORK_EFI_SCREEN_DESCRIPTOR
struct  _EFI_FORM_BROWSER_PROTOCOL

Defines

#define EFI_FORM_BROWSER_PROTOCOL_GUID
#define EFI_FORM_BROWSER_COMPATIBILITY_PROTOCOL_GUID

Typedefs

typedef struct
_EFI_FORM_BROWSER_PROTOCOL 
EFI_FORM_BROWSER_PROTOCOL
typedef EFI_STATUS(EFIAPI * EFI_SEND_FORM )(IN EFI_FORM_BROWSER_PROTOCOL *This, IN BOOLEAN UseDatabase, IN FRAMEWORK_EFI_HII_HANDLE *Handle, IN UINTN HandleCount, IN EFI_IFR_PACKET *Packet, IN EFI_HANDLE CallbackHandle, IN UINT8 *NvMapOverride, IN FRAMEWORK_EFI_SCREEN_DESCRIPTOR *ScreenDimensions, OUT BOOLEAN *ResetRequired)
typedef EFI_STATUS(EFIAPI * EFI_CREATE_POP_UP )(IN UINTN NumberOfLines, IN BOOLEAN HotKey, IN UINTN MaximumStringSize, OUT CHAR16 *StringBuffer, OUT EFI_INPUT_KEY *KeyValue, IN CHAR16 *String,...)

Variables

EFI_GUID gEfiFormBrowserProtocolGuid
EFI_GUID gEfiFormBrowserCompatibilityProtocolGuid

Detailed Description

The EFI_FORM_BROWSER_PROTOCOL is the interface to the EFI Configuration Driver. This interface enables the caller to direct the configuration driver to use either the HII database or the passed-in packet of data. This will also allow the caller to post messages into the configuration drivers internal mailbox.

Copyright (c) 2006 - 2010, 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.

Module Name: FrameworkFormBrowser.h

Revision Reference:
This protocol is defined in HII spec 0.92.

Define Documentation

#define EFI_FORM_BROWSER_COMPATIBILITY_PROTOCOL_GUID

Value:

{ \
    0xfb7c852, 0xadca, 0x4853, { 0x8d, 0xf, 0xfb, 0xa7, 0x1b, 0x1c, 0xe1, 0x1a } \
  }

#define EFI_FORM_BROWSER_PROTOCOL_GUID

Value:

{ \
    0xe5a1333e, 0xe1b4, 0x4d55, {0xce, 0xeb, 0x35, 0xc3, 0xef, 0x13, 0x34, 0x43 } \
  }


Typedef Documentation

typedef EFI_STATUS(EFIAPI * EFI_CREATE_POP_UP)(IN UINTN NumberOfLines, IN BOOLEAN HotKey, IN UINTN MaximumStringSize, OUT CHAR16 *StringBuffer, OUT EFI_INPUT_KEY *KeyValue, IN CHAR16 *String,...)

Routine used to abstract a generic dialog interface and return the selected key or string.

Parameters:
NumberOfLines The number of lines for the dialog box.
HotKey Defines whether a single character is parsed (TRUE) and returned in KeyValue, or if a string is returned in StringBuffer.
MaximumStringSize The maximum size in bytes of a typed-in string. Because each character is a CHAR16, the minimum string returned is two bytes.
StringBuffer The passed-in pointer to the buffer that will hold the typed in string if HotKey is FALSE.
KeyValue The EFI_INPUT_KEY value returned if HotKey is TRUE.
String The pointer to the first string in the list of strings that comprise the dialog box.
... A series of NumberOfLines text strings that will be used to construct the dialog box.
Return values:
EFI_SUCCESS The dialog was displayed and user interaction was received.
EFI_DEVICE_ERROR The user typed in an ESC character to exit the routine.
EFI_INVALID_PARAMETER One of the parameters was invalid

typedef EFI_STATUS(EFIAPI * EFI_SEND_FORM)(IN EFI_FORM_BROWSER_PROTOCOL *This, IN BOOLEAN UseDatabase, IN FRAMEWORK_EFI_HII_HANDLE *Handle, IN UINTN HandleCount, IN EFI_IFR_PACKET *Packet, IN EFI_HANDLE CallbackHandle, IN UINT8 *NvMapOverride, IN FRAMEWORK_EFI_SCREEN_DESCRIPTOR *ScreenDimensions, OUT BOOLEAN *ResetRequired)

Provides direction to the configuration driver whether to use the HII database or a passed-in set of data. This function also establishes a pointer to the calling driver's callback interface.

Parameters:
This A pointer to the EFI_FORM_BROWSER_PROTOCOL instance.
UseDatabase Determines whether the HII database is to be used to gather information. If the value is FALSE, the configuration driver will get the information provided in the passed-in Packet parameters.
Handle A pointer to an array of HII handles to display. This value should correspond to the value of the HII form package that is required to be displayed.
HandleCount The number of handles in the array specified by Handle.
Packet A pointer to a set of data containing pointers to IFR and/or string data.
CallbackHandle The handle to the driver's callback interface. This parameter is used only when the UseDatabase parameter is FALSE and an application wants to register a callback with the browser.
NvMapOverride This buffer is used only when there is no NV variable to define the current settings and the caller needs to provide to the browser the current settings for the "fake" NV variable.
ScreenDimensions Allows the browser to be called so that it occupies a portion of the physical screen instead of dynamically determining the screen dimensions.
ResetRequired This BOOLEAN value denotes whether a reset is required based on the data that might have been changed. The ResetRequired parameter is primarily applicable for configuration applications, and is an optional parameter.
Return values:
EFI_SUCCESS The function completed successfully.
EFI_NOT_FOUND The variable was not found.
EFI_BUFFER_TOO_SMALL The DataSize is too small for the result. DataSize has been updated with the size needed to complete the request.
EFI_INVALID_PARAMETER One of the parameters has an invalid value.
EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure.


Variable Documentation


Generated on Wed Sep 2 13:08:33 2015 for IntelFrameworkPkg[ALL] by  doxygen 1.5.7.1