MdePkg/Include/Protocol/FormBrowser2.h

   1 /** @file
   2   This protocol is defined in UEFI spec.
   3
   4   The EFI_FORM_BROWSER2_PROTOCOL is the interface to call for drivers to
   5   leverage the EFI configuration driver interface.
   6
   7 Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
   8 This program and the accompanying materials are licensed and made available under
   9 the terms and conditions of the BSD License that accompanies this distribution.
  10 The full text of the license may be found at
  11 http://opensource.org/licenses/bsd-license.php.
  12
  13 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  14 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  15
  16 **/
  17
  18 #ifndef __EFI_FORM_BROWSER2_H__
  19 #define __EFI_FORM_BROWSER2_H__
  20
  21 #include <Guid/HiiPlatformSetupFormset.h>
  22
  23 #define EFI_FORM_BROWSER2_PROTOCOL_GUID \
  24   {0xb9d4c360, 0xbcfb, 0x4f9b, {0x92, 0x98, 0x53, 0xc1, 0x36, 0x98, 0x22, 0x58 }}
  25
  26
  27 typedef struct _EFI_FORM_BROWSER2_PROTOCOL   EFI_FORM_BROWSER2_PROTOCOL;
  28
  29
  30
  31 /**
  32
  33   @param LeftColumn   The value that designates the text column
  34                       where the browser window will begin from
  35                       the left-hand side of the screen
  36
  37   @param RightColumn  The value that designates the text
  38                       column where the browser window will end
  39                       on the right-hand side of the screen.
  40
  41   @param TopRow       The value that designates the text row from the
  42                       top of the screen where the browser window
  43                       will start.
  44
  45   @param BottomRow    The value that designates the text row from the
  46                       bottom of the screen where the browser
  47                       window will end.
  48 **/
  49 typedef struct {
  50   UINTN   LeftColumn;
  51   UINTN   RightColumn;
  52   UINTN   TopRow;
  53   UINTN   BottomRow;
  54 } EFI_SCREEN_DESCRIPTOR;
  55
  56 typedef UINTN EFI_BROWSER_ACTION_REQUEST;
  57
  58 #define EFI_BROWSER_ACTION_REQUEST_NONE   0
  59 #define EFI_BROWSER_ACTION_REQUEST_RESET  1
  60 #define EFI_BROWSER_ACTION_REQUEST_SUBMIT 2
  61 #define EFI_BROWSER_ACTION_REQUEST_EXIT   3
  62
  63
  64 /**
  65   Initialize the browser to display the specified configuration forms.
  66
  67   This function is the primary interface to the internal forms-based browser.
  68   The forms browser will display forms associated with the specified Handles.
  69   The browser will select all forms in packages which have the specified Type
  70   and (for EFI_HII_PACKAGE_TYPE_GUID) the specified PackageGuid.
  71
  72   @param This            A pointer to the EFI_FORM_BROWSER2_PROTOCOL instance
  73
  74   @param Handles         A pointer to an array of Handles. This value should correspond
  75                          to the value of the HII form package that is required to be displayed.
  76
  77   @param HandleCount     The number of Handles specified in Handle.
  78
  79   @param FormSetGuid     This field points to the EFI_GUID which must match the Guid field or one of the
  80                          elements of the ClassId field  in the EFI_IFR_FORM_SET op-code.  If
  81                          FormsetGuid is NULL, then this function will display the the form set class
  82                          EFI_HII_PLATFORM_SETUP_FORMSET_GUID.
  83
  84   @param FormId          This field specifies the identifier of the form within the form set to render as the first
  85                          displayable page. If this field has a value of 0x0000, then the Forms Browser will
  86                          render the first enabled form in the form set.
  87
  88   @param ScreenDimensions Points to recommended form dimensions, including any non-content area, in
  89                           characters.
  90
  91   @param ActionRequest   Points to the action recommended by the form.
  92
  93   @retval EFI_SUCCESS           The function completed successfully
  94
  95   @retval EFI_NOT_FOUND         The variable was not found.
  96
  97   @retval EFI_INVALID_PARAMETER One of the parameters has an
  98                                 invalid value.
  99 **/
 100 typedef
 101 EFI_STATUS
 102 (EFIAPI *EFI_SEND_FORM2)(
 103   IN CONST  EFI_FORM_BROWSER2_PROTOCOL  *This,
 104   IN        EFI_HII_HANDLE              *Handle,
 105   IN        UINTN                      HandleCount,
 106   IN        EFI_GUID                   *FormSetGuid, OPTIONAL
 107   IN        EFI_FORM_ID                FormId, OPTIONAL
 108   IN CONST  EFI_SCREEN_DESCRIPTOR      *ScreenDimensions, OPTIONAL
 109   OUT       EFI_BROWSER_ACTION_REQUEST *ActionRequest  OPTIONAL
 110 );
 111
 112
 113 /**
 114   This function is called by a callback handler to retrieve uncommitted state data from the browser.
 115
 116   This routine is called by a routine which was called by the
 117   browser. This routine called this service in the browser to
 118   retrieve or set certain uncommitted state information.
 119
 120   @param This           A pointer to the EFI_FORM_BROWSER2_PROTOCOL instance.
 121
 122   @param ResultsDataSize  A pointer to the size of the buffer
 123                           associated with ResultsData. On input, the size in
 124                           bytes of ResultsData. On output, the size of data
 125                           returned in ResultsData.
 126
 127   @param ResultsData    A string returned from an IFR browser or
 128                         equivalent. The results string will have
 129                         no routing information in them.
 130
 131   @param RetrieveData   A BOOLEAN field which allows an agent to
 132                         retrieve (if RetrieveData = TRUE) data
 133                         from the uncommitted browser state
 134                         information or set (if RetrieveData =
 135                         FALSE) data in the uncommitted browser
 136                         state information.
 137
 138   @param VariableGuid   An optional field to indicate the target
 139                         variable GUID name to use.
 140
 141   @param VariableName   An optional field to indicate the target
 142                         human-readable variable name.
 143
 144   @retval EFI_SUCCESS           The results have been distributed or are
 145                                 awaiting distribution.
 146
 147   @retval EFI_OUT_OF_RESOURCES  The ResultsDataSize specified
 148                                 was too small to contain the
 149                                 results data.
 150
 151 **/
 152 typedef
 153 EFI_STATUS
 154 (EFIAPI *EFI_BROWSER_CALLBACK2)(
 155   IN CONST  EFI_FORM_BROWSER2_PROTOCOL *This,
 156   IN OUT    UINTN                     *ResultsDataSize,
 157   IN OUT    EFI_STRING                ResultsData,
 158   IN CONST  BOOLEAN                   RetrieveData,
 159   IN CONST  EFI_GUID                  *VariableGuid, OPTIONAL
 160   IN CONST  CHAR16                    *VariableName OPTIONAL
 161 );
 162
 163 ///
 164 /// This interface will allow the caller to direct the configuration
 165 /// driver to use either the HII database or use the passed-in packet of data.
 166 ///
 167 struct _EFI_FORM_BROWSER2_PROTOCOL {
 168   EFI_SEND_FORM2         SendForm;
 169   EFI_BROWSER_CALLBACK2  BrowserCallback;
 170 } ;
 171
 172 extern EFI_GUID gEfiFormBrowser2ProtocolGuid;
 173
 174 #endif
 175