MdeModulePkg/Application/UiApp/FrontPage.h

   1 /** @file
   2   FrontPage routines to handle the callbacks and browser calls
   3
   4 Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>
   5 This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef _FRONT_PAGE_H_
  16 #define _FRONT_PAGE_H_
  17
  18 #include "DeviceMngr/DeviceManager.h"
  19 #include "BootMaint/BootMaint.h"
  20 #include "BootMngr/BootManager.h"
  21 #include "String.h"
  22
  23 #include <Protocol/BootLogo.h>
  24 //
  25 // These are the VFR compiler generated data representing our VFR data.
  26 //
  27 extern UINT8  FrontPageVfrBin[];
  28
  29 extern EFI_FORM_BROWSER2_PROTOCOL      *gFormBrowser2;
  30
  31 extern BOOLEAN  gConnectAllHappened;
  32
  33 #define SMBIOS_TYPE4_CPU_SOCKET_POPULATED BIT6
  34
  35 ///
  36 /// The size of a 3 character ISO639 language code.
  37 ///
  38 #define ISO_639_2_ENTRY_SIZE   3
  39
  40 //
  41 // This is the VFR compiler generated header file which defines the
  42 // string identifiers.
  43 //
  44 #define PRINTABLE_LANGUAGE_NAME_STRING_ID     0x0001
  45
  46 //
  47 // These are defined as the same with vfr file
  48 //
  49 #define FRONT_PAGE_FORM_ID             0x1000
  50 #define INVALID_FORM_ID                0x0FFF
  51
  52 #define FRONT_PAGE_KEY_SECTION         0x1000
  53 #define FRONT_PAGE_KEY_OFFSET          0x4000
  54 #define FRONT_PAGE_KEY_CONTINUE        0x1000
  55 #define FRONT_PAGE_KEY_LANGUAGE        0x1234
  56 #define FRONT_PAGE_KEY_BOOT_MANAGER    0x1064
  57 #define FRONT_PAGE_KEY_DEVICE_MANAGER  0x8567
  58 #define FRONT_PAGE_KEY_BOOT_MAINTAIN   0x9876
  59
  60 #define LABEL_SELECT_LANGUAGE          0x1000
  61 #define LABEL_PLATFORM_INFORMATION     0x1001
  62 #define LABEL_END                      0xffff
  63
  64 #define FRONT_PAGE_FORMSET_GUID \
  65   { \
  66     0x9e0c30bc, 0x3f06, 0x4ba6, {0x82, 0x88, 0x9, 0x17, 0x9b, 0x85, 0x5d, 0xbe} \
  67   }
  68
  69 #define FRONT_PAGE_CALLBACK_DATA_SIGNATURE  SIGNATURE_32 ('F', 'P', 'C', 'B')
  70
  71 typedef struct {
  72   UINTN                           Signature;
  73
  74   //
  75   // HII relative handles
  76   //
  77   EFI_HII_HANDLE                  HiiHandle;
  78   EFI_HANDLE                      DriverHandle;
  79   EFI_STRING_ID                   *LanguageToken;
  80
  81   //
  82   // Produced protocols
  83   //
  84   EFI_HII_CONFIG_ACCESS_PROTOCOL  ConfigAccess;
  85 } FRONT_PAGE_CALLBACK_DATA;
  86
  87
  88 #define EFI_FP_CALLBACK_DATA_FROM_THIS(a) \
  89   CR (a, \
  90       FRONT_PAGE_CALLBACK_DATA, \
  91       ConfigAccess, \
  92       FRONT_PAGE_CALLBACK_DATA_SIGNATURE \
  93       )
  94
  95 /**
  96   This function allows a caller to extract the current configuration for one
  97   or more named elements from the target driver.
  98
  99
 100   @param This            - Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
 101   @param Request         - A null-terminated Unicode string in <ConfigRequest> format.
 102   @param Progress        - On return, points to a character in the Request string.
 103                          Points to the string's null terminator if request was successful.
 104                          Points to the most recent '&' before the first failing name/value
 105                          pair (or the beginning of the string if the failure is in the
 106                          first name/value pair) if the request was not successful.
 107   @param Results         - A null-terminated Unicode string in <ConfigAltResp> format which
 108                          has all values filled in for the names in the Request string.
 109                          String to be allocated by the called function.
 110
 111   @retval  EFI_SUCCESS            The Results is filled with the requested values.
 112   @retval  EFI_OUT_OF_RESOURCES   Not enough memory to store the results.
 113   @retval  EFI_INVALID_PARAMETER  Request is NULL, illegal syntax, or unknown name.
 114   @retval  EFI_NOT_FOUND          Routing data doesn't match any storage in this driver.
 115
 116 **/
 117 EFI_STATUS
 118 EFIAPI
 119 FakeExtractConfig (
 120   IN  CONST EFI_HII_CONFIG_ACCESS_PROTOCOL   *This,
 121   IN  CONST EFI_STRING                       Request,
 122   OUT EFI_STRING                             *Progress,
 123   OUT EFI_STRING                             *Results
 124   );
 125
 126 /**
 127   This function processes the results of changes in configuration.
 128
 129
 130   @param This            - Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
 131   @param Configuration   - A null-terminated Unicode string in <ConfigResp> format.
 132   @param Progress        - A pointer to a string filled in with the offset of the most
 133                          recent '&' before the first failing name/value pair (or the
 134                          beginning of the string if the failure is in the first
 135                          name/value pair) or the terminating NULL if all was successful.
 136
 137   @retval  EFI_SUCCESS            The Results is processed successfully.
 138   @retval  EFI_INVALID_PARAMETER  Configuration is NULL.
 139   @retval  EFI_NOT_FOUND          Routing data doesn't match any storage in this driver.
 140
 141 **/
 142 EFI_STATUS
 143 EFIAPI
 144 FakeRouteConfig (
 145   IN  CONST EFI_HII_CONFIG_ACCESS_PROTOCOL   *This,
 146   IN  CONST EFI_STRING                       Configuration,
 147   OUT EFI_STRING                             *Progress
 148   );
 149
 150 /**
 151   This function processes the results of changes in configuration.
 152
 153
 154   @param This            - Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
 155   @param Action          - Specifies the type of action taken by the browser.
 156   @param QuestionId      - A unique value which is sent to the original exporting driver
 157                          so that it can identify the type of data to expect.
 158   @param Type            - The type of value for the question.
 159   @param Value           - A pointer to the data being sent to the original exporting driver.
 160   @param ActionRequest   - On return, points to the action requested by the callback function.
 161
 162   @retval  EFI_SUCCESS           The callback successfully handled the action.
 163   @retval  EFI_OUT_OF_RESOURCES  Not enough storage is available to hold the variable and its data.
 164   @retval  EFI_DEVICE_ERROR      The variable could not be saved.
 165   @retval  EFI_UNSUPPORTED       The specified Action is not supported by the callback.
 166
 167 **/
 168 EFI_STATUS
 169 EFIAPI
 170 FrontPageCallback (
 171   IN  CONST EFI_HII_CONFIG_ACCESS_PROTOCOL   *This,
 172   IN  EFI_BROWSER_ACTION                     Action,
 173   IN  EFI_QUESTION_ID                        QuestionId,
 174   IN  UINT8                                  Type,
 175   IN  EFI_IFR_TYPE_VALUE                     *Value,
 176   OUT EFI_BROWSER_ACTION_REQUEST             *ActionRequest
 177   );
 178
 179 /**
 180   Initialize HII information for the FrontPage
 181
 182   @retval  EFI_SUCCESS        The operation is successful.
 183   @retval  EFI_DEVICE_ERROR   If the dynamic opcode creation failed.
 184
 185 **/
 186 EFI_STATUS
 187 InitializeFrontPage (
 188   VOID
 189   );
 190
 191 /**
 192   Acquire the string associated with the ProducerGuid and return it.
 193
 194
 195   @param ProducerGuid    - The Guid to search the HII database for
 196   @param Token           - The token value of the string to extract
 197   @param String          - The string that is extracted
 198
 199   @retval  EFI_SUCCESS  The function returns EFI_SUCCESS always.
 200
 201 **/
 202 EFI_STATUS
 203 GetProducerString (
 204   IN      EFI_GUID                  *ProducerGuid,
 205   IN      EFI_STRING_ID             Token,
 206   OUT     CHAR16                    **String
 207   );
 208
 209 /**
 210   This function is the main entry of the UI entry.
 211   The function will present the main menu of the system UI.
 212
 213   @param ConnectAllHappened Caller passes the value to UI to avoid unnecessary connect-all.
 214
 215 **/
 216 VOID
 217 EFIAPI
 218 UiEntry (
 219   IN BOOLEAN                      ConnectAllHappened
 220   );
 221
 222 /**
 223   Extract the displayed formset for given HII handle and class guid.
 224
 225   @param Handle          The HII handle.
 226   @param SetupClassGuid  The class guid specifies which form set will be displayed.
 227   @param SkipCount       Skip some formsets which has processed before.
 228   @param FormSetTitle    Formset title string.
 229   @param FormSetHelp     Formset help string.
 230   @param FormSetGuid     Formset Guid.
 231
 232   @retval  TRUE          The formset for given HII handle will be displayed.
 233   @return  FALSE         The formset for given HII handle will not be displayed.
 234
 235 **/
 236 BOOLEAN
 237 ExtractDisplayedHiiFormFromHiiHandle (
 238   IN      EFI_HII_HANDLE      Handle,
 239   IN      EFI_GUID            *SetupClassGuid,
 240   IN      UINTN               SkipCount,
 241   OUT     EFI_STRING_ID       *FormSetTitle,
 242   OUT     EFI_STRING_ID       *FormSetHelp,
 243   OUT     EFI_GUID            *FormSetGuid
 244   );
 245
 246 /**
 247   Extract device path for given HII handle and class guid.
 248
 249   @param Handle          The HII handle.
 250
 251   @retval  NULL          Fail to get the device path string.
 252   @return  PathString    Get the device path string.
 253
 254 **/
 255 CHAR16 *
 256 ExtractDevicePathFromHiiHandle (
 257   IN      EFI_HII_HANDLE      Handle
 258   );
 259
 260 /**
 261   This function will change video resolution and text mode
 262   according to defined setup mode or defined boot mode
 263
 264   @param  IsSetupMode   Indicate mode is changed to setup mode or boot mode.
 265
 266   @retval  EFI_SUCCESS  Mode is changed successfully.
 267   @retval  Others             Mode failed to be changed.
 268
 269 **/
 270 EFI_STATUS
 271 EFIAPI
 272 BdsSetConsoleMode (
 273   BOOLEAN  IsSetupMode
 274   );
 275
 276 #endif // _FRONT_PAGE_H_
 277