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