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