MdeModulePkg/Universal/DriverSampleDxe/Vfr.vfr

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