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           NvUpdateRequired;     // Whether this form has NV update request.
 430
 431   LIST_ENTRY        ExpressionListHead;   // List of Expressions (FORM_EXPRESSION)
 432   LIST_ENTRY        StatementListHead;    // List of Statements and Questions (FORM_BROWSER_STATEMENT)
 433   LIST_ENTRY        ConfigRequestHead;    // List of configreques for all storage.
 434   FORM_EXPRESSION   *SuppressExpression;  // nesting inside of SuppressIf
 435 } FORM_BROWSER_FORM;
 436
 437 #define FORM_BROWSER_FORM_FROM_LINK(a)  CR (a, FORM_BROWSER_FORM, Link, FORM_BROWSER_FORM_SIGNATURE)
 438
 439 #define FORMSET_DEFAULTSTORE_SIGNATURE  SIGNATURE_32 ('F', 'D', 'F', 'S')
 440
 441 typedef struct {
 442   UINTN            Signature;
 443   LIST_ENTRY       Link;
 444
 445   UINT16           DefaultId;
 446   EFI_STRING_ID    DefaultName;
 447 } FORMSET_DEFAULTSTORE;
 448
 449 #define FORMSET_DEFAULTSTORE_FROM_LINK(a)  CR (a, FORMSET_DEFAULTSTORE, Link, FORMSET_DEFAULTSTORE_SIGNATURE)
 450
 451 typedef struct {
 452   EFI_HII_HANDLE                  HiiHandle;
 453   EFI_HANDLE                      DriverHandle;
 454   EFI_HII_CONFIG_ACCESS_PROTOCOL  *ConfigAccess;
 455   EFI_DEVICE_PATH_PROTOCOL        *DevicePath;
 456
 457   UINTN                           IfrBinaryLength;
 458   UINT8                           *IfrBinaryData;
 459
 460   EFI_GUID                        Guid;
 461   EFI_STRING_ID                   FormSetTitle;
 462   EFI_STRING_ID                   Help;
 463   UINT8                           NumberOfClassGuid;
 464   EFI_GUID                        ClassGuid[3];         // Up to three ClassGuid
 465   UINT16                          Class;                // Tiano extended Class code
 466   UINT16                          SubClass;             // Tiano extended Subclass code
 467   EFI_IMAGE_ID                    ImageId;
 468
 469   FORM_BROWSER_STATEMENT          *StatementBuffer;     // Buffer for all Statements and Questions
 470   EXPRESSION_OPCODE               *ExpressionBuffer;    // Buffer for all Expression OpCode
 471
 472   LIST_ENTRY                      StorageListHead;      // Storage list (FORMSET_STORAGE)
 473   LIST_ENTRY                      DefaultStoreListHead; // DefaultStore list (FORMSET_DEFAULTSTORE)
 474   LIST_ENTRY                      FormListHead;         // Form list (FORM_BROWSER_FORM)
 475   LIST_ENTRY                      ExpressionListHead;   // List of Expressions (FORM_EXPRESSION)
 476 } FORM_BROWSER_FORMSET;
 477
 478 #define BROWSER_CONTEXT_SIGNATURE  SIGNATURE_32 ('B', 'C', 'T', 'X')
 479
 480 typedef struct {
 481   UINTN                 Signature;
 482   LIST_ENTRY            Link;
 483
 484   //
 485   // Globals defined in Setup.c
 486   //
 487   BANNER_DATA           *BannerData;
 488   UINTN                 ClassOfVfr;
 489   UINTN                 FunctionKeySetting;
 490   BOOLEAN               ResetRequired;
 491   UINT16                Direction;
 492   EFI_SCREEN_DESCRIPTOR ScreenDimensions;
 493   CHAR16                *FunctionNineString;
 494   CHAR16                *FunctionTenString;
 495   CHAR16                *EnterString;
 496   CHAR16                *EnterCommitString;
 497   CHAR16                *EnterEscapeString;
 498   CHAR16                *EscapeString;
 499   CHAR16                *SaveFailed;
 500   CHAR16                *MoveHighlight;
 501   CHAR16                *MakeSelection;
 502   CHAR16                *DecNumericInput;
 503   CHAR16                *HexNumericInput;
 504   CHAR16                *ToggleCheckBox;
 505   CHAR16                *PromptForData;
 506   CHAR16                *PromptForPassword;
 507   CHAR16                *PromptForNewPassword;
 508   CHAR16                *ConfirmPassword;
 509   CHAR16                *ConfirmError;
 510   CHAR16                *PassowordInvalid;
 511   CHAR16                *PressEnter;
 512   CHAR16                *EmptyString;
 513   CHAR16                *AreYouSure;
 514   CHAR16                *YesResponse;
 515   CHAR16                *NoResponse;
 516   CHAR16                *MiniString;
 517   CHAR16                *PlusString;
 518   CHAR16                *MinusString;
 519   CHAR16                *AdjustNumber;
 520   CHAR16                *SaveChanges;
 521   CHAR16                *OptionMismatch;
 522   CHAR16                *FormSuppress;
 523   CHAR16                PromptBlockWidth;
 524   CHAR16                OptionBlockWidth;
 525   CHAR16                HelpBlockWidth;
 526   FORM_BROWSER_FORMSET  *OldFormSet;
 527
 528   //
 529   // Globals defined in Ui.c
 530   //
 531   LIST_ENTRY           MenuOption;
 532   VOID                 *MenuRefreshHead;
 533 } BROWSER_CONTEXT;
 534
 535 #define BROWSER_CONTEXT_FROM_LINK(a)  CR (a, BROWSER_CONTEXT, Link, BROWSER_CONTEXT_SIGNATURE)
 536
 537 extern EFI_HII_DATABASE_PROTOCOL         *mHiiDatabase;
 538 extern EFI_HII_STRING_PROTOCOL           *mHiiString;
 539 extern EFI_HII_CONFIG_ROUTING_PROTOCOL   *mHiiConfigRouting;
 540
 541 extern BANNER_DATA           *gBannerData;
 542 extern EFI_HII_HANDLE        gFrontPageHandle;
 543 extern UINTN                 gClassOfVfr;
 544 extern UINTN                 gFunctionKeySetting;
 545 extern BOOLEAN               gResetRequired;
 546 extern EFI_HII_HANDLE        gHiiHandle;
 547 extern UINT16                gDirection;
 548 extern EFI_SCREEN_DESCRIPTOR gScreenDimensions;
 549
 550 extern FORM_BROWSER_FORMSET  *gOldFormSet;
 551
 552 //
 553 // Browser Global Strings
 554 //
 555 extern CHAR16            *gFunctionNineString;
 556 extern CHAR16            *gFunctionTenString;
 557 extern CHAR16            *gEnterString;
 558 extern CHAR16            *gEnterCommitString;
 559 extern CHAR16            *gEnterEscapeString;
 560 extern CHAR16            *gEscapeString;
 561 extern CHAR16            *gSaveFailed;
 562 extern CHAR16            *gMoveHighlight;
 563 extern CHAR16            *gMakeSelection;
 564 extern CHAR16            *gDecNumericInput;
 565 extern CHAR16            *gHexNumericInput;
 566 extern CHAR16            *gToggleCheckBox;
 567 extern CHAR16            *gPromptForData;
 568 extern CHAR16            *gPromptForPassword;
 569 extern CHAR16            *gPromptForNewPassword;
 570 extern CHAR16            *gConfirmPassword;
 571 extern CHAR16            *gConfirmError;
 572 extern CHAR16            *gPassowordInvalid;
 573 extern CHAR16            *gPressEnter;
 574 extern CHAR16            *gEmptyString;
 575 extern CHAR16            *gAreYouSure;
 576 extern CHAR16            *gYesResponse;
 577 extern CHAR16            *gNoResponse;
 578 extern CHAR16            *gMiniString;
 579 extern CHAR16            *gPlusString;
 580 extern CHAR16            *gMinusString;
 581 extern CHAR16            *gAdjustNumber;
 582 extern CHAR16            *gSaveChanges;
 583 extern CHAR16            *gOptionMismatch;
 584 extern CHAR16            *gFormSuppress;
 585
 586 extern CHAR16            gPromptBlockWidth;
 587 extern CHAR16            gOptionBlockWidth;
 588 extern CHAR16            gHelpBlockWidth;
 589
 590 extern EFI_GUID          gZeroGuid;
 591 extern EFI_GUID          gTianoHiiIfrGuid;
 592
 593 #include "Ui.h"
 594 //
 595 // Global Procedure Defines
 596 //
 597
 598 /**
 599   Initialize the HII String Token to the correct values.
 600
 601 **/
 602 VOID
 603 InitializeBrowserStrings (
 604   VOID
 605   );
 606
 607 /**
 608   Prints a unicode string to the default console,
 609   using L"%s" format.
 610
 611   @param  String     String pointer.
 612
 613   @return Length of string printed to the console
 614
 615 **/
 616 UINTN
 617 PrintString (
 618   IN CHAR16       *String
 619   );
 620
 621 /**
 622   Prints a chracter to the default console,
 623   using L"%c" format.
 624
 625   @param  Character  Character to print.
 626
 627   @return Length of string printed to the console.
 628
 629 **/
 630 UINTN
 631 PrintChar (
 632   CHAR16       Character
 633   );
 634
 635 /**
 636   Prints a formatted unicode string to the default console, at
 637   the supplied cursor position.
 638
 639   @param  Column     The cursor position to print the string at.
 640   @param  Row        The cursor position to print the string at
 641   @param  Fmt        Format string
 642   @param  ...        Variable argument list for formating string.
 643
 644   @return Length of string printed to the console
 645
 646 **/
 647 UINTN
 648 EFIAPI
 649 PrintAt (
 650   IN UINTN     Column,
 651   IN UINTN     Row,
 652   IN CHAR16    *Fmt,
 653   ...
 654   );
 655
 656 /**
 657   Prints a unicode string to the default console, at
 658   the supplied cursor position, using L"%s" format.
 659
 660   @param  Column     The cursor position to print the string at.
 661   @param  Row        The cursor position to print the string at
 662   @param  String     String pointer.
 663
 664   @return Length of string printed to the console
 665
 666 **/
 667 UINTN
 668 PrintStringAt (
 669   IN UINTN     Column,
 670   IN UINTN     Row,
 671   IN CHAR16    *String
 672   );
 673
 674 /**
 675   Prints a chracter to the default console, at
 676   the supplied cursor position, using L"%c" format.
 677
 678   @param  Column     The cursor position to print the string at.
 679   @param  Row        The cursor position to print the string at.
 680   @param  Character  Character to print.
 681
 682   @return Length of string printed to the console.
 683
 684 **/
 685 UINTN
 686 PrintCharAt (
 687   IN UINTN     Column,
 688   IN UINTN     Row,
 689   CHAR16       Character
 690   );
 691
 692 /**
 693   Parse opcodes in the formset IFR binary.
 694
 695   @param  FormSet                Pointer of the FormSet data structure.
 696
 697   @retval EFI_SUCCESS            Opcode parse success.
 698   @retval Other                  Opcode parse fail.
 699
 700 **/
 701 EFI_STATUS
 702 ParseOpCodes (
 703   IN FORM_BROWSER_FORMSET              *FormSet
 704   );
 705
 706 /**
 707   Free resources allocated for a FormSet.
 708
 709   @param  FormSet                Pointer of the FormSet
 710
 711 **/
 712 VOID
 713 DestroyFormSet (
 714   IN OUT FORM_BROWSER_FORMSET  *FormSet
 715   );
 716
 717 /**
 718   This function displays the page frame.
 719
 720 **/
 721 VOID
 722 DisplayPageFrame (
 723   VOID
 724   );
 725
 726 /**
 727   Create a new string in HII Package List.
 728
 729   @param  String                 The String to be added
 730   @param  HiiHandle              The package list in the HII database to insert the
 731                                  specified string.
 732
 733   @return The output string.
 734
 735 **/
 736 EFI_STRING_ID
 737 NewString (
 738   IN  CHAR16                   *String,
 739   IN  EFI_HII_HANDLE           HiiHandle
 740   );
 741
 742 /**
 743   Delete a string from HII Package List.
 744
 745   @param  StringId               Id of the string in HII database.
 746   @param  HiiHandle              The HII package list handle.
 747
 748   @retval EFI_SUCCESS            The string was deleted successfully.
 749
 750 **/
 751 EFI_STATUS
 752 DeleteString (
 753   IN  EFI_STRING_ID            StringId,
 754   IN  EFI_HII_HANDLE           HiiHandle
 755   );
 756
 757 /**
 758   Get the string based on the StringId and HII Package List Handle.
 759
 760   @param  Token                  The String's ID.
 761   @param  HiiHandle              The package list in the HII database to search for
 762                                  the specified string.
 763
 764   @return The output string.
 765
 766 **/
 767 CHAR16 *
 768 GetToken (
 769   IN  EFI_STRING_ID                Token,
 770   IN  EFI_HII_HANDLE               HiiHandle
 771   );
 772
 773 /**
 774   Draw a pop up windows based on the dimension, number of lines and
 775   strings specified.
 776
 777   @param RequestedWidth  The width of the pop-up.
 778   @param NumberOfLines   The number of lines.
 779   @param Marker          The variable argument list for the list of string to be printed.
 780
 781 **/
 782 VOID
 783 CreateSharedPopUp (
 784   IN  UINTN                       RequestedWidth,
 785   IN  UINTN                       NumberOfLines,
 786   IN  VA_LIST                     Marker
 787   );
 788
 789 /**
 790   Routine used to abstract a generic dialog interface and return the selected key or string
 791
 792   @param  NumberOfLines          The number of lines for the dialog box
 793   @param  HotKey                 Defines whether a single character is parsed
 794                                  (TRUE) and returned in KeyValue or a string is
 795                                  returned in StringBuffer.  Two special characters
 796                                  are considered when entering a string, a SCAN_ESC
 797                                  and an CHAR_CARRIAGE_RETURN.  SCAN_ESC terminates
 798                                  string input and returns
 799   @param  MaximumStringSize      The maximum size in bytes of a typed in string
 800                                  (each character is a CHAR16) and the minimum
 801                                  string returned is two bytes
 802   @param  StringBuffer           The passed in pointer to the buffer which will
 803                                  hold the typed in string if HotKey is FALSE
 804   @param  KeyValue               The EFI_KEY value returned if HotKey is TRUE..
 805   @param  ...                    A series of (quantity == NumberOfLines) text
 806                                  strings which will be used to construct the dialog
 807                                  box
 808
 809   @retval EFI_SUCCESS            Displayed dialog and received user interaction
 810   @retval EFI_INVALID_PARAMETER  One of the parameters was invalid (e.g.
 811                                  (StringBuffer == NULL) && (HotKey == FALSE))
 812   @retval EFI_DEVICE_ERROR       User typed in an ESC character to exit the routine
 813
 814 **/
 815 EFI_STATUS
 816 EFIAPI
 817 CreateDialog (
 818   IN  UINTN                       NumberOfLines,
 819   IN  BOOLEAN                     HotKey,
 820   IN  UINTN                       MaximumStringSize,
 821   OUT CHAR16                      *StringBuffer,
 822   OUT EFI_INPUT_KEY               *KeyValue,
 823   ...
 824   );
 825
 826 /**
 827   Get Value for given Name from a NameValue Storage.
 828
 829   @param  Storage                The NameValue Storage.
 830   @param  Name                   The Name.
 831   @param  Value                  The retured Value.
 832
 833   @retval EFI_SUCCESS            Value found for given Name.
 834   @retval EFI_NOT_FOUND          No such Name found in NameValue storage.
 835
 836 **/
 837 EFI_STATUS
 838 GetValueByName (
 839   IN FORMSET_STORAGE         *Storage,
 840   IN CHAR16                  *Name,
 841   IN OUT CHAR16              **Value
 842   );
 843
 844 /**
 845   Set Value of given Name in a NameValue Storage.
 846
 847   @param  Storage                The NameValue Storage.
 848   @param  Name                   The Name.
 849   @param  Value                  The Value to set.
 850   @param  Edit                   Whether update editValue or Value.
 851
 852   @retval EFI_SUCCESS            Value found for given Name.
 853   @retval EFI_NOT_FOUND          No such Name found in NameValue storage.
 854
 855 **/
 856 EFI_STATUS
 857 SetValueByName (
 858   IN FORMSET_STORAGE         *Storage,
 859   IN CHAR16                  *Name,
 860   IN CHAR16                  *Value,
 861   IN BOOLEAN                 Edit
 862   );
 863
 864 /**
 865   Get Question's current Value.
 866
 867   @param  FormSet                FormSet data structure.
 868   @param  Form                   Form data structure.
 869   @param  Question               Question to be initialized.
 870   @param  Cached                 TRUE:  get from Edit copy FALSE: get from original
 871                                  Storage
 872
 873   @retval EFI_SUCCESS            The function completed successfully.
 874
 875 **/
 876 EFI_STATUS
 877 GetQuestionValue (
 878   IN FORM_BROWSER_FORMSET             *FormSet,
 879   IN FORM_BROWSER_FORM                *Form,
 880   IN OUT FORM_BROWSER_STATEMENT       *Question,
 881   IN BOOLEAN                          Cached
 882   );
 883
 884 /**
 885   Save Question Value to edit copy(cached) or Storage(uncached).
 886
 887   @param  FormSet                FormSet data structure.
 888   @param  Form                   Form data structure.
 889   @param  Question               Pointer to the Question.
 890   @param  Cached                 TRUE:  set to Edit copy FALSE: set to original
 891                                  Storage
 892
 893   @retval EFI_SUCCESS            The function completed successfully.
 894
 895 **/
 896 EFI_STATUS
 897 SetQuestionValue (
 898   IN FORM_BROWSER_FORMSET             *FormSet,
 899   IN FORM_BROWSER_FORM                *Form,
 900   IN OUT FORM_BROWSER_STATEMENT       *Question,
 901   IN BOOLEAN                          Cached
 902   );
 903
 904 /**
 905   Perform inconsistent check for a Form.
 906
 907   @param  FormSet                FormSet data structure.
 908   @param  Form                   Form data structure.
 909   @param  Question               The Question to be validated.
 910   @param  Type                   Validation type: InConsistent or NoSubmit
 911
 912   @retval EFI_SUCCESS            Form validation pass.
 913   @retval other                  Form validation failed.
 914
 915 **/
 916 EFI_STATUS
 917 ValidateQuestion (
 918   IN  FORM_BROWSER_FORMSET            *FormSet,
 919   IN  FORM_BROWSER_FORM               *Form,
 920   IN  FORM_BROWSER_STATEMENT          *Question,
 921   IN  UINTN                           Type
 922   );
 923
 924 /**
 925   Discard data for form level or formset level.
 926
 927   @param  FormSet                FormSet data structure.
 928   @param  Form                   Form data structure.
 929   @param  SingleForm             whether submit single form or formset.
 930
 931   @retval EFI_SUCCESS            The function completed successfully.
 932
 933 **/
 934 EFI_STATUS
 935 DiscardForm (
 936   IN FORM_BROWSER_FORMSET             *FormSet,
 937   IN FORM_BROWSER_FORM                *Form,
 938   IN BOOLEAN                          SingleForm
 939   );
 940
 941 /**
 942   Submit data for form level or formset level.
 943
 944   @param  FormSet                FormSet data structure.
 945   @param  Form                   Form data structure.
 946   @param  SingleForm             whether submit single form or formset.
 947
 948   @retval EFI_SUCCESS            The function completed successfully.
 949
 950 **/
 951 EFI_STATUS
 952 SubmitForm (
 953   IN FORM_BROWSER_FORMSET             *FormSet,
 954   IN FORM_BROWSER_FORM                *Form,
 955   IN BOOLEAN                          SingleForm
 956   );
 957
 958 /**
 959   Reset Question to its default value.
 960
 961   @param  FormSet                The form set.
 962   @param  Form                   The form.
 963   @param  Question               The question.
 964   @param  DefaultId              The Class of the default.
 965
 966   @retval EFI_SUCCESS            Question is reset to default value.
 967
 968 **/
 969 EFI_STATUS
 970 GetQuestionDefault (
 971   IN FORM_BROWSER_FORMSET             *FormSet,
 972   IN FORM_BROWSER_FORM                *Form,
 973   IN FORM_BROWSER_STATEMENT           *Question,
 974   IN UINT16                           DefaultId
 975   );
 976
 977 /**
 978   Get current setting of Questions.
 979
 980   @param  FormSet                FormSet data structure.
 981
 982   @retval EFI_SUCCESS            The function completed successfully.
 983
 984 **/
 985 EFI_STATUS
 986 InitializeCurrentSetting (
 987   IN OUT FORM_BROWSER_FORMSET             *FormSet
 988   );
 989
 990 /**
 991   Initialize the internal data structure of a FormSet.
 992
 993   @param  Handle                 PackageList Handle
 994   @param  FormSetGuid            GUID of a formset. If not specified (NULL or zero
 995                                  GUID), take the first FormSet found in package
 996                                  list.
 997   @param  FormSet                FormSet data structure.
 998
 999   @retval EFI_SUCCESS            The function completed successfully.
1000   @retval EFI_NOT_FOUND          The specified FormSet could not be found.
1001
1002 **/
1003 EFI_STATUS
1004 InitializeFormSet (
1005   IN  EFI_HII_HANDLE                   Handle,
1006   IN OUT EFI_GUID                      *FormSetGuid,
1007   OUT FORM_BROWSER_FORMSET             *FormSet
1008   );
1009
1010 /**
1011   Reset Questions in a Form to their default value.
1012
1013   @param  FormSet                FormSet data structure.
1014   @param  Form                   The Form which to be reset.
1015   @param  DefaultId              The Class of the default.
1016
1017   @retval EFI_SUCCESS            The function completed successfully.
1018
1019 **/
1020 EFI_STATUS
1021 ExtractFormDefault (
1022   IN FORM_BROWSER_FORMSET             *FormSet,
1023   IN  FORM_BROWSER_FORM               *Form,
1024   IN UINT16                           DefaultId
1025   );
1026
1027 /**
1028   Initialize Question's Edit copy from Storage.
1029
1030   @param  Selection              Selection contains the information about
1031                                  the Selection, form and formset to be displayed.
1032                                  Selection action may be updated in retrieve callback.
1033   @param  FormSet                FormSet data structure.
1034   @param  Form                   Form data structure.
1035
1036   @retval EFI_SUCCESS            The function completed successfully.
1037
1038 **/
1039 EFI_STATUS
1040 LoadFormConfig (
1041   IN OUT UI_MENU_SELECTION    *Selection,
1042   IN FORM_BROWSER_FORMSET     *FormSet,
1043   IN FORM_BROWSER_FORM        *Form
1044   );
1045
1046 /**
1047   Initialize Question's Edit copy from Storage for the whole Formset.
1048
1049   @param  Selection              Selection contains the information about
1050                                  the Selection, form and formset to be displayed.
1051                                  Selection action may be updated in retrieve callback.
1052   @param  FormSet                FormSet data structure.
1053
1054   @retval EFI_SUCCESS            The function completed successfully.
1055
1056 **/
1057 EFI_STATUS
1058 LoadFormSetConfig (
1059   IN OUT UI_MENU_SELECTION    *Selection,
1060   IN     FORM_BROWSER_FORMSET *FormSet
1061   );
1062
1063 /**
1064   Convert setting of Buffer Storage or NameValue Storage to <ConfigResp>.
1065
1066   @param  Buffer                 The Storage to be conveted.
1067   @param  ConfigResp             The returned <ConfigResp>.
1068   @param  SingleForm             Whether update data for single form or formset level.
1069
1070   @retval EFI_SUCCESS            Convert success.
1071   @retval EFI_INVALID_PARAMETER  Incorrect storage type.
1072
1073 **/
1074 EFI_STATUS
1075 StorageToConfigResp (
1076   IN VOID                    *Buffer,
1077   IN CHAR16                  **ConfigResp,
1078   IN BOOLEAN                 SingleForm
1079   );
1080
1081 /**
1082   Convert <ConfigResp> to settings in Buffer Storage or NameValue Storage.
1083
1084   @param  Storage                The Storage to receive the settings.
1085   @param  ConfigResp             The <ConfigResp> to be converted.
1086
1087   @retval EFI_SUCCESS            Convert success.
1088   @retval EFI_INVALID_PARAMETER  Incorrect storage type.
1089
1090 **/
1091 EFI_STATUS
1092 ConfigRespToStorage (
1093   IN FORMSET_STORAGE         *Storage,
1094   IN CHAR16                  *ConfigResp
1095   );
1096
1097 /**
1098   Fill storage's edit copy with settings requested from Configuration Driver.
1099
1100   @param  FormSet                FormSet data structure.
1101   @param  Storage                Buffer Storage.
1102
1103   @retval EFI_SUCCESS            The function completed successfully.
1104
1105 **/
1106 EFI_STATUS
1107 LoadStorage (
1108   IN FORM_BROWSER_FORMSET    *FormSet,
1109   IN FORMSET_STORAGE         *Storage
1110   );
1111
1112 /**
1113   Fetch the Ifr binary data of a FormSet.
1114
1115   @param  Handle                 PackageList Handle
1116   @param  FormSetGuid            GUID of a formset. If not specified (NULL or zero
1117                                  GUID), take the first FormSet found in package
1118                                  list.
1119   @param  BinaryLength           The length of the FormSet IFR binary.
1120   @param  BinaryData             The buffer designed to receive the FormSet.
1121
1122   @retval EFI_SUCCESS            Buffer filled with the requested FormSet.
1123                                  BufferLength was updated.
1124   @retval EFI_INVALID_PARAMETER  The handle is unknown.
1125   @retval EFI_NOT_FOUND          A form or FormSet on the requested handle cannot
1126                                  be found with the requested FormId.
1127
1128 **/
1129 EFI_STATUS
1130 GetIfrBinaryData (
1131   IN  EFI_HII_HANDLE   Handle,
1132   IN OUT EFI_GUID      *FormSetGuid,
1133   OUT UINTN            *BinaryLength,
1134   OUT UINT8            **BinaryData
1135   );
1136
1137 /**
1138   Save globals used by previous call to SendForm(). SendForm() may be called from
1139   HiiConfigAccess.Callback(), this will cause SendForm() be reentried.
1140   So, save globals of previous call to SendForm() and restore them upon exit.
1141
1142 **/
1143 VOID
1144 SaveBrowserContext (
1145   VOID
1146   );
1147
1148 /**
1149   Restore globals used by previous call to SendForm().
1150
1151 **/
1152 VOID
1153 RestoreBrowserContext (
1154   VOID
1155   );
1156
1157 /**
1158   This is the routine which an external caller uses to direct the browser
1159   where to obtain it's information.
1160
1161
1162   @param This            The Form Browser protocol instanse.
1163   @param Handles         A pointer to an array of Handles.  If HandleCount > 1 we
1164                          display a list of the formsets for the handles specified.
1165   @param HandleCount     The number of Handles specified in Handle.
1166   @param FormSetGuid     This field points to the EFI_GUID which must match the Guid
1167                          field in the EFI_IFR_FORM_SET op-code for the specified
1168                          forms-based package. If FormSetGuid is NULL, then this
1169                          function will display the first found forms package.
1170   @param FormId          This field specifies which EFI_IFR_FORM to render as the first
1171                          displayable page. If this field has a value of 0x0000, then
1172                          the forms browser will render the specified forms in their encoded order.
1173                          ScreenDimenions - This allows the browser to be called so that it occupies a
1174                          portion of the physical screen instead of dynamically determining the screen dimensions.
1175                          ActionRequest   - Points to the action recommended by the form.
1176   @param ScreenDimensions Points to recommended form dimensions, including any non-content area, in
1177                           characters.
1178   @param ActionRequest       Points to the action recommended by the form.
1179
1180   @retval  EFI_SUCCESS            The function completed successfully.
1181   @retval  EFI_INVALID_PARAMETER  One of the parameters has an invalid value.
1182   @retval  EFI_NOT_FOUND          No valid forms could be found to display.
1183
1184 **/
1185 EFI_STATUS
1186 EFIAPI
1187 SendForm (
1188   IN  CONST EFI_FORM_BROWSER2_PROTOCOL *This,
1189   IN  EFI_HII_HANDLE                   *Handles,
1190   IN  UINTN                            HandleCount,
1191   IN  EFI_GUID                         *FormSetGuid, OPTIONAL
1192   IN  UINT16                           FormId, OPTIONAL
1193   IN  CONST EFI_SCREEN_DESCRIPTOR      *ScreenDimensions, OPTIONAL
1194   OUT EFI_BROWSER_ACTION_REQUEST       *ActionRequest  OPTIONAL
1195   );
1196
1197 /**
1198   This function is called by a callback handler to retrieve uncommitted state
1199   data from the browser.
1200
1201   @param  This                   A pointer to the EFI_FORM_BROWSER2_PROTOCOL
1202                                  instance.
1203   @param  ResultsDataSize        A pointer to the size of the buffer associated
1204                                  with ResultsData.
1205   @param  ResultsData            A string returned from an IFR browser or
1206                                  equivalent. The results string will have no
1207                                  routing information in them.
1208   @param  RetrieveData           A BOOLEAN field which allows an agent to retrieve
1209                                  (if RetrieveData = TRUE) data from the uncommitted
1210                                  browser state information or set (if RetrieveData
1211                                  = FALSE) data in the uncommitted browser state
1212                                  information.
1213   @param  VariableGuid           An optional field to indicate the target variable
1214                                  GUID name to use.
1215   @param  VariableName           An optional field to indicate the target
1216                                  human-readable variable name.
1217
1218   @retval EFI_SUCCESS            The results have been distributed or are awaiting
1219                                  distribution.
1220   @retval EFI_BUFFER_TOO_SMALL   The ResultsDataSize specified was too small to
1221                                  contain the results data.
1222
1223 **/
1224 EFI_STATUS
1225 EFIAPI
1226 BrowserCallback (
1227   IN CONST EFI_FORM_BROWSER2_PROTOCOL  *This,
1228   IN OUT UINTN                         *ResultsDataSize,
1229   IN OUT EFI_STRING                    ResultsData,
1230   IN BOOLEAN                           RetrieveData,
1231   IN CONST EFI_GUID                    *VariableGuid, OPTIONAL
1232   IN CONST CHAR16                      *VariableName  OPTIONAL
1233   );
1234
1235 /**
1236   Find menu which will show next time.
1237
1238   @param Selection       On input, Selection tell setup browser the information
1239                          about the Selection, form and formset to be displayed.
1240                          On output, Selection return the screen item that is selected
1241                          by user.
1242   @param Repaint         Whether need to repaint the menu.
1243   @param NewLine         Whether need to show at new line.
1244
1245   @retval TRUE           Need return.
1246   @retval FALSE          No need to return.
1247 **/
1248 BOOLEAN
1249 FindNextMenu (
1250   IN OUT UI_MENU_SELECTION    *Selection,
1251   IN     BOOLEAN              *Repaint,
1252   IN     BOOLEAN              *NewLine
1253   );
1254
1255 /**
1256   check whether the formset need to update the NV.
1257
1258   @param  FormSet                FormSet data structure.
1259   @param  SetValue               Whether set new value or clear old value.
1260
1261 **/
1262 VOID
1263 UpdateNvInfoInForm (
1264   IN FORM_BROWSER_FORMSET  *FormSet,
1265   IN BOOLEAN               SetValue
1266   );
1267
1268 /**
1269   check whether the formset need to update the NV.
1270
1271   @param  FormSet                FormSet data structure.
1272
1273   @retval TRUE                   Need to update the NV.
1274   @retval FALSE                  No need to update the NV.
1275 **/
1276 BOOLEAN
1277 IsNvUpdateRequired (
1278   IN FORM_BROWSER_FORMSET  *FormSet
1279   );
1280
1281 /**
1282   Call the call back function for the question and process the return action.
1283
1284   @param Selection             On input, Selection tell setup browser the information
1285                                about the Selection, form and formset to be displayed.
1286                                On output, Selection return the screen item that is selected
1287                                by user.
1288   @param Statement             The Question which need to call.
1289   @param Action                The action request.
1290   @param SkipSaveOrDiscard     Whether skip save or discard action.
1291
1292   @retval EFI_SUCCESS          The call back function excutes successfully.
1293   @return Other value if the call back function failed to excute.
1294 **/
1295 EFI_STATUS
1296 ProcessCallBackFunction (
1297   IN OUT UI_MENU_SELECTION               *Selection,
1298   IN     FORM_BROWSER_STATEMENT          *Question,
1299   IN     EFI_BROWSER_ACTION              Action,
1300   IN     BOOLEAN                         SkipSaveOrDiscard
1301   );
1302 #endif