MdeModulePkg/Universal/DriverSampleDxe/Vfr.vfr

   1 ///** @file
   2 //
   3 //    Sample Setup formset.
   4 //
   5 //  Copyright (c) 2004 - 2014, Intel Corporation. All rights reserved.<BR>
   6 //  This program and the accompanying materials
   7 //  are licensed and made available under the terms and conditions of the BSD License
   8 //  which accompanies this distribution.  The full text of the license may be found at
   9 //  http://opensource.org/licenses/bsd-license.php
  10 //
  11 //  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12 //  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13 //
  14 //**/
  15
  16
  17 #include "NVDataStruc.h"
  18
  19 //
  20 // Formset class used by Device Manager
  21 //
  22 #define EFI_NON_DEVICE_CLASS              0x00
  23 #define EFI_DISK_DEVICE_CLASS             0x01
  24 #define EFI_VIDEO_DEVICE_CLASS            0x02
  25 #define EFI_NETWORK_DEVICE_CLASS          0x04
  26 #define EFI_INPUT_DEVICE_CLASS            0x08
  27 #define EFI_ON_BOARD_DEVICE_CLASS         0x10
  28 #define EFI_OTHER_DEVICE_CLASS            0x20
  29
  30 //
  31 // Formset subclass
  32 //
  33 #define EFI_SETUP_APPLICATION_SUBCLASS    0x00
  34 #define EFI_GENERAL_APPLICATION_SUBCLASS  0x01
  35 #define EFI_FRONT_PAGE_SUBCLASS           0x02
  36 #define EFI_SINGLE_USE_SUBCLASS           0x03
  37
  38 //
  39 // EFI Variable attributes
  40 //
  41 #define EFI_VARIABLE_NON_VOLATILE       0x00000001
  42 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x00000002
  43 #define EFI_VARIABLE_RUNTIME_ACCESS     0x00000004
  44 #define EFI_VARIABLE_READ_ONLY          0x00000008
  45
  46 #define EFI_USER_INFO_ACCESS_SETUP_ADMIN_GUID \
  47   { 0x85b75607, 0xf7ce, 0x471e, { 0xb7, 0xe4, 0x2a, 0xea, 0x5f, 0x72, 0x32, 0xee } }
  48
  49 #define PERL_GUID \
  50   { 0x63E60A51, 0x497D, 0xD427, {0xC4, 0xA5, 0xB8, 0xAB, 0xDC, 0x3A, 0xAE, 0xB6 }}
  51
  52 //
  53 // Labels definition
  54 //
  55 #define LABEL_1_VALUE               0x01
  56 #define LABEL_2_VALUE               0x1000
  57 #define LABEL_UPDATE_BBS            0x2222
  58
  59 formset
  60   guid      = DRIVER_SAMPLE_FORMSET_GUID,
  61   title     = STRING_TOKEN(STR_FORM_SET_TITLE),
  62   help      = STRING_TOKEN(STR_FORM_SET_TITLE_HELP),
  63   classguid = EFI_HII_PLATFORM_SETUP_FORMSET_GUID,
  64
  65   //
  66   // Notes: VfrCompiler will insert a Standard Default Storage declaration
  67   // after the formset declaration.    >00000040: 5C 06 00 00 00 00.
  68   // So we don't need to declare the Standard Default.
  69   // Please check the vfr.lst file for details.
  70   // To enable list file for VFR, add "-l" to VfrCompile <Command> in [Build.Visual-Form-Representation-File] as follows:
  71   //          VfrCompile -l --no-pre-processing --output-directory ${d_path} $(OUTPUT_DIR)(+)${s_dir}(+)${s_base}.iii
  72   //
  73
  74    //
  75   // Define a Buffer Storage (EFI_IFR_VARSTORE)
  76   //
  77   varstore DRIVER_SAMPLE_CONFIGURATION,     // This is the data structure type
  78     varid = CONFIGURATION_VARSTORE_ID,      // Optional VarStore ID
  79     name  = MyIfrNVData,                    // Define referenced name in vfr
  80     guid  = DRIVER_SAMPLE_FORMSET_GUID;     // GUID of this buffer storage
  81
  82   //
  83   // Define a EFI variable Storage (EFI_IFR_VARSTORE_EFI)
  84   //
  85   efivarstore MY_EFI_VARSTORE_DATA,
  86     attribute = EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_NON_VOLATILE,  // EFI variable attribures
  87     name  = MyEfiVar,
  88     guid  = DRIVER_SAMPLE_FORMSET_GUID;
  89
  90   //
  91   // Define a Name/Value Storage (EFI_IFR_VARSTORE_NAME_VALUE)
  92   //
  93   namevaluevarstore MyNameValueVar,                // Define storage reference name in vfr
  94     name = STRING_TOKEN(STR_NAME_VALUE_VAR_NAME0), // Define Name list of this storage, refer it by MyNameValueVar[0]
  95     name = STRING_TOKEN(STR_NAME_VALUE_VAR_NAME1), // Define Name list of this storage, refer it by MyNameValueVar[1]
  96     name = STRING_TOKEN(STR_NAME_VALUE_VAR_NAME2), // Define Name list of this storage, refer it by MyNameValueVar[2]
  97     guid = DRIVER_SAMPLE_FORMSET_GUID;             // GUID of this Name/Value storage
  98
  99   defaultstore MyStandardDefault,
 100     prompt      = STRING_TOKEN(STR_STANDARD_DEFAULT_PROMPT),
 101     attribute   = 0x0000;                         // Default ID: 0000 standard default
 102
 103   defaultstore MyManufactureDefault,
 104     prompt      = STRING_TOKEN(STR_MANUFACTURE_DEFAULT_PROMPT),
 105     attribute   = 0x0001;                         // Default ID: 0001 manufacture default
 106
 107   //
 108   // Define a Form (EFI_IFR_FORM)
 109   //
 110   form formid = 1,                                // Form ID
 111        title  = STRING_TOKEN(STR_FORM1_TITLE);    // Form title
 112
 113     subtitle text = STRING_TOKEN(STR_SUBTITLE_TEXT);
 114
 115     subtitle text = STRING_TOKEN(STR_SUBTITLE_TEXT2);
 116
 117     //
 118     // Define a display only text (EFI_IFR_TEXT)
 119     //
 120     text
 121       help   = STRING_TOKEN(STR_TEXT_HELP),       // Help string
 122       text   = STRING_TOKEN(STR_CPU_STRING),      // Prompt string
 123         text   = STRING_TOKEN(STR_CPU_STRING2);   // TextTwo
 124
 125     //
 126     // Define action button (EFI_IFR_ACTION)
 127     //
 128     text
 129       help   = STRING_TOKEN(STR_EXIT_TEXT),
 130       text   = STRING_TOKEN(STR_EXIT_TEXT),
 131       flags  = INTERACTIVE,   // VfrCompiler will generate opcode EFI_IFR_ACTION for Text marked as INTERACTIVE
 132       key    = 0x1237;
 133
 134     text
 135       help   = STRING_TOKEN(STR_SAVE_TEXT),
 136       text   = STRING_TOKEN(STR_SAVE_TEXT),
 137       flags  = INTERACTIVE,
 138       key    = 0x1238;
 139
 140     text
 141       help   = STRING_TOKEN(STR_SAVE_CURRENT),
 142       text   = STRING_TOKEN(STR_SAVE_CURRENT),
 143       flags  = INTERACTIVE,
 144       key    = 0x1243;
 145
 146     text
 147       help   = STRING_TOKEN(STR_DISCARD_CURRENT_AND_EXIT),
 148       text   = STRING_TOKEN(STR_DISCARD_CURRENT_AND_EXIT),
 149       flags  = INTERACTIVE,
 150       key    = 0x1244;
 151     //
 152     // Define oneof (EFI_IFR_ONE_OF)
 153     //
 154     oneof name = MyOneOf,                                // Define reference name for Question
 155       varid   = MyIfrNVData.SuppressGrayOutSomething,    // Use "DataStructure.Member" to reference Buffer Storage
 156       prompt  = STRING_TOKEN(STR_ONE_OF_PROMPT),
 157       help    = STRING_TOKEN(STR_ONE_OF_HELP),
 158       //
 159       // Define an option (EFI_IFR_ONE_OF_OPTION)
 160       //
 161       option text = STRING_TOKEN(STR_ONE_OF_TEXT4), value = 0x0, flags = 0;
 162       option text = STRING_TOKEN(STR_ONE_OF_TEXT5), value = 0x1, flags = 0;
 163       //
 164       // DEFAULT indicate this option will be marked with EFI_IFR_OPTION_DEFAULT
 165       //
 166       option text = STRING_TOKEN(STR_ONE_OF_TEXT6), value = 0x2, flags = DEFAULT;
 167     endoneof;
 168
 169     oneof varid  = MyIfrNVData.BootOrderLarge,
 170       prompt      = STRING_TOKEN(STR_ONE_OF_PROMPT),
 171       help        = STRING_TOKEN(STR_ONE_OF_HELP),
 172       default value = cond (pushthis == 0 ? 0 : cond ((questionref(MyOneOf) >> 0x4 & 0xF00) == 0x0 + 0x2 ? 0 : 1)),
 173       option text = STRING_TOKEN(STR_BOOT_ORDER1), value = 0x0, flags = 0;
 174       option text = STRING_TOKEN(STR_BOOT_ORDER2), value = 0x1, flags = 0;
 175     endoneof;
 176
 177     grayoutif  ideqval MyIfrNVData.SuppressGrayOutSomething == 0x1;
 178       suppressif questionref(MyOneOf) == 0x0;
 179
 180         checkbox varid   = MyIfrNVData.ChooseToActivateNuclearWeaponry,
 181                  prompt   = STRING_TOKEN(STR_CHECK_BOX_PROMPT),
 182                  help     = STRING_TOKEN(STR_CHECK_BOX_HELP),
 183                  //
 184                  // CHECKBOX_DEFAULT indicate this checkbox is marked with EFI_IFR_CHECKBOX_DEFAULT
 185                  // CHECKBOX_DEFAULT_MFG indicate EFI_IFR_CHECKBOX_DEFAULT_MFG.
 186                  //
 187                  flags    = CHECKBOX_DEFAULT | CHECKBOX_DEFAULT_MFG,
 188                  default  = TRUE,
 189         endcheckbox;
 190       endif;
 191     endif;
 192
 193     //
 194     // Ordered list:
 195     //   sizeof(MyIfrNVData) storage must be UINT8 array, and
 196     //   size written for the variable must be size of the entire
 197     //   variable.
 198     //
 199     //
 200     suppressif ideqval MyIfrNVData.SuppressGrayOutSomething == 0x0;
 201
 202       //
 203       // label is defined as an anchor where you want to insert some dynamic
 204       // opcodes created on-the-fly
 205       //
 206       label LABEL_UPDATE_BBS;
 207
 208       orderedlist
 209                 varid       = MyIfrNVData.BootOrder,
 210                 prompt      = STRING_TOKEN(STR_BOOT_OPTIONS),
 211                 help        = STRING_TOKEN(STR_NULL_STRING),
 212                 flags       = RESET_REQUIRED,
 213                 option text = STRING_TOKEN(STR_BOOT_OPTION2), value = 2, flags = 0;
 214                 option text = STRING_TOKEN(STR_BOOT_OPTION1), value = 1, flags = 0;
 215                 option text = STRING_TOKEN(STR_BOOT_OPTION3), value = 3, flags = 0;
 216               suppressif ideqval MyIfrNVData.BootOrderLarge == 0;
 217                 option text = STRING_TOKEN(STR_BOOT_OPTION4), value = 4, flags = 0;
 218               endif
 219       endlist;
 220
 221       //
 222       // label should be paired with each other
 223       //
 224       label LABEL_END;
 225
 226     endif;    // end suppressif
 227
 228     disableif ideqval MyIfrNVData.SuppressGrayOutSomething == 0x2;
 229       orderedlist
 230         varid       = MyIfrNVData.OrderedList,
 231         prompt      = STRING_TOKEN(STR_TEST_OPCODE),
 232         help        = STRING_TOKEN(STR_TEXT_HELP),
 233         flags       = RESET_REQUIRED,
 234         option text = STRING_TOKEN(STR_ONE_OF_TEXT1), value = 3, flags = 0;
 235         option text = STRING_TOKEN(STR_ONE_OF_TEXT2), value = 2, flags = 0;
 236         option text = STRING_TOKEN(STR_ONE_OF_TEXT3), value = 1, flags = 0;
 237       endlist;
 238     endif;
 239
 240     label 100;
 241
 242     //
 243     // Define a hyperlink (EFI_IFR_REF)
 244     //
 245     goto 0x1234,                                  // Destination Form ID
 246       prompt  = STRING_TOKEN(STR_GOTO_DYNAMIC),   // Prompt string
 247       help    = STRING_TOKEN(STR_GOTO_HELP),      // Help string
 248       flags   = INTERACTIVE,                      // INTERACTIVE indicate it's marked with EFI_IFR_FLAG_CALLBACK
 249       key     = 0x1234;                           // Question ID which will be passed-in in COnfigAccess.Callback()
 250
 251     goto 0x1234,
 252       prompt  = STRING_TOKEN(STR_GOTO_DYNAMIC2),
 253       help    = STRING_TOKEN(STR_GOTO_HELP),
 254       flags   = INTERACTIVE,
 255       key     = 0x1235;
 256
 257     oneof varid  = MyIfrNVData.TestLateCheck,
 258       prompt      = STRING_TOKEN(STR_TEST_OPCODE),
 259       help        = STRING_TOKEN(STR_ONE_OF_HELP),
 260       flags       = RESET_REQUIRED,
 261       option text = STRING_TOKEN(STR_ONE_OF_TEXT1), value = 0, flags = 0;
 262       option text = STRING_TOKEN(STR_ONE_OF_TEXT2), value = 1, flags = DEFAULT;
 263       warningif prompt = STRING_TOKEN(STR_WARNING_POPUP), timeout = 5,
 264         ideqval MyIfrNVData.TestLateCheck == 0
 265       endif
 266
 267     endoneof;
 268
 269     oneof varid  = MyIfrNVData.TestLateCheck2,
 270       prompt      = STRING_TOKEN(STR_TEST_OPCODE2),
 271       help        = STRING_TOKEN(STR_ONE_OF_HELP),
 272       flags       = RESET_REQUIRED,
 273       option text = STRING_TOKEN(STR_ONE_OF_TEXT1), value = 0, flags = DEFAULT;
 274       option text = STRING_TOKEN(STR_ONE_OF_TEXT2), value = 1, flags = 0;
 275
 276       inconsistentif prompt = STRING_TOKEN(STR_ERROR_POPUP),
 277         ideqid MyIfrNVData.TestLateCheck == MyIfrNVData.TestLateCheck2
 278       endif
 279
 280     endoneof;
 281
 282     oneof varid  = MyIfrNVData.QuestionAboutTreeHugging,
 283       prompt      = STRING_TOKEN(STR_ONE_OF_PROMPT),
 284       help        = STRING_TOKEN(STR_ONE_OF_HELP),
 285       flags       = RESET_REQUIRED,
 286       option text = STRING_TOKEN(STR_ONE_OF_TEXT1), value = 0, flags = 0;
 287       option text = STRING_TOKEN(STR_ONE_OF_TEXT2), value = 1, flags = DEFAULT;
 288       option text = STRING_TOKEN(STR_ONE_OF_TEXT3), value = 3, flags = 0;
 289     endoneof;
 290
 291     //
 292     // Define a string (EFI_IFR_STRING)
 293     //
 294     string    varid    = MyIfrNVData.MyStringData,
 295               prompt   = STRING_TOKEN(STR_MY_STRING_PROMPT2),
 296               help     = STRING_TOKEN(STR_MY_STRING_HELP2),
 297               flags    = INTERACTIVE,
 298               key      = 0x1236,
 299               minsize  = 6,
 300               maxsize  = 40,
 301               inconsistentif prompt = STRING_TOKEN(STR_STRING_CHECK_ERROR_POPUP),
 302                 pushthis != stringref(STRING_TOKEN(STR_STRING_CHECK))
 303               endif
 304     endstring;
 305
 306     //
 307     // Define a numeric (EFI_IFR_NUMERIC)
 308     //
 309     numeric varid   = MyIfrNVData.HowOldAreYouInYearsManual,
 310             prompt  = STRING_TOKEN(STR_NUMERIC_READONLY_PROMPT),
 311             help    = STRING_TOKEN(STR_NUMERIC_HELP0),
 312             flags   = READ_ONLY,  // READ_ONLY indicate it's marked with EFI_IFR_FLAG_READ_ONLY
 313             minimum = 0,
 314             maximum = 0xf0,
 315             step    = 0,          // Stepping of 0 equates to a manual entering
 316                                   // of a value, otherwise it will be adjusted by "+"/"-"
 317             default = 21,         // defaultstore could be used to specify the default type
 318                                   // If no defaultstore is specified, it implies Standard Default
 319
 320     endnumeric;
 321
 322     numeric varid   = MyIfrNVData.HowOldAreYouInYearsManual,
 323             prompt  = STRING_TOKEN(STR_NUMERIC_MANUAL_PROMPT),
 324             help    = STRING_TOKEN(STR_NUMERIC_HELP0),
 325             minimum = 0,
 326             maximum = 0xf0,
 327             step    = 0,
 328             default value = questionrefval(devicepath = STRING_TOKEN (STR_DEVICE_PATH), guid = DRIVER_SAMPLE_FORMSET_GUID, 0x1111),
 329
 330             inconsistentif prompt = STRING_TOKEN(STR_ERROR_POPUP),
 331               ideqval MyIfrNVData.HowOldAreYouInYearsManual == 99
 332               OR
 333               ideqid  MyIfrNVData.HowOldAreYouInYearsManual == MyEfiVar.Field8
 334               OR
 335               ideqvallist MyIfrNVData.HowOldAreYouInYearsManual == 1 3 5 7
 336             endif
 337
 338     endnumeric;
 339
 340     numeric varid   = MyEfiVar.Field8,                    // Reference of EFI variable storage
 341             questionid  = 0x1111,
 342             prompt  = STRING_TOKEN(STR_TALL_HEX_PROMPT),
 343             help    = STRING_TOKEN(STR_NUMERIC_HELP1),
 344             flags   = DISPLAY_UINT_HEX | INTERACTIVE,     // Display in HEX format (if not specified, default is in decimal format)
 345             minimum = 0,
 346             maximum = 250,
 347             default = 18, defaultstore = MyStandardDefault,     // This is standard default value
 348             default = 19, defaultstore = MyManufactureDefault,  // This is manufacture default value
 349
 350     endnumeric;
 351
 352     //
 353     // Define numeric using Name/Value Storage
 354     //
 355     numeric varid   = MyNameValueVar[0],     // This numeric take NameValueVar0 as storage
 356             prompt  = STRING_TOKEN(STR_NAME_VALUE_VAR_NAME0),
 357             help    = STRING_TOKEN(STR_NAME_VALUE_VAR_NAME0_HELP),
 358             //
 359             // Size should be defined for numeric when use Name/Value storage
 360             // Valid value for numerice size are: NUMERIC_SIZE_1, NUMERIC_SIZE_2, NUMERIC_SIZE_4 and NUMERIC_SIZE_8
 361             //
 362             flags   = NUMERIC_SIZE_1,        // Size of this numeric is 1 byte
 363             minimum = 0,
 364             maximum = 0xff,
 365             step    = 0,
 366             locked,
 367             default = 16, defaultstore = MyStandardDefault,     // This is standard default value
 368             default = 17, defaultstore = MyManufactureDefault,  // This is manufacture default value
 369     endnumeric;
 370
 371     numeric varid   = MyNameValueVar[1],     // This numeric take NameValueVar1 as storage
 372             prompt  = STRING_TOKEN(STR_NAME_VALUE_VAR_NAME1),
 373             help    = STRING_TOKEN(STR_NAME_VALUE_VAR_NAME1_HELP),
 374             flags   = NUMERIC_SIZE_2,        // Size of this numeric is 2 bytes
 375             minimum = 0,
 376             maximum = 0xffff,
 377             step    = 0,
 378             default = 18, defaultstore = MyStandardDefault,     // This is standard default value
 379             default = 19, defaultstore = MyManufactureDefault,  // This is manufacture default value
 380     endnumeric;
 381
 382     //
 383     // Define string using Name/Value Storage
 384     //
 385     string    varid    = MyNameValueVar[2],     // This string take NameValueVar2 as storage
 386               prompt   = STRING_TOKEN(STR_NAME_VALUE_VAR_NAME2),
 387               help     = STRING_TOKEN(STR_NAME_VALUE_VAR_NAME2_HELP),
 388               minsize  = 2,
 389               maxsize  = 0x14,
 390     endstring;
 391
 392     oneof varid   = MyEfiVar.Field16,
 393       prompt      = STRING_TOKEN(STR_ONE_OF_PROMPT),
 394       help        = STRING_TOKEN(STR_NUMERIC_NUM_HELP),
 395       option text = STRING_TOKEN(STR_BOOT_ORDER1), value = 0x0, flags = 0;
 396       option text = STRING_TOKEN(STR_BOOT_ORDER2), value = 0x1, flags = DEFAULT;
 397     endoneof;
 398
 399     label LABEL_1_VALUE;
 400     label LABEL_2_VALUE;
 401
 402     grayoutif  ideqval MyIfrNVData.HowOldAreYouInYearsManual == 23 AND ideqval MyIfrNVData.SuppressGrayOutSomething == 0x1;
 403       numeric varid   = MyIfrNVData.HowOldAreYouInYears,
 404               prompt  = STRING_TOKEN(STR_NUMERIC_STEP_PROMPT),
 405               help    = STRING_TOKEN(STR_NUMERIC_HELP2),
 406               minimum = 0,
 407               maximum = 243,
 408               step    = 1,
 409               default = 18, defaultstore = MyStandardDefault,     // This is standard default value
 410               default = 19, defaultstore = MyManufactureDefault,  // This is manufacture default value
 411
 412       endnumeric;
 413     endif;
 414
 415     numeric varid   = MyIfrNVData.GetDefaultValueFromAccess,
 416             questionid = 0x1239,
 417             prompt  = STRING_TOKEN(STR_DEFAULT_VALUE_FROM_ACCESS_PROMPT),
 418             help    = STRING_TOKEN(STR_DEFAULT_VALUE_FROM_ACCESS_HELP),
 419             flags   = DISPLAY_UINT_HEX | INTERACTIVE,
 420             minimum = 0,
 421             maximum = 255,
 422             step    = 1,
 423             default = 18,
 424     endnumeric;
 425
 426     numeric varid   = MyIfrNVData.GetDefaultValueFromCallBack,
 427             questionid = 0x1240,
 428             prompt  = STRING_TOKEN(STR_DEFAULT_VALUE_FROM_CALLBACK_PROMPT),
 429             help    = STRING_TOKEN(STR_DEFAULT_VALUE_FROM_CALLBACK_HELP),
 430             flags   = DISPLAY_UINT_HEX | INTERACTIVE,
 431             minimum = 0,
 432             maximum = 255,
 433             step    = 1,
 434             default = 18,
 435     endnumeric;
 436
 437     resetbutton
 438       defaultstore = MyStandardDefault,
 439       prompt   = STRING_TOKEN(STR_STANDARD_DEFAULT_PROMPT),
 440       help     = STRING_TOKEN(STR_STANDARD_DEFAULT_HELP),
 441     endresetbutton;
 442
 443     resetbutton
 444       defaultstore = MyManufactureDefault,
 445       prompt   = STRING_TOKEN(STR_MANUFACTURE_DEFAULT_PROMPT),
 446       help     = STRING_TOKEN(STR_MANUFACTURE_DEFAULT_HELP),
 447     endresetbutton;
 448
 449     //
 450     // Non-interactive password, validate by Setup Browser
 451     //
 452     password  varid    = MyIfrNVData.WhatIsThePassword,
 453               prompt   = STRING_TOKEN(STR_PASSWORD_PROMPT),
 454               help     = STRING_TOKEN(STR_PASSWORD_HELP),
 455               minsize  = 6,
 456               maxsize  = 20,
 457     endpassword;
 458
 459     string    varid    = MyIfrNVData.PasswordClearText,
 460               prompt   = STRING_TOKEN(STR_MY_STRING_PROMPT),
 461               help     = STRING_TOKEN(STR_MY_STRING_HELP),
 462               minsize  = 6,
 463               maxsize  = 0x14,
 464     endstring;
 465
 466     //
 467     // Interactive password, validate via ConfigAccess.Callback()
 468     //
 469     password  varid    = MyIfrNVData.WhatIsThePassword2,
 470               prompt   = STRING_TOKEN(STR_PASSWORD_CALLBACK_PROMPT),
 471               help     = STRING_TOKEN(STR_PASSWORD_HELP),
 472               flags    = INTERACTIVE,
 473               key      = 0x2000,
 474               minsize  = 6,
 475               maxsize  = 20,
 476     endpassword;
 477
 478     //
 479     // Sample use case for IFR Security op-code
 480     //
 481     grayoutif NOT security (EFI_USER_INFO_ACCESS_SETUP_ADMIN_GUID);
 482       text
 483         help = STRING_TOKEN(STR_TEXT_SECRUITY_TEST_HELP),
 484         text = STRING_TOKEN(STR_TEXT_SECRUITY_TEST_TEXT);
 485     endif;
 486
 487     goto 2,
 488       prompt = STRING_TOKEN(STR_GOTO_FORM2), //SecondSetupPage  // this too has no end-op and basically it's a jump to a form ONLY
 489       help   = STRING_TOKEN(STR_GOTO_HELP);
 490
 491     goto 3,
 492       prompt = STRING_TOKEN(STR_GOTO_FORM3), //ThirdSetupPage  // this too has no end-op and basically it's a jump to a form ONLY
 493       help   = STRING_TOKEN(STR_GOTO_HELP);
 494
 495     goto 4,
 496       prompt = STRING_TOKEN(STR_GOTO_FORM4), //FourthSetupPage  // this too has no end-op and basically it's a jump to a form ONLY
 497       help   = STRING_TOKEN(STR_GOTO_HELP);
 498
 499     goto 5,
 500       prompt = STRING_TOKEN(STR_GOTO_FORM5), //FifthSetupPage  // this too has no end-op and basically it's a jump to a form ONLY
 501       help   = STRING_TOKEN(STR_GOTO_FORM5_HELP);
 502
 503     goto 6,
 504       prompt = STRING_TOKEN(STR_GOTO_FORM6), //SixthSetupPage  // this too has no end-op and basically it's a jump to a form ONLY
 505       help   = STRING_TOKEN(STR_GOTO_HELP);
 506
 507     goto
 508       formsetguid = DRIVER_SAMPLE_INVENTORY_GUID,
 509       formid  = 0x1,
 510       question = 0x1,
 511       prompt  = STRING_TOKEN(STR_GOTO_ANOTHER_FORMSET),
 512       help    = STRING_TOKEN(STR_GOTO_ANOTHER_FORMSET_HELP);
 513
 514     guidop
 515       guid = DRIVER_SAMPLE_FORMSET_GUID,
 516       datatype = MY_EFI_VARSTORE_DATA,
 517         data.Field8  = 0x21,
 518         data.Field16 = 0x2121,
 519         data.OrderedList[0] = 0x21,
 520     endguidop;
 521
 522
 523   endform;
 524
 525   suppressif ideqval MyIfrNVData.BootOrderLarge == 0;
 526     form formid = 2,               // SecondSetupPage,
 527       title = STRING_TOKEN(STR_FORM2_TITLE);  // note formid is a variable (for readability) (UINT16) - also added Form to the line to signify the Op-Code
 528
 529       date
 530         name    = Date,
 531         prompt  = STRING_TOKEN(STR_DATE_PROMPT),
 532         help    = STRING_TOKEN(STR_DATE_HELP),
 533         flags   = STORAGE_TIME,
 534         default = 2004/1/1,
 535
 536         inconsistentif prompt = STRING_TOKEN(STR_ERROR_POPUP),
 537           ideqval Date.Day == 31
 538           AND
 539           ideqvallist Date.Month == 2 4 6 9 11
 540         endif
 541
 542         //
 543         // If the day is 30 AND month is 2
 544         //
 545         inconsistentif prompt = STRING_TOKEN(STR_ERROR_POPUP),
 546           ideqval Date.Day == 30
 547           AND
 548           ideqval Date.Month == 2
 549         endif
 550
 551         //
 552         // If the day is 29 AND month is 2 AND it year is NOT a leapyear
 553         //
 554         inconsistentif prompt = STRING_TOKEN(STR_ERROR_POPUP),
 555           ideqval Date.Day == 0x1D
 556           AND
 557           ideqval Date.Month == 2
 558           AND
 559           NOT
 560           ideqvallist Date.Year == 2004 2008 20012 20016 2020 2024 2028 2032 2036
 561         endif
 562
 563       enddate;
 564
 565       text
 566         help   = STRING_TOKEN(STR_SAVE_CURRENT_AND_EXIT),
 567         text   = STRING_TOKEN(STR_SAVE_CURRENT_AND_EXIT),
 568         flags  = INTERACTIVE,
 569         key    = 0x1241;
 570
 571       text
 572         help   = STRING_TOKEN(STR_DISCARD_CURRENT),
 573         text   = STRING_TOKEN(STR_DISCARD_CURRENT),
 574         flags  = INTERACTIVE,
 575         key    = 0x1242;
 576
 577       time
 578         prompt  = STRING_TOKEN(STR_TIME_PROMPT),
 579         help    = STRING_TOKEN(STR_TIME_HELP),
 580         flags   = STORAGE_TIME,
 581       endtime;
 582
 583       time
 584             name    = MyTime,
 585             varid   = MyIfrNVData.Time,
 586             prompt  = STRING_TOKEN(STR_TIME_PROMPT),
 587             help    = STRING_TOKEN(STR_TIME_PROMPT),
 588             flags   = STORAGE_NORMAL | SECOND_SUPPRESS,
 589             default = 15:33:33,
 590       endtime;
 591
 592       checkbox varid   = MyIfrNVData.ChooseToActivateNuclearWeaponry,
 593               prompt   = STRING_TOKEN(STR_CHECK_BOX_PROMPT),
 594               help     = STRING_TOKEN(STR_CHECK_BOX_HELP),
 595               flags    = CHECKBOX_DEFAULT,
 596       endcheckbox;
 597
 598       text
 599         help = STRING_TOKEN(STR_TEXT_HELP),
 600         text = STRING_TOKEN(STR_TEXT_TEXT_1);
 601
 602       text
 603         help   = STRING_TOKEN(STR_TEXT_HELP),
 604         text   = STRING_TOKEN(STR_TEXT_TEXT_1),
 605         text   = STRING_TOKEN(STR_TEXT_TEXT_2);
 606
 607       goto 1,
 608         prompt = STRING_TOKEN(STR_GOTO_FORM1), //MainSetupPage  // this too has no end-op and basically it's a jump to a form ONLY
 609         help   = STRING_TOKEN(STR_GOTO_HELP);
 610
 611     goto
 612       varid   = MyIfrNVData.RefData,
 613       prompt  = STRING_TOKEN(STR_GOTO_DYNAMIC3),
 614       help    = STRING_TOKEN(STR_GOTO_DYNAMIC3_HELP),
 615       flags   = INTERACTIVE,
 616       key     = 0x1248,
 617       //
 618       // Set the defult value, format is QuestionId; FormId; FormsetGuid; Device Path String Token
 619       //
 620       default = 0;0;ZERO_GUID;STRING_TOKEN(STR_NULL_STRING),
 621     ;                                                         // goto opcode end flag.
 622
 623     goto
 624       prompt  = STRING_TOKEN(STR_GOTO_DYNAMIC4),
 625       help    = STRING_TOKEN(STR_GOTO_DYNAMIC4_HELP),
 626       flags   = INTERACTIVE,
 627       key     = 0x1249;
 628
 629     endform;
 630   endif;
 631
 632   form formid = 3, title = STRING_TOKEN(STR_FORM3_TITLE);  // note formid is a variable (for readability) (UINT16) - also added Form to the line to signify the Op-Code
 633
 634     suppressif  ideqval MyEfiVar.Field8 == 111;
 635       text
 636         help = STRING_TOKEN(STR_TEXT_HELP),
 637         text = STRING_TOKEN(STR_TEXT_TEXT_1);
 638     endif;
 639
 640     goto 1,
 641       prompt = STRING_TOKEN(STR_GOTO_FORM1), //MainSetupPage
 642       help   = STRING_TOKEN(STR_GOTO_HELP);
 643
 644     numeric varid   = MyIfrNVData.DynamicRefresh,
 645             prompt  = STRING_TOKEN(STR_NUMERIC_MANUAL_PROMPT),
 646             help    = STRING_TOKEN(STR_NUMERIC_HELP0),
 647             flags   = INTERACTIVE,
 648             key     = 0x5678,
 649             minimum = 0,
 650             maximum = 0xff,
 651             step    = 0,
 652             default = 0,
 653             refresh interval = 3             // Refresh interval in seconds
 654     endnumeric;
 655
 656     grayoutif  match2 (stringref(STRING_TOKEN(STR_STRING)), stringref(STRING_TOKEN(STR_PATTERN)), PERL_GUID);
 657       numeric
 658         varid   = MyIfrNVData.Match2,
 659         prompt  = STRING_TOKEN(STR_MATCH2_PROMPT),
 660         help    = STRING_TOKEN(STR_MATCH2_HELP),
 661         minimum = 0,
 662         maximum = 243,
 663       endnumeric;
 664     endif;
 665
 666     label LABEL_UPDATE2;
 667     label LABEL_END;
 668
 669   endform;
 670
 671   formmap formid = 4,
 672     maptitle = STRING_TOKEN(STR_SAMPL_MAP_METHOD);
 673     mapguid  = DRIVER_SAMPLE_FORMSET_GUID;
 674     maptitle = STRING_TOKEN(STR_STANDARD_MAP_METHOD);
 675     mapguid  = EFI_HII_STANDARD_FORM_GUID;
 676
 677     oneof varid = MyIfrNVData.SerialPortNo,
 678       prompt  = STRING_TOKEN(STR_SERIAL_PORT),
 679       help    = STRING_TOKEN(STR_ONE_OF_HELP),
 680
 681       read    cond (get(MyIfrNVData.SerialPortStatus) != 0 ? 0 : cond ((get(MyIfrNVData.SerialPortIo) & 0xF00) >> 0x8 == get(MyIfrNVData.SerialPortIrq) - 1 ? UNDEFINED : map (get(MyIfrNVData.SerialPortIo) : 0x3f8,1; 0x2F8,2; 0x3E8,3; 0x2E8,4;)));
 682       write   set(MyIfrNVData.SerialPortStatus, pushthis != 0) AND set(MyIfrNVData.SerialPortIo, map (pushthis : 1,0x3F8; 2,0x2F8; 3,0x3E8; 4,0x2E8;)) AND set (MyIfrNVData.SerialPortIrq, map (pushthis: 1,4; 2,3; 3,4; 4,3;));
 683
 684       option text = STRING_TOKEN(STR_SERIAL_PORT_DISABLE), value = 0x0, flags = DEFAULT;
 685       option text = STRING_TOKEN(STR_SERIAL_PORT1), value = 0x1, flags = 0;
 686       option text = STRING_TOKEN(STR_SERIAL_PORT2), value = 0x2, flags = 0;
 687       option text = STRING_TOKEN(STR_SERIAL_PORT3), value = 0x3, flags = 0;
 688       option text = STRING_TOKEN(STR_SERIAL_PORT4), value = 0x4, flags = 0;
 689     endoneof;
 690
 691     grayoutif TRUE;
 692       checkbox varid = MyIfrNVData.SerialPortStatus,
 693         prompt   = STRING_TOKEN(STR_SERIAL_PORT_STATUS),
 694         help     = STRING_TOKEN(STR_CHECK_BOX_HELP),
 695       endcheckbox;
 696     endif;
 697
 698     grayoutif TRUE;
 699       suppressif ideqval MyIfrNVData.SerialPortStatus == 0;
 700         oneof varid = MyIfrNVData.SerialPortIo,
 701           prompt  = STRING_TOKEN(STR_SERIAL_PORT_IO_ADDRESS),
 702           help    = STRING_TOKEN(STR_ONE_OF_HELP),
 703
 704           option text = STRING_TOKEN(STR_SERIAL_PORT1_IOADDR), value = 0x3F8, flags = DEFAULT;
 705           option text = STRING_TOKEN(STR_SERIAL_PORT2_IOADDR), value = 0x2F8, flags = 0;
 706           option text = STRING_TOKEN(STR_SERIAL_PORT3_IOADDR), value = 0x3E8, flags = 0;
 707           option text = STRING_TOKEN(STR_SERIAL_PORT4_IOADDR), value = 0x2E8, flags = 0;
 708         endoneof;
 709       endif;
 710     endif;
 711
 712     grayoutif TRUE;
 713       suppressif ideqval MyIfrNVData.SerialPortStatus == 0;
 714         oneof varid = MyIfrNVData.SerialPortIrq,
 715           prompt  = STRING_TOKEN(STR_SERIAL_PORT_IRQ),
 716           help    = STRING_TOKEN(STR_ONE_OF_HELP),
 717
 718           option text = STRING_TOKEN(STR_SERIAL_PORT13_IRQ), value = 0x4, flags = DEFAULT;
 719           option text = STRING_TOKEN(STR_SERIAL_PORT24_IRQ), value = 0x3, flags = 0;
 720         endoneof;
 721       endif;
 722     endif;
 723
 724     goto 1,
 725       prompt = STRING_TOKEN(STR_GOTO_FORM1), //MainSetupPage
 726       help   = STRING_TOKEN(STR_GOTO_HELP);
 727
 728   endform;
 729
 730   form formid = 5,            // Modal form
 731        title = STRING_TOKEN(STR_MODAL_FORM_TITLE);
 732     //
 733     //  This form is a modal form.
 734     //
 735     modal;
 736     text
 737       help   = STRING_TOKEN(STR_EXIT_TEXT),
 738       text   = STRING_TOKEN(STR_EXIT_TEXT),
 739       flags  = INTERACTIVE,   // VfrCompiler will generate opcode EFI_IFR_ACTION for Text marked as INTERACTIVE
 740       key    = 0x1245;
 741
 742     text
 743       help   = STRING_TOKEN(STR_SAVE_TEXT),
 744       text   = STRING_TOKEN(STR_SAVE_TEXT),
 745       flags  = INTERACTIVE,   // VfrCompiler will generate opcode EFI_IFR_ACTION for Text marked as INTERACTIVE
 746       key    = 0x1246;
 747   endform;
 748
 749   form formid = 6,            // Form to show the refresh guid group op-code
 750        title = STRING_TOKEN(STR_FORM6_TITLE);
 751
 752     text
 753       help   = STRING_TOKEN(STR_TEXT_REFRESH_GUID),
 754       text   = STRING_TOKEN(STR_TEXT_REFRESH_GUID);
 755
 756     numeric varid   = MyIfrNVData.RefreshGuidCount,
 757             prompt  = STRING_TOKEN(STR_TEXT_REFRESH_GUID_COUNT),
 758             help    = STRING_TOKEN(STR_NUMERIC_HELP0),
 759             flags   = INTERACTIVE,
 760             key     = 0x1247,
 761             minimum = 0,
 762             maximum = 0xff,
 763             step    = 0,
 764             default = 0,
 765             refreshguid = EFI_IFR_REFRESH_ID_OP_GUID,
 766     endnumeric;
 767
 768     label LABEL_UPDATE3;
 769     label LABEL_END;
 770
 771   endform;
 772
 773   form formid = 0x1234,            // Dynamically created page,
 774        title = STRING_TOKEN(STR_DYNAMIC_TITLE);  // note formid is a variable (for readability) (UINT16) - also added Form to the line to signify the Op-Code
 775
 776     label LABEL_UPDATE1;
 777     //
 778     // This is where we will insert dynamic created opcodes
 779     //
 780     label LABEL_END;
 781
 782   endform;
 783
 784 endformset;