MdeModulePkg/Universal/SetupBrowserDxe/Setup.h

   1 /** @file
   2 Private MACRO, structure and function definitions for Setup Browser module.
   3
   4 Copyright (c) 2007 - 2011, 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
  16 #ifndef _SETUP_H_
  17 #define _SETUP_H_
  18
  19
  20 #include <PiDxe.h>
  21
  22 #include <Protocol/SimpleTextOut.h>
  23 #include <Protocol/SimpleTextIn.h>
  24 #include <Protocol/FormBrowser2.h>
  25 #include <Protocol/DevicePath.h>
  26 #include <Protocol/UnicodeCollation.h>
  27 #include <Protocol/HiiConfigAccess.h>
  28 #include <Protocol/HiiConfigRouting.h>
  29 #include <Protocol/HiiDatabase.h>
  30 #include <Protocol/HiiString.h>
  31 #include <Protocol/UserManager.h>
  32
  33 #include <Guid/MdeModuleHii.h>
  34 #include <Guid/HiiPlatformSetupFormset.h>
  35 #include <Guid/HiiFormMapMethodGuid.h>
  36
  37 #include <Library/PrintLib.h>
  38 #include <Library/DebugLib.h>
  39 #include <Library/BaseMemoryLib.h>
  40 #include <Library/UefiRuntimeServicesTableLib.h>
  41 #include <Library/UefiDriverEntryPoint.h>
  42 #include <Library/UefiBootServicesTableLib.h>
  43 #include <Library/BaseLib.h>
  44 #include <Library/MemoryAllocationLib.h>
  45 #include <Library/HiiLib.h>
  46 #include <Library/PcdLib.h>
  47 #include <Library/DevicePathLib.h>
  48
  49 #include "Colors.h"
  50
  51 //
  52 // This is the generated header file which includes whatever needs to be exported (strings + IFR)
  53 //
  54
  55 extern UINT8  SetupBrowserStrings[];
  56
  57 //
  58 // Screen definitions
  59 //
  60 #define BANNER_HEIGHT                 6
  61 #define BANNER_COLUMNS                3
  62 #define BANNER_LEFT_COLUMN_INDENT     1
  63
  64 #define FRONT_PAGE_HEADER_HEIGHT      6
  65 #define NONE_FRONT_PAGE_HEADER_HEIGHT 3
  66 #define LEFT_SKIPPED_COLUMNS          3
  67 #define FOOTER_HEIGHT                 4
  68 #define STATUS_BAR_HEIGHT             1
  69 #define SCROLL_ARROW_HEIGHT           1
  70 #define POPUP_PAD_SPACE_COUNT         5
  71 #define POPUP_FRAME_WIDTH             2
  72
  73 //
  74 // Definition for function key setting
  75 //
  76 #define NONE_FUNCTION_KEY_SETTING     0
  77 #define DEFAULT_FUNCTION_KEY_SETTING  (FUNCTION_NINE | FUNCTION_TEN)
  78
  79 #define FUNCTION_NINE                 (1 << 2)
  80 #define FUNCTION_TEN                  (1 << 3)
  81
  82 typedef struct {
  83   EFI_GUID  FormSetGuid;
  84   UINTN     KeySetting;
  85 } FUNCTIION_KEY_SETTING;
  86
  87 //
  88 // Character definitions
  89 //
  90 #define CHAR_SPACE              0x0020
  91 #define UPPER_LOWER_CASE_OFFSET 0x20
  92
  93 //
  94 // Time definitions
  95 //
  96 #define ONE_SECOND  10000000
  97
  98 //
  99 // Display definitions
 100 //
 101 #define LEFT_HYPER_DELIMITER      L'<'
 102 #define RIGHT_HYPER_DELIMITER     L'>'
 103
 104 #define LEFT_ONEOF_DELIMITER      L'<'
 105 #define RIGHT_ONEOF_DELIMITER     L'>'
 106
 107 #define LEFT_NUMERIC_DELIMITER    L'['
 108 #define RIGHT_NUMERIC_DELIMITER   L']'
 109
 110 #define LEFT_CHECKBOX_DELIMITER   L'['
 111 #define RIGHT_CHECKBOX_DELIMITER  L']'
 112
 113 #define CHECK_ON                  L'X'
 114 #define CHECK_OFF                 L' '
 115
 116 #define TIME_SEPARATOR            L':'
 117 #define DATE_SEPARATOR            L'/'
 118
 119 #define YES_ANSWER                L'Y'
 120 #define NO_ANSWER                 L'N'
 121
 122 //
 123 // This is the Input Error Message
 124 //
 125 #define INPUT_ERROR 1
 126
 127 //
 128 // This is the NV RAM update required Message
 129 //
 130 #define NV_UPDATE_REQUIRED  2
 131
 132 //
 133 // Refresh the Status Bar with flags
 134 //
 135 #define REFRESH_STATUS_BAR  0xff
 136
 137 //
 138 // Incremental string lenght of ConfigRequest
 139 //
 140 #define CONFIG_REQUEST_STRING_INCREMENTAL  1024
 141
 142 //
 143 // HII value compare result
 144 //
 145 #define HII_VALUE_UNDEFINED     0
 146 #define HII_VALUE_EQUAL         1
 147 #define HII_VALUE_LESS_THAN     2
 148 #define HII_VALUE_GREATER_THAN  3
 149
 150 //
 151 // Incremental size of stack for expression
 152 //
 153 #define EXPRESSION_STACK_SIZE_INCREMENT    0x100
 154
 155 #define EFI_IFR_SPECIFICATION_VERSION  (UINT16) (((EFI_SYSTEM_TABLE_REVISION >> 16) << 8) | (((EFI_SYSTEM_TABLE_REVISION & 0xFFFF) / 10) << 4) | ((EFI_SYSTEM_TABLE_REVISION & 0xFFFF) % 10))
 156
 157
 158 #define SETUP_DRIVER_SIGNATURE SIGNATURE_32 ('F', 'B', 'D', 'V')
 159 typedef struct {
 160   UINT32                             Signature;
 161
 162   EFI_HANDLE                         Handle;
 163
 164   //
 165   // Produced protocol
 166   //
 167   EFI_FORM_BROWSER2_PROTOCOL         FormBrowser2;
 168
 169 } SETUP_DRIVER_PRIVATE_DATA;
 170
 171 typedef struct {
 172   EFI_STRING_ID  Banner[BANNER_HEIGHT][BANNER_COLUMNS];
 173 } BANNER_DATA;
 174
 175 //
 176 // IFR relative definition
 177 //
 178 #define EFI_HII_EXPRESSION_INCONSISTENT_IF   0
 179 #define EFI_HII_EXPRESSION_NO_SUBMIT_IF      1
 180 #define EFI_HII_EXPRESSION_GRAY_OUT_IF       2
 181 #define EFI_HII_EXPRESSION_SUPPRESS_IF       3
 182 #define EFI_HII_EXPRESSION_DISABLE_IF        4
 183 #define EFI_HII_EXPRESSION_VALUE             5
 184 #define EFI_HII_EXPRESSION_RULE              6
 185 #define EFI_HII_EXPRESSION_READ              7
 186 #define EFI_HII_EXPRESSION_WRITE             8
 187
 188 #define EFI_HII_VARSTORE_BUFFER              0
 189 #define EFI_HII_VARSTORE_NAME_VALUE          1
 190 #define EFI_HII_VARSTORE_EFI_VARIABLE        2
 191
 192 #define FORM_INCONSISTENT_VALIDATION         0
 193 #define FORM_NO_SUBMIT_VALIDATION            1
 194
 195 #define FORMSET_CLASS_PLATFORM_SETUP         0x0001
 196 #define FORMSET_CLASS_FRONT_PAGE             0x0002
 197
 198 typedef struct {
 199   UINT8               Type;
 200   EFI_IFR_TYPE_VALUE  Value;
 201 } EFI_HII_VALUE;
 202
 203 #define NAME_VALUE_NODE_SIGNATURE  SIGNATURE_32 ('N', 'V', 'S', 'T')
 204
 205 typedef struct {
 206   UINTN            Signature;
 207   LIST_ENTRY       Link;
 208   CHAR16           *Name;
 209   CHAR16           *Value;
 210   CHAR16           *EditValue;
 211 } NAME_VALUE_NODE;
 212
 213 #define NAME_VALUE_NODE_FROM_LINK(a)  CR (a, NAME_VALUE_NODE, Link, NAME_VALUE_NODE_SIGNATURE)
 214
 215 #define FORMSET_STORAGE_SIGNATURE  SIGNATURE_32 ('F', 'S', 'T', 'G')
 216
 217 typedef struct {
 218   UINTN            Signature;
 219   LIST_ENTRY       Link;
 220
 221   UINT8            Type;           // Storage type
 222
 223   UINT16           VarStoreId;
 224   EFI_GUID         Guid;
 225
 226   CHAR16           *Name;          // For EFI_IFR_VARSTORE
 227   UINT16           Size;
 228   UINT8            *Buffer;
 229   UINT8            *EditBuffer;    // Edit copy for Buffer Storage
 230
 231   LIST_ENTRY       NameValueListHead; // List of NAME_VALUE_NODE
 232
 233   UINT32           Attributes;     // For EFI_IFR_VARSTORE_EFI: EFI Variable attribute
 234
 235   CHAR16           *ConfigHdr;     // <ConfigHdr>
 236   CHAR16           *ConfigRequest; // <ConfigRequest> = <ConfigHdr> + <RequestElement>
 237   UINTN            ElementCount;   // Number of <RequestElement> in the <ConfigRequest>
 238   UINTN            SpareStrLen;    // Spare length of ConfigRequest string buffer
 239 } FORMSET_STORAGE;
 240
 241 #define FORMSET_STORAGE_FROM_LINK(a)  CR (a, FORMSET_STORAGE, Link, FORMSET_STORAGE_SIGNATURE)
 242
 243 typedef union {
 244   EFI_STRING_ID         VarName;
 245   UINT16                VarOffset;
 246 } VAR_STORE_INFO;
 247
 248 #define EXPRESSION_OPCODE_SIGNATURE  SIGNATURE_32 ('E', 'X', 'O', 'P')
 249
 250 typedef struct {
 251   UINTN             Signature;
 252   LIST_ENTRY        Link;
 253
 254   UINT8             Operand;
 255
 256   UINT8             Format;      // For EFI_IFR_TO_STRING, EFI_IFR_FIND
 257   UINT8             Flags;       // For EFI_IFR_SPAN
 258   UINT8             RuleId;      // For EFI_IFR_RULE_REF
 259
 260   EFI_HII_VALUE     Value;       // For EFI_IFR_EQ_ID_VAL, EFI_IFR_UINT64, EFI_IFR_UINT32, EFI_IFR_UINT16, EFI_IFR_UINT8, EFI_IFR_STRING_REF1
 261
 262   EFI_QUESTION_ID   QuestionId;  // For EFI_IFR_EQ_ID_ID, EFI_IFR_EQ_ID_VAL_LIST, EFI_IFR_QUESTION_REF1
 263   EFI_QUESTION_ID   QuestionId2;
 264
 265   UINT16            ListLength;  // For EFI_IFR_EQ_ID_VAL_LIST
 266   UINT16            *ValueList;
 267
 268   EFI_STRING_ID     DevicePath;  // For EFI_IFR_QUESTION_REF3_2, EFI_IFR_QUESTION_REF3_3
 269   EFI_GUID          Guid;
 270
 271   FORMSET_STORAGE   *VarStorage; // For EFI_IFR_SET, EFI_IFR_GET
 272   VAR_STORE_INFO    VarStoreInfo;// For EFI_IFR_SET, EFI_IFR_GET
 273   UINT8             ValueType;   // For EFI_IFR_SET, EFI_IFR_GET
 274   UINT8             ValueWidth;  // For EFI_IFR_SET, EFI_IFR_GET
 275   CHAR16            *ValueName;  // For EFI_IFR_SET, EFI_IFR_GET
 276   LIST_ENTRY        MapExpressionList;   // nested expressions inside of Map opcode.
 277 } EXPRESSION_OPCODE;
 278
 279 #define EXPRESSION_OPCODE_FROM_LINK(a)  CR (a, EXPRESSION_OPCODE, Link, EXPRESSION_OPCODE_SIGNATURE)
 280
 281 #define FORM_EXPRESSION_SIGNATURE  SIGNATURE_32 ('F', 'E', 'X', 'P')
 282
 283 typedef struct {
 284   UINTN             Signature;
 285   LIST_ENTRY        Link;
 286
 287   UINT8             Type;            // Type for this expression
 288
 289   UINT8             RuleId;          // For EFI_IFR_RULE only
 290   EFI_STRING_ID     Error;           // For EFI_IFR_NO_SUBMIT_IF, EFI_IFR_INCONSISTENT_IF only
 291
 292   EFI_HII_VALUE     Result;          // Expression evaluation result
 293
 294   LIST_ENTRY        OpCodeListHead;  // OpCodes consist of this expression (EXPRESSION_OPCODE)
 295 } FORM_EXPRESSION;
 296
 297 #define FORM_EXPRESSION_FROM_LINK(a)  CR (a, FORM_EXPRESSION, Link, FORM_EXPRESSION_SIGNATURE)
 298
 299 #define QUESTION_DEFAULT_SIGNATURE  SIGNATURE_32 ('Q', 'D', 'F', 'T')
 300
 301 typedef struct {
 302   UINTN               Signature;
 303   LIST_ENTRY          Link;
 304
 305   UINT16              DefaultId;
 306   EFI_HII_VALUE       Value;              // Default value
 307
 308   FORM_EXPRESSION     *ValueExpression;   // Not-NULL indicates default value is provided by EFI_IFR_VALUE
 309 } QUESTION_DEFAULT;
 310
 311 #define QUESTION_DEFAULT_FROM_LINK(a)  CR (a, QUESTION_DEFAULT, Link, QUESTION_DEFAULT_SIGNATURE)
 312
 313 #define QUESTION_OPTION_SIGNATURE  SIGNATURE_32 ('Q', 'O', 'P', 'T')
 314
 315 typedef struct {
 316   UINTN               Signature;
 317   LIST_ENTRY          Link;
 318
 319   EFI_STRING_ID       Text;
 320   UINT8               Flags;
 321   EFI_HII_VALUE       Value;
 322   EFI_IMAGE_ID        ImageId;
 323
 324   FORM_EXPRESSION     *SuppressExpression; // Non-NULL indicates nested inside of SuppressIf
 325 } QUESTION_OPTION;
 326
 327 #define QUESTION_OPTION_FROM_LINK(a)  CR (a, QUESTION_OPTION, Link, QUESTION_OPTION_SIGNATURE)
 328
 329 #define FORM_BROWSER_STATEMENT_SIGNATURE  SIGNATURE_32 ('F', 'S', 'T', 'A')
 330
 331 typedef struct {
 332   UINTN                 Signature;
 333   LIST_ENTRY            Link;
 334
 335   UINT8                 Operand;          // The operand (first byte) of this Statement or Question
 336
 337   //
 338   // Statement Header
 339   //
 340   EFI_STRING_ID         Prompt;
 341   EFI_STRING_ID         Help;
 342   EFI_STRING_ID         TextTwo;          // For EFI_IFR_TEXT
 343
 344   //
 345   // Question Header
 346   //
 347   EFI_QUESTION_ID       QuestionId;       // The value of zero is reserved
 348   EFI_VARSTORE_ID       VarStoreId;       // A value of zero indicates no variable storage
 349   FORMSET_STORAGE       *Storage;
 350   VAR_STORE_INFO        VarStoreInfo;
 351   UINT16                StorageWidth;
 352   UINT8                 QuestionFlags;
 353   CHAR16                *VariableName;    // Name/Value or EFI Variable name
 354   CHAR16                *BlockName;       // Buffer storage block name: "OFFSET=...WIDTH=..."
 355
 356   EFI_HII_VALUE         HiiValue;         // Edit copy for checkbox, numberic, oneof
 357   UINT8                 *BufferValue;     // Edit copy for string, password, orderedlist
 358   UINT8                 ValueType;        // Data type for orderedlist value array
 359
 360   //
 361   // OpCode specific members
 362   //
 363   UINT8                 Flags;            // for EFI_IFR_CHECKBOX, EFI_IFR_DATE, EFI_IFR_NUMERIC, EFI_IFR_ONE_OF,
 364                                           // EFI_IFR_ORDERED_LIST, EFI_IFR_STRING,EFI_IFR_SUBTITLE,EFI_IFR_TIME, EFI_IFR_BANNER
 365   UINT8                 MaxContainers;    // for EFI_IFR_ORDERED_LIST
 366
 367   UINT16                BannerLineNumber; // for EFI_IFR_BANNER, 1-based line number
 368   EFI_STRING_ID         QuestionConfig;   // for EFI_IFR_ACTION, if 0 then no configuration string will be processed
 369
 370   UINT64                Minimum;          // for EFI_IFR_ONE_OF/EFI_IFR_NUMERIC, it's Min/Max value
 371   UINT64                Maximum;          // for EFI_IFR_STRING/EFI_IFR_PASSWORD, it's Min/Max length
 372   UINT64                Step;
 373
 374   EFI_DEFAULT_ID        DefaultId;        // for EFI_IFR_RESET_BUTTON
 375   EFI_FORM_ID           RefFormId;        // for EFI_IFR_REF
 376   EFI_QUESTION_ID       RefQuestionId;    // for EFI_IFR_REF2
 377   EFI_GUID              RefFormSetId;     // for EFI_IFR_REF3
 378   EFI_STRING_ID         RefDevicePath;    // for EFI_IFR_REF4
 379
 380   //
 381   // Get from IFR parsing
 382   //
 383   FORM_EXPRESSION       *ValueExpression;    // nested EFI_IFR_VALUE, provide Question value and indicate Question is ReadOnly
 384   LIST_ENTRY            DefaultListHead;     // nested EFI_IFR_DEFAULT list (QUESTION_DEFAULT), provide default values
 385   LIST_ENTRY            OptionListHead;      // nested EFI_IFR_ONE_OF_OPTION list (QUESTION_OPTION)
 386
 387   EFI_IMAGE_ID          ImageId;             // nested EFI_IFR_IMAGE
 388   UINT8                 RefreshInterval;     // nested EFI_IFR_REFRESH, refresh interval(in seconds) for Question value, 0 means no refresh
 389   BOOLEAN               InSubtitle;          // nesting inside of EFI_IFR_SUBTITLE
 390
 391   LIST_ENTRY            InconsistentListHead;// nested inconsistent expression list (FORM_EXPRESSION)
 392   LIST_ENTRY            NoSubmitListHead;    // nested nosubmit expression list (FORM_EXPRESSION)
 393   FORM_EXPRESSION       *GrayOutExpression;  // nesting inside of GrayOutIf
 394   FORM_EXPRESSION       *SuppressExpression; // nesting inside of SuppressIf
 395   FORM_EXPRESSION       *DisableExpression;  // nesting inside of DisableIf
 396
 397   FORM_EXPRESSION       *ReadExpression;     // nested EFI_IFR_READ, provide this question value by read expression.
 398   FORM_EXPRESSION       *WriteExpression;    // nested EFI_IFR_WRITE, evaluate write expression after this question value is set.
 399 } FORM_BROWSER_STATEMENT;
 400
 401 #define FORM_BROWSER_STATEMENT_FROM_LINK(a)  CR (a, FORM_BROWSER_STATEMENT, Link, FORM_BROWSER_STATEMENT_SIGNATURE)
 402
 403 #define FORM_BROWSER_CONFIG_REQUEST_SIGNATURE  SIGNATURE_32 ('F', 'C', 'R', 'S')
 404 typedef struct {
 405   UINTN                 Signature;
 406   LIST_ENTRY            Link;
 407
 408   CHAR16                *ConfigRequest; // <ConfigRequest> = <ConfigHdr> + <RequestElement>
 409   UINTN                 ElementCount;   // Number of <RequestElement> in the <ConfigRequest>
 410   UINTN                 SpareStrLen;
 411
 412   FORMSET_STORAGE       *Storage;
 413 } FORM_BROWSER_CONFIG_REQUEST;
 414 #define FORM_BROWSER_CONFIG_REQUEST_FROM_LINK(a)  CR (a, FORM_BROWSER_CONFIG_REQUEST, Link, FORM_BROWSER_CONFIG_REQUEST_SIGNATURE)
 415
 416 #define FORM_BROWSER_FORM_SIGNATURE  SIGNATURE_32 ('F', 'F', 'R', 'M')
 417 #define STANDARD_MAP_FORM_TYPE 0x01
 418
 419 typedef struct {
 420   UINTN             Signature;
 421   LIST_ENTRY        Link;
 422
 423   UINT16            FormId;               // FormId of normal form or formmap form.
 424   EFI_STRING_ID     FormTitle;            // FormTile of normal form, or FormMapMethod title of formmap form.
 425   UINT16            FormType;             // Specific form type for the different form.
 426
 427   EFI_IMAGE_ID      ImageId;
 428
 429   BOOLEAN           ModalForm;            // Whether this is a modal form.
 430
 431   BOOLEAN           NvUpdateRequired;     // Whether this form has NV update request.
 432
 433   LIST_ENTRY        ExpressionListHead;   // List of Expressions (FORM_EXPRESSION)
 434   LIST_ENTRY        StatementListHead;    // List of Statements and Questions (FORM_BROWSER_STATEMENT)
 435   LIST_ENTRY        ConfigRequestHead;    // List of configreques for all storage.
 436   FORM_EXPRESSION   *SuppressExpression;  // nesting inside of SuppressIf
 437 } FORM_BROWSER_FORM;
 438
 439 #define FORM_BROWSER_FORM_FROM_LINK(a)  CR (a, FORM_BROWSER_FORM, Link, FORM_BROWSER_FORM_SIGNATURE)
 440
 441 #define FORMSET_DEFAULTSTORE_SIGNATURE  SIGNATURE_32 ('F', 'D', 'F', 'S')
 442
 443 typedef struct {
 444   UINTN            Signature;
 445   LIST_ENTRY       Link;
 446
 447   UINT16           DefaultId;
 448   EFI_STRING_ID    DefaultName;
 449 } FORMSET_DEFAULTSTORE;
 450
 451 #define FORMSET_DEFAULTSTORE_FROM_LINK(a)  CR (a, FORMSET_DEFAULTSTORE, Link, FORMSET_DEFAULTSTORE_SIGNATURE)
 452
 453 typedef struct {
 454   EFI_HII_HANDLE                  HiiHandle;
 455   EFI_HANDLE                      DriverHandle;
 456   EFI_HII_CONFIG_ACCESS_PROTOCOL  *ConfigAccess;
 457   EFI_DEVICE_PATH_PROTOCOL        *DevicePath;
 458
 459   UINTN                           IfrBinaryLength;
 460   UINT8                           *IfrBinaryData;
 461
 462   EFI_GUID                        Guid;
 463   EFI_STRING_ID                   FormSetTitle;
 464   EFI_STRING_ID                   Help;
 465   UINT8                           NumberOfClassGuid;
 466   EFI_GUID                        ClassGuid[3];         // Up to three ClassGuid
 467   UINT16                          Class;                // Tiano extended Class code
 468   UINT16                          SubClass;             // Tiano extended Subclass code
 469   EFI_IMAGE_ID                    ImageId;
 470
 471   FORM_BROWSER_STATEMENT          *StatementBuffer;     // Buffer for all Statements and Questions
 472   EXPRESSION_OPCODE               *ExpressionBuffer;    // Buffer for all Expression OpCode
 473
 474   LIST_ENTRY                      StorageListHead;      // Storage list (FORMSET_STORAGE)
 475   LIST_ENTRY                      DefaultStoreListHead; // DefaultStore list (FORMSET_DEFAULTSTORE)
 476   LIST_ENTRY                      FormListHead;         // Form list (FORM_BROWSER_FORM)
 477   LIST_ENTRY                      ExpressionListHead;   // List of Expressions (FORM_EXPRESSION)
 478 } FORM_BROWSER_FORMSET;
 479
 480 #define BROWSER_CONTEXT_SIGNATURE  SIGNATURE_32 ('B', 'C', 'T', 'X')
 481
 482 typedef struct {
 483   UINTN                 Signature;
 484   LIST_ENTRY            Link;
 485
 486   //
 487   // Globals defined in Setup.c
 488   //
 489   BANNER_DATA           *BannerData;
 490   UINTN                 ClassOfVfr;
 491   UINTN                 FunctionKeySetting;
 492   BOOLEAN               ResetRequired;
 493   UINT16                Direction;
 494   EFI_SCREEN_DESCRIPTOR ScreenDimensions;
 495   CHAR16                *FunctionNineString;
 496   CHAR16                *FunctionTenString;
 497   CHAR16                *EnterString;
 498   CHAR16                *EnterCommitString;
 499   CHAR16                *EnterEscapeString;
 500   CHAR16                *EscapeString;
 501   CHAR16                *SaveFailed;
 502   CHAR16                *MoveHighlight;
 503   CHAR16                *MakeSelection;
 504   CHAR16                *DecNumericInput;
 505   CHAR16                *HexNumericInput;
 506   CHAR16                *ToggleCheckBox;
 507   CHAR16                *PromptForData;
 508   CHAR16                *PromptForPassword;
 509   CHAR16                *PromptForNewPassword;
 510   CHAR16                *ConfirmPassword;
 511   CHAR16                *ConfirmError;
 512   CHAR16                *PassowordInvalid;
 513   CHAR16                *PressEnter;
 514   CHAR16                *EmptyString;
 515   CHAR16                *AreYouSure;
 516   CHAR16                *YesResponse;
 517   CHAR16                *NoResponse;
 518   CHAR16                *MiniString;
 519   CHAR16                *PlusString;
 520   CHAR16                *MinusString;
 521   CHAR16                *AdjustNumber;
 522   CHAR16                *SaveChanges;
 523   CHAR16                *OptionMismatch;
 524   CHAR16                *FormSuppress;
 525   CHAR16                PromptBlockWidth;
 526   CHAR16                OptionBlockWidth;
 527   CHAR16                HelpBlockWidth;
 528   FORM_BROWSER_FORMSET  *OldFormSet;
 529
 530   //
 531   // Globals defined in Ui.c
 532   //
 533   LIST_ENTRY           MenuOption;
 534   VOID                 *MenuRefreshHead;
 535 } BROWSER_CONTEXT;
 536
 537 #define BROWSER_CONTEXT_FROM_LINK(a)  CR (a, BROWSER_CONTEXT, Link, BROWSER_CONTEXT_SIGNATURE)
 538
 539 extern EFI_HII_DATABASE_PROTOCOL         *mHiiDatabase;
 540 extern EFI_HII_STRING_PROTOCOL           *mHiiString;
 541 extern EFI_HII_CONFIG_ROUTING_PROTOCOL   *mHiiConfigRouting;
 542
 543 extern BANNER_DATA           *gBannerData;
 544 extern EFI_HII_HANDLE        gFrontPageHandle;
 545 extern UINTN                 gClassOfVfr;
 546 extern UINTN                 gFunctionKeySetting;
 547 extern BOOLEAN               gResetRequired;
 548 extern EFI_HII_HANDLE        gHiiHandle;
 549 extern UINT16                gDirection;
 550 extern EFI_SCREEN_DESCRIPTOR gScreenDimensions;
 551
 552 extern FORM_BROWSER_FORMSET  *gOldFormSet;
 553
 554 //
 555 // Browser Global Strings
 556 //
 557 extern CHAR16            *gFunctionNineString;
 558 extern CHAR16            *gFunctionTenString;
 559 extern CHAR16            *gEnterString;
 560 extern CHAR16            *gEnterCommitString;
 561 extern CHAR16            *gEnterEscapeString;
 562 extern CHAR16            *gEscapeString;
 563 extern CHAR16            *gSaveFailed;
 564 extern CHAR16            *gMoveHighlight;
 565 extern CHAR16            *gMakeSelection;
 566 extern CHAR16            *gDecNumericInput;
 567 extern CHAR16            *gHexNumericInput;
 568 extern CHAR16            *gToggleCheckBox;
 569 extern CHAR16            *gPromptForData;
 570 extern CHAR16            *gPromptForPassword;
 571 extern CHAR16            *gPromptForNewPassword;
 572 extern CHAR16            *gConfirmPassword;
 573 extern CHAR16            *gConfirmError;
 574 extern CHAR16            *gPassowordInvalid;
 575 extern CHAR16            *gPressEnter;
 576 extern CHAR16            *gEmptyString;
 577 extern CHAR16            *gAreYouSure;
 578 extern CHAR16            *gYesResponse;
 579 extern CHAR16            *gNoResponse;
 580 extern CHAR16            *gMiniString;
 581 extern CHAR16            *gPlusString;
 582 extern CHAR16            *gMinusString;
 583 extern CHAR16            *gAdjustNumber;
 584 extern CHAR16            *gSaveChanges;
 585 extern CHAR16            *gOptionMismatch;
 586 extern CHAR16            *gFormSuppress;
 587
 588 extern CHAR16            gPromptBlockWidth;
 589 extern CHAR16            gOptionBlockWidth;
 590 extern CHAR16            gHelpBlockWidth;
 591
 592 extern EFI_GUID          gZeroGuid;
 593 extern EFI_GUID          gTianoHiiIfrGuid;
 594
 595 #include "Ui.h"
 596 //
 597 // Global Procedure Defines
 598 //
 599
 600 /**
 601   Initialize the HII String Token to the correct values.
 602
 603 **/
 604 VOID
 605 InitializeBrowserStrings (
 606   VOID
 607   );
 608
 609 /**
 610   Prints a unicode string to the default console,
 611   using L"%s" format.
 612
 613   @param  String     String pointer.
 614
 615   @return Length of string printed to the console
 616
 617 **/
 618 UINTN
 619 PrintString (
 620   IN CHAR16       *String
 621   );
 622
 623 /**
 624   Prints a chracter to the default console,
 625   using L"%c" format.
 626
 627   @param  Character  Character to print.
 628
 629   @return Length of string printed to the console.
 630
 631 **/
 632 UINTN
 633 PrintChar (
 634   CHAR16       Character
 635   );
 636
 637 /**
 638   Prints a formatted unicode string to the default console, at
 639   the supplied cursor position.
 640
 641   @param  Column     The cursor position to print the string at.
 642   @param  Row        The cursor position to print the string at
 643   @param  Fmt        Format string
 644   @param  ...        Variable argument list for formating string.
 645
 646   @return Length of string printed to the console
 647
 648 **/
 649 UINTN
 650 EFIAPI
 651 PrintAt (
 652   IN UINTN     Column,
 653   IN UINTN     Row,
 654   IN CHAR16    *Fmt,
 655   ...
 656   );
 657
 658 /**
 659   Prints a unicode string to the default console, at
 660   the supplied cursor position, using L"%s" format.
 661
 662   @param  Column     The cursor position to print the string at.
 663   @param  Row        The cursor position to print the string at
 664   @param  String     String pointer.
 665
 666   @return Length of string printed to the console
 667
 668 **/
 669 UINTN
 670 PrintStringAt (
 671   IN UINTN     Column,
 672   IN UINTN     Row,
 673   IN CHAR16    *String
 674   );
 675
 676 /**
 677   Prints a chracter to the default console, at
 678   the supplied cursor position, using L"%c" format.
 679
 680   @param  Column     The cursor position to print the string at.
 681   @param  Row        The cursor position to print the string at.
 682   @param  Character  Character to print.
 683
 684   @return Length of string printed to the console.
 685
 686 **/
 687 UINTN
 688 PrintCharAt (
 689   IN UINTN     Column,
 690   IN UINTN     Row,
 691   CHAR16       Character
 692   );
 693
 694 /**
 695   Parse opcodes in the formset IFR binary.
 696
 697   @param  FormSet                Pointer of the FormSet data structure.
 698
 699   @retval EFI_SUCCESS            Opcode parse success.
 700   @retval Other                  Opcode parse fail.
 701
 702 **/
 703 EFI_STATUS
 704 ParseOpCodes (
 705   IN FORM_BROWSER_FORMSET              *FormSet
 706   );
 707
 708 /**
 709   Free resources allocated for a FormSet.
 710
 711   @param  FormSet                Pointer of the FormSet
 712
 713 **/
 714 VOID
 715 DestroyFormSet (
 716   IN OUT FORM_BROWSER_FORMSET  *FormSet
 717   );
 718
 719 /**
 720   This function displays the page frame.
 721
 722   @param  Selection              Selection contains the information about
 723                                  the Selection, form and formset to be displayed.
 724                                  Selection action may be updated in retrieve callback.
 725 **/
 726 VOID
 727 DisplayPageFrame (
 728   IN UI_MENU_SELECTION    *Selection
 729   );
 730
 731 /**
 732   Create a new string in HII Package List.
 733
 734   @param  String                 The String to be added
 735   @param  HiiHandle              The package list in the HII database to insert the
 736                                  specified string.
 737
 738   @return The output string.
 739
 740 **/
 741 EFI_STRING_ID
 742 NewString (
 743   IN  CHAR16                   *String,
 744   IN  EFI_HII_HANDLE           HiiHandle
 745   );
 746
 747 /**
 748   Delete a string from HII Package List.
 749
 750   @param  StringId               Id of the string in HII database.
 751   @param  HiiHandle              The HII package list handle.
 752
 753   @retval EFI_SUCCESS            The string was deleted successfully.
 754
 755 **/
 756 EFI_STATUS
 757 DeleteString (
 758   IN  EFI_STRING_ID            StringId,
 759   IN  EFI_HII_HANDLE           HiiHandle
 760   );
 761
 762 /**
 763   Get the string based on the StringId and HII Package List Handle.
 764
 765   @param  Token                  The String's ID.
 766   @param  HiiHandle              The package list in the HII database to search for
 767                                  the specified string.
 768
 769   @return The output string.
 770
 771 **/
 772 CHAR16 *
 773 GetToken (
 774   IN  EFI_STRING_ID                Token,
 775   IN  EFI_HII_HANDLE               HiiHandle
 776   );
 777
 778 /**
 779   Draw a pop up windows based on the dimension, number of lines and
 780   strings specified.
 781
 782   @param RequestedWidth  The width of the pop-up.
 783   @param NumberOfLines   The number of lines.
 784   @param Marker          The variable argument list for the list of string to be printed.
 785
 786 **/
 787 VOID
 788 CreateSharedPopUp (
 789   IN  UINTN                       RequestedWidth,
 790   IN  UINTN                       NumberOfLines,
 791   IN  VA_LIST                     Marker
 792   );
 793
 794 /**
 795   Routine used to abstract a generic dialog interface and return the selected key or string
 796
 797   @param  NumberOfLines          The number of lines for the dialog box
 798   @param  HotKey                 Defines whether a single character is parsed
 799                                  (TRUE) and returned in KeyValue or a string is
 800                                  returned in StringBuffer.  Two special characters
 801                                  are considered when entering a string, a SCAN_ESC
 802                                  and an CHAR_CARRIAGE_RETURN.  SCAN_ESC terminates
 803                                  string input and returns
 804   @param  MaximumStringSize      The maximum size in bytes of a typed in string
 805                                  (each character is a CHAR16) and the minimum
 806                                  string returned is two bytes
 807   @param  StringBuffer           The passed in pointer to the buffer which will
 808                                  hold the typed in string if HotKey is FALSE
 809   @param  KeyValue               The EFI_KEY value returned if HotKey is TRUE..
 810   @param  ...                    A series of (quantity == NumberOfLines) text
 811                                  strings which will be used to construct the dialog
 812                                  box
 813
 814   @retval EFI_SUCCESS            Displayed dialog and received user interaction
 815   @retval EFI_INVALID_PARAMETER  One of the parameters was invalid (e.g.
 816                                  (StringBuffer == NULL) && (HotKey == FALSE))
 817   @retval EFI_DEVICE_ERROR       User typed in an ESC character to exit the routine
 818
 819 **/
 820 EFI_STATUS
 821 EFIAPI
 822 CreateDialog (
 823   IN  UINTN                       NumberOfLines,
 824   IN  BOOLEAN                     HotKey,
 825   IN  UINTN                       MaximumStringSize,
 826   OUT CHAR16                      *StringBuffer,
 827   OUT EFI_INPUT_KEY               *KeyValue,
 828   ...
 829   );
 830
 831 /**
 832   Get Value for given Name from a NameValue Storage.
 833
 834   @param  Storage                The NameValue Storage.
 835   @param  Name                   The Name.
 836   @param  Value                  The retured Value.
 837
 838   @retval EFI_SUCCESS            Value found for given Name.
 839   @retval EFI_NOT_FOUND          No such Name found in NameValue storage.
 840
 841 **/
 842 EFI_STATUS
 843 GetValueByName (
 844   IN FORMSET_STORAGE         *Storage,
 845   IN CHAR16                  *Name,
 846   IN OUT CHAR16              **Value
 847   );
 848
 849 /**
 850   Set Value of given Name in a NameValue Storage.
 851
 852   @param  Storage                The NameValue Storage.
 853   @param  Name                   The Name.
 854   @param  Value                  The Value to set.
 855   @param  Edit                   Whether update editValue or Value.
 856
 857   @retval EFI_SUCCESS            Value found for given Name.
 858   @retval EFI_NOT_FOUND          No such Name found in NameValue storage.
 859
 860 **/
 861 EFI_STATUS
 862 SetValueByName (
 863   IN FORMSET_STORAGE         *Storage,
 864   IN CHAR16                  *Name,
 865   IN CHAR16                  *Value,
 866   IN BOOLEAN                 Edit
 867   );
 868
 869 /**
 870   Get Question's current Value.
 871
 872   @param  FormSet                FormSet data structure.
 873   @param  Form                   Form data structure.
 874   @param  Question               Question to be initialized.
 875   @param  Cached                 TRUE:  get from Edit copy FALSE: get from original
 876                                  Storage
 877
 878   @retval EFI_SUCCESS            The function completed successfully.
 879
 880 **/
 881 EFI_STATUS
 882 GetQuestionValue (
 883   IN FORM_BROWSER_FORMSET             *FormSet,
 884   IN FORM_BROWSER_FORM                *Form,
 885   IN OUT FORM_BROWSER_STATEMENT       *Question,
 886   IN BOOLEAN                          Cached
 887   );
 888
 889 /**
 890   Save Question Value to edit copy(cached) or Storage(uncached).
 891
 892   @param  FormSet                FormSet data structure.
 893   @param  Form                   Form data structure.
 894   @param  Question               Pointer to the Question.
 895   @param  Cached                 TRUE:  set to Edit copy FALSE: set to original
 896                                  Storage
 897
 898   @retval EFI_SUCCESS            The function completed successfully.
 899
 900 **/
 901 EFI_STATUS
 902 SetQuestionValue (
 903   IN FORM_BROWSER_FORMSET             *FormSet,
 904   IN FORM_BROWSER_FORM                *Form,
 905   IN OUT FORM_BROWSER_STATEMENT       *Question,
 906   IN BOOLEAN                          Cached
 907   );
 908
 909 /**
 910   Perform inconsistent check for a Form.
 911
 912   @param  FormSet                FormSet data structure.
 913   @param  Form                   Form data structure.
 914   @param  Question               The Question to be validated.
 915   @param  Type                   Validation type: InConsistent or NoSubmit
 916
 917   @retval EFI_SUCCESS            Form validation pass.
 918   @retval other                  Form validation failed.
 919
 920 **/
 921 EFI_STATUS
 922 ValidateQuestion (
 923   IN  FORM_BROWSER_FORMSET            *FormSet,
 924   IN  FORM_BROWSER_FORM               *Form,
 925   IN  FORM_BROWSER_STATEMENT          *Question,
 926   IN  UINTN                           Type
 927   );
 928
 929 /**
 930   Discard data for form level or formset level.
 931
 932   @param  FormSet                FormSet data structure.
 933   @param  Form                   Form data structure.
 934   @param  SingleForm             whether submit single form or formset.
 935
 936   @retval EFI_SUCCESS            The function completed successfully.
 937
 938 **/
 939 EFI_STATUS
 940 DiscardForm (
 941   IN FORM_BROWSER_FORMSET             *FormSet,
 942   IN FORM_BROWSER_FORM                *Form,
 943   IN BOOLEAN                          SingleForm
 944   );
 945
 946 /**
 947   Submit data for form level or formset level.
 948
 949   @param  FormSet                FormSet data structure.
 950   @param  Form                   Form data structure.
 951   @param  SingleForm             whether submit single form or formset.
 952
 953   @retval EFI_SUCCESS            The function completed successfully.
 954
 955 **/
 956 EFI_STATUS
 957 SubmitForm (
 958   IN FORM_BROWSER_FORMSET             *FormSet,
 959   IN FORM_BROWSER_FORM                *Form,
 960   IN BOOLEAN                          SingleForm
 961   );
 962
 963 /**
 964   Reset Question to its default value.
 965
 966   @param  FormSet                The form set.
 967   @param  Form                   The form.
 968   @param  Question               The question.
 969   @param  DefaultId              The Class of the default.
 970
 971   @retval EFI_SUCCESS            Question is reset to default value.
 972
 973 **/
 974 EFI_STATUS
 975 GetQuestionDefault (
 976   IN FORM_BROWSER_FORMSET             *FormSet,
 977   IN FORM_BROWSER_FORM                *Form,
 978   IN FORM_BROWSER_STATEMENT           *Question,
 979   IN UINT16                           DefaultId
 980   );
 981
 982 /**
 983   Get current setting of Questions.
 984
 985   @param  FormSet                FormSet data structure.
 986
 987   @retval EFI_SUCCESS            The function completed successfully.
 988
 989 **/
 990 EFI_STATUS
 991 InitializeCurrentSetting (
 992   IN OUT FORM_BROWSER_FORMSET             *FormSet
 993   );
 994
 995 /**
 996   Initialize the internal data structure of a FormSet.
 997
 998   @param  Handle                 PackageList Handle
 999   @param  FormSetGuid            GUID of a formset. If not specified (NULL or zero
1000                                  GUID), take the first FormSet found in package
1001                                  list.
1002   @param  FormSet                FormSet data structure.
1003
1004   @retval EFI_SUCCESS            The function completed successfully.
1005   @retval EFI_NOT_FOUND          The specified FormSet could not be found.
1006
1007 **/
1008 EFI_STATUS
1009 InitializeFormSet (
1010   IN  EFI_HII_HANDLE                   Handle,
1011   IN OUT EFI_GUID                      *FormSetGuid,
1012   OUT FORM_BROWSER_FORMSET             *FormSet
1013   );
1014
1015 /**
1016   Reset Questions in a Form to their default value.
1017
1018   @param  FormSet                FormSet data structure.
1019   @param  Form                   The Form which to be reset.
1020   @param  DefaultId              The Class of the default.
1021
1022   @retval EFI_SUCCESS            The function completed successfully.
1023
1024 **/
1025 EFI_STATUS
1026 ExtractFormDefault (
1027   IN FORM_BROWSER_FORMSET             *FormSet,
1028   IN  FORM_BROWSER_FORM               *Form,
1029   IN UINT16                           DefaultId
1030   );
1031
1032 /**
1033   Initialize Question's Edit copy from Storage.
1034
1035   @param  Selection              Selection contains the information about
1036                                  the Selection, form and formset to be displayed.
1037                                  Selection action may be updated in retrieve callback.
1038   @param  FormSet                FormSet data structure.
1039   @param  Form                   Form data structure.
1040
1041   @retval EFI_SUCCESS            The function completed successfully.
1042
1043 **/
1044 EFI_STATUS
1045 LoadFormConfig (
1046   IN OUT UI_MENU_SELECTION    *Selection,
1047   IN FORM_BROWSER_FORMSET     *FormSet,
1048   IN FORM_BROWSER_FORM        *Form
1049   );
1050
1051 /**
1052   Initialize Question's Edit copy from Storage for the whole Formset.
1053
1054   @param  Selection              Selection contains the information about
1055                                  the Selection, form and formset to be displayed.
1056                                  Selection action may be updated in retrieve callback.
1057   @param  FormSet                FormSet data structure.
1058
1059   @retval EFI_SUCCESS            The function completed successfully.
1060
1061 **/
1062 EFI_STATUS
1063 LoadFormSetConfig (
1064   IN OUT UI_MENU_SELECTION    *Selection,
1065   IN     FORM_BROWSER_FORMSET *FormSet
1066   );
1067
1068 /**
1069   Convert setting of Buffer Storage or NameValue Storage to <ConfigResp>.
1070
1071   @param  Buffer                 The Storage to be conveted.
1072   @param  ConfigResp             The returned <ConfigResp>.
1073   @param  SingleForm             Whether update data for single form or formset level.
1074
1075   @retval EFI_SUCCESS            Convert success.
1076   @retval EFI_INVALID_PARAMETER  Incorrect storage type.
1077
1078 **/
1079 EFI_STATUS
1080 StorageToConfigResp (
1081   IN VOID                    *Buffer,
1082   IN CHAR16                  **ConfigResp,
1083   IN BOOLEAN                 SingleForm
1084   );
1085
1086 /**
1087   Convert <ConfigResp> to settings in Buffer Storage or NameValue Storage.
1088
1089   @param  Storage                The Storage to receive the settings.
1090   @param  ConfigResp             The <ConfigResp> to be converted.
1091
1092   @retval EFI_SUCCESS            Convert success.
1093   @retval EFI_INVALID_PARAMETER  Incorrect storage type.
1094
1095 **/
1096 EFI_STATUS
1097 ConfigRespToStorage (
1098   IN FORMSET_STORAGE         *Storage,
1099   IN CHAR16                  *ConfigResp
1100   );
1101
1102 /**
1103   Fill storage's edit copy with settings requested from Configuration Driver.
1104
1105   @param  FormSet                FormSet data structure.
1106   @param  Storage                Buffer Storage.
1107
1108   @retval EFI_SUCCESS            The function completed successfully.
1109
1110 **/
1111 EFI_STATUS
1112 LoadStorage (
1113   IN FORM_BROWSER_FORMSET    *FormSet,
1114   IN FORMSET_STORAGE         *Storage
1115   );
1116
1117 /**
1118   Fetch the Ifr binary data of a FormSet.
1119
1120   @param  Handle                 PackageList Handle
1121   @param  FormSetGuid            GUID of a formset. If not specified (NULL or zero
1122                                  GUID), take the first FormSet found in package
1123                                  list.
1124   @param  BinaryLength           The length of the FormSet IFR binary.
1125   @param  BinaryData             The buffer designed to receive the FormSet.
1126
1127   @retval EFI_SUCCESS            Buffer filled with the requested FormSet.
1128                                  BufferLength was updated.
1129   @retval EFI_INVALID_PARAMETER  The handle is unknown.
1130   @retval EFI_NOT_FOUND          A form or FormSet on the requested handle cannot
1131                                  be found with the requested FormId.
1132
1133 **/
1134 EFI_STATUS
1135 GetIfrBinaryData (
1136   IN  EFI_HII_HANDLE   Handle,
1137   IN OUT EFI_GUID      *FormSetGuid,
1138   OUT UINTN            *BinaryLength,
1139   OUT UINT8            **BinaryData
1140   );
1141
1142 /**
1143   Save globals used by previous call to SendForm(). SendForm() may be called from
1144   HiiConfigAccess.Callback(), this will cause SendForm() be reentried.
1145   So, save globals of previous call to SendForm() and restore them upon exit.
1146
1147 **/
1148 VOID
1149 SaveBrowserContext (
1150   VOID
1151   );
1152
1153 /**
1154   Restore globals used by previous call to SendForm().
1155
1156 **/
1157 VOID
1158 RestoreBrowserContext (
1159   VOID
1160   );
1161
1162 /**
1163   This is the routine which an external caller uses to direct the browser
1164   where to obtain it's information.
1165
1166
1167   @param This            The Form Browser protocol instanse.
1168   @param Handles         A pointer to an array of Handles.  If HandleCount > 1 we
1169                          display a list of the formsets for the handles specified.
1170   @param HandleCount     The number of Handles specified in Handle.
1171   @param FormSetGuid     This field points to the EFI_GUID which must match the Guid
1172                          field in the EFI_IFR_FORM_SET op-code for the specified
1173                          forms-based package. If FormSetGuid is NULL, then this
1174                          function will display the first found forms package.
1175   @param FormId          This field specifies which EFI_IFR_FORM to render as the first
1176                          displayable page. If this field has a value of 0x0000, then
1177                          the forms browser will render the specified forms in their encoded order.
1178                          ScreenDimenions - This allows the browser to be called so that it occupies a
1179                          portion of the physical screen instead of dynamically determining the screen dimensions.
1180                          ActionRequest   - Points to the action recommended by the form.
1181   @param ScreenDimensions Points to recommended form dimensions, including any non-content area, in
1182                           characters.
1183   @param ActionRequest       Points to the action recommended by the form.
1184
1185   @retval  EFI_SUCCESS            The function completed successfully.
1186   @retval  EFI_INVALID_PARAMETER  One of the parameters has an invalid value.
1187   @retval  EFI_NOT_FOUND          No valid forms could be found to display.
1188
1189 **/
1190 EFI_STATUS
1191 EFIAPI
1192 SendForm (
1193   IN  CONST EFI_FORM_BROWSER2_PROTOCOL *This,
1194   IN  EFI_HII_HANDLE                   *Handles,
1195   IN  UINTN                            HandleCount,
1196   IN  EFI_GUID                         *FormSetGuid, OPTIONAL
1197   IN  UINT16                           FormId, OPTIONAL
1198   IN  CONST EFI_SCREEN_DESCRIPTOR      *ScreenDimensions, OPTIONAL
1199   OUT EFI_BROWSER_ACTION_REQUEST       *ActionRequest  OPTIONAL
1200   );
1201
1202 /**
1203   This function is called by a callback handler to retrieve uncommitted state
1204   data from the browser.
1205
1206   @param  This                   A pointer to the EFI_FORM_BROWSER2_PROTOCOL
1207                                  instance.
1208   @param  ResultsDataSize        A pointer to the size of the buffer associated
1209                                  with ResultsData.
1210   @param  ResultsData            A string returned from an IFR browser or
1211                                  equivalent. The results string will have no
1212                                  routing information in them.
1213   @param  RetrieveData           A BOOLEAN field which allows an agent to retrieve
1214                                  (if RetrieveData = TRUE) data from the uncommitted
1215                                  browser state information or set (if RetrieveData
1216                                  = FALSE) data in the uncommitted browser state
1217                                  information.
1218   @param  VariableGuid           An optional field to indicate the target variable
1219                                  GUID name to use.
1220   @param  VariableName           An optional field to indicate the target
1221                                  human-readable variable name.
1222
1223   @retval EFI_SUCCESS            The results have been distributed or are awaiting
1224                                  distribution.
1225   @retval EFI_BUFFER_TOO_SMALL   The ResultsDataSize specified was too small to
1226                                  contain the results data.
1227
1228 **/
1229 EFI_STATUS
1230 EFIAPI
1231 BrowserCallback (
1232   IN CONST EFI_FORM_BROWSER2_PROTOCOL  *This,
1233   IN OUT UINTN                         *ResultsDataSize,
1234   IN OUT EFI_STRING                    ResultsData,
1235   IN BOOLEAN                           RetrieveData,
1236   IN CONST EFI_GUID                    *VariableGuid, OPTIONAL
1237   IN CONST CHAR16                      *VariableName  OPTIONAL
1238   );
1239
1240 /**
1241   Find menu which will show next time.
1242
1243   @param Selection       On input, Selection tell setup browser the information
1244                          about the Selection, form and formset to be displayed.
1245                          On output, Selection return the screen item that is selected
1246                          by user.
1247   @param Repaint         Whether need to repaint the menu.
1248   @param NewLine         Whether need to show at new line.
1249
1250   @retval TRUE           Need return.
1251   @retval FALSE          No need to return.
1252 **/
1253 BOOLEAN
1254 FindNextMenu (
1255   IN OUT UI_MENU_SELECTION    *Selection,
1256   IN     BOOLEAN              *Repaint,
1257   IN     BOOLEAN              *NewLine
1258   );
1259
1260 /**
1261   check whether the formset need to update the NV.
1262
1263   @param  FormSet                FormSet data structure.
1264   @param  SetValue               Whether set new value or clear old value.
1265
1266 **/
1267 VOID
1268 UpdateNvInfoInForm (
1269   IN FORM_BROWSER_FORMSET  *FormSet,
1270   IN BOOLEAN               SetValue
1271   );
1272
1273 /**
1274   check whether the formset need to update the NV.
1275
1276   @param  FormSet                FormSet data structure.
1277
1278   @retval TRUE                   Need to update the NV.
1279   @retval FALSE                  No need to update the NV.
1280 **/
1281 BOOLEAN
1282 IsNvUpdateRequired (
1283   IN FORM_BROWSER_FORMSET  *FormSet
1284   );
1285
1286 /**
1287   Call the call back function for the question and process the return action.
1288
1289   @param Selection             On input, Selection tell setup browser the information
1290                                about the Selection, form and formset to be displayed.
1291                                On output, Selection return the screen item that is selected
1292                                by user.
1293   @param Statement             The Question which need to call.
1294   @param Action                The action request.
1295   @param SkipSaveOrDiscard     Whether skip save or discard action.
1296
1297   @retval EFI_SUCCESS          The call back function excutes successfully.
1298   @return Other value if the call back function failed to excute.
1299 **/
1300 EFI_STATUS
1301 ProcessCallBackFunction (
1302   IN OUT UI_MENU_SELECTION               *Selection,
1303   IN     FORM_BROWSER_STATEMENT          *Question,
1304   IN     EFI_BROWSER_ACTION              Action,
1305   IN     BOOLEAN                         SkipSaveOrDiscard
1306   );
1307 #endif