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 //
  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       flags  = INTERACTIVE,   // VfrCompiler will generate opcode EFI_IFR_ACTION for Text marked as INTERACTIVE
 129       key    = 0x1237;
 130
 131     text
 132       help   = STRING_TOKEN(STR_SAVE_TEXT),
 133       text   = STRING_TOKEN(STR_SAVE_TEXT),
 134       flags  = INTERACTIVE,
 135       key    = 0x1238;
 136
 137     text
 138       help   = STRING_TOKEN(STR_SAVE_CURRENT),
 139       text   = STRING_TOKEN(STR_SAVE_CURRENT),
 140       flags  = INTERACTIVE,
 141       key    = 0x1243;
 142
 143     text
 144       help   = STRING_TOKEN(STR_DISCARD_CURRENT_AND_EXIT),
 145       text   = STRING_TOKEN(STR_DISCARD_CURRENT_AND_EXIT),
 146       flags  = INTERACTIVE,
 147       key    = 0x1244;
 148     //
 149     // Define oneof (EFI_IFR_ONE_OF)
 150     //
 151     oneof name = MyOneOf,                                // Define reference name for Question
 152       varid   = MyIfrNVData.SuppressGrayOutSomething,    // Use "DataStructure.Member" to reference Buffer Storage
 153       prompt  = STRING_TOKEN(STR_ONE_OF_PROMPT),
 154       help    = STRING_TOKEN(STR_ONE_OF_HELP),
 155       //
 156       // Define an option (EFI_IFR_ONE_OF_OPTION)
 157       //
 158       option text = STRING_TOKEN(STR_ONE_OF_TEXT4), value = 0x0, flags = 0;
 159       option text = STRING_TOKEN(STR_ONE_OF_TEXT5), value = 0x1, flags = 0;
 160       //
 161       // DEFAULT indicate this option will be marked with EFI_IFR_OPTION_DEFAULT
 162       //
 163       option text = STRING_TOKEN(STR_ONE_OF_TEXT6), value = 0x2, flags = DEFAULT;
 164     endoneof;
 165
 166     oneof varid  = MyIfrNVData.BootOrderLarge,
 167       prompt      = STRING_TOKEN(STR_ONE_OF_PROMPT),
 168       help        = STRING_TOKEN(STR_ONE_OF_HELP),
 169       default value = cond (pushthis == 0 ? 0 : cond ((questionref(MyOneOf) >> 0x4 & 0xF00) == 0x0 + 0x2 ? 0 : 1)),
 170       option text = STRING_TOKEN(STR_BOOT_ORDER1), value = 0x0, flags = 0;
 171       option text = STRING_TOKEN(STR_BOOT_ORDER2), value = 0x1, flags = 0;
 172     endoneof;
 173
 174     grayoutif  ideqval MyIfrNVData.SuppressGrayOutSomething == 0x1;
 175       suppressif questionref(MyOneOf) == 0x0;
 176
 177         checkbox varid   = MyIfrNVData.ChooseToActivateNuclearWeaponry,
 178                  prompt   = STRING_TOKEN(STR_CHECK_BOX_PROMPT),
 179                  help     = STRING_TOKEN(STR_CHECK_BOX_HELP),
 180                  //
 181                  // CHECKBOX_DEFAULT indicate this checkbox is marked with EFI_IFR_CHECKBOX_DEFAULT
 182                  // CHECKBOX_DEFAULT_MFG indicate EFI_IFR_CHECKBOX_DEFAULT_MFG.
 183                  //
 184                  flags    = CHECKBOX_DEFAULT | CHECKBOX_DEFAULT_MFG,
 185                  key      = 0,
 186                  default  = 1,
 187         endcheckbox;
 188       endif;
 189         endif;
 190
 191     //
 192     // Ordered list:
 193     //   sizeof(MyIfrNVData) storage must be UINT8 array, and
 194     //   size written for the variable must be size of the entire
 195     //   variable.
 196     //
 197     //
 198     suppressif ideqval MyIfrNVData.SuppressGrayOutSomething == 0x0;
 199
 200       //
 201       // label is defined as an anchor where you want to insert some dynamic
 202       // opcodes created on-the-fly
 203       //
 204       label LABEL_UPDATE_BBS;
 205
 206       orderedlist
 207                 varid       = MyIfrNVData.BootOrder,
 208                 prompt      = STRING_TOKEN(STR_BOOT_OPTIONS),
 209                 help        = STRING_TOKEN(STR_NULL_STRING),
 210                 option text = STRING_TOKEN(STR_BOOT_OPTION2), value = 2, flags = RESET_REQUIRED;
 211                 option text = STRING_TOKEN(STR_BOOT_OPTION1), value = 1, flags = RESET_REQUIRED;
 212                 option text = STRING_TOKEN(STR_BOOT_OPTION3), value = 3, flags = RESET_REQUIRED;
 213               suppressif ideqval MyIfrNVData.BootOrderLarge == 0;
 214                 option text = STRING_TOKEN(STR_BOOT_OPTION4), value = 4, flags = RESET_REQUIRED;
 215               endif
 216       endlist;
 217
 218       //
 219       // label should be paired with each other
 220       //
 221       label LABEL_END;
 222
 223     endif;    // end suppressif
 224
 225     disableif ideqval MyIfrNVData.SuppressGrayOutSomething == 0x2;
 226       orderedlist
 227         varid       = MyIfrNVData.OrderedList,
 228         prompt      = STRING_TOKEN(STR_TEST_OPCODE),
 229         help        = STRING_TOKEN(STR_TEXT_HELP),
 230         option text = STRING_TOKEN(STR_ONE_OF_TEXT1), value = 3, flags = RESET_REQUIRED;
 231         option text = STRING_TOKEN(STR_ONE_OF_TEXT2), value = 2, flags = RESET_REQUIRED;
 232         option text = STRING_TOKEN(STR_ONE_OF_TEXT3), value = 1, flags = RESET_REQUIRED;
 233       endlist;
 234     endif;
 235
 236     label 100;
 237
 238     //
 239     // Define a hyperlink (EFI_IFR_REF)
 240     //
 241     goto 0x1234,                                  // Destination Form ID
 242       prompt  = STRING_TOKEN(STR_GOTO_DYNAMIC),   // Prompt string
 243       help    = STRING_TOKEN(STR_GOTO_HELP),      // Help string
 244       flags   = INTERACTIVE,                      // INTERACTIVE indicate it's marked with EFI_IFR_FLAG_CALLBACK
 245       key     = 0x1234;                           // Question ID which will be passed-in in COnfigAccess.Callback()
 246
 247     goto 0x1234,
 248       prompt  = STRING_TOKEN(STR_GOTO_DYNAMIC2),
 249       help    = STRING_TOKEN(STR_GOTO_HELP),
 250       flags   = INTERACTIVE,
 251       key     = 0x1235;
 252
 253     oneof varid  = MyIfrNVData.TestLateCheck,
 254       prompt      = STRING_TOKEN(STR_TEST_OPCODE),
 255       help        = STRING_TOKEN(STR_ONE_OF_HELP),
 256       option text = STRING_TOKEN(STR_ONE_OF_TEXT1), value = 0, flags = RESET_REQUIRED;
 257       option text = STRING_TOKEN(STR_ONE_OF_TEXT2), value = 1, flags = DEFAULT | RESET_REQUIRED;
 258       warningif prompt = STRING_TOKEN(STR_WARNING_POPUP), timeout = 5,
 259         ideqval MyIfrNVData.TestLateCheck == 0
 260       endif
 261
 262     endoneof;
 263
 264     oneof varid  = MyIfrNVData.TestLateCheck2,
 265       prompt      = STRING_TOKEN(STR_TEST_OPCODE2),
 266       help        = STRING_TOKEN(STR_ONE_OF_HELP),
 267       option text = STRING_TOKEN(STR_ONE_OF_TEXT1), value = 0, flags = DEFAULT | RESET_REQUIRED;
 268       option text = STRING_TOKEN(STR_ONE_OF_TEXT2), value = 1, flags = RESET_REQUIRED;
 269
 270       inconsistentif prompt = STRING_TOKEN(STR_ERROR_POPUP),
 271         ideqid MyIfrNVData.TestLateCheck == MyIfrNVData.TestLateCheck2
 272       endif
 273
 274     endoneof;
 275
 276     oneof varid  = MyIfrNVData.QuestionAboutTreeHugging,
 277       prompt      = STRING_TOKEN(STR_ONE_OF_PROMPT),
 278       help        = STRING_TOKEN(STR_ONE_OF_HELP),
 279       option text = STRING_TOKEN(STR_ONE_OF_TEXT1), value = 0, flags = RESET_REQUIRED;
 280       option text = STRING_TOKEN(STR_ONE_OF_TEXT2), value = 1, flags = DEFAULT | RESET_REQUIRED;
 281       option text = STRING_TOKEN(STR_ONE_OF_TEXT3), value = 0x03, flags = RESET_REQUIRED;
 282
 283     endoneof;
 284
 285     //
 286     // Define a string (EFI_IFR_STRING)
 287     //
 288     string    varid    = MyIfrNVData.MyStringData,
 289               prompt   = STRING_TOKEN(STR_MY_STRING_PROMPT2),
 290               help     = STRING_TOKEN(STR_MY_STRING_HELP2),
 291               flags    = INTERACTIVE,
 292               key      = 0x1236,
 293               minsize  = 6,
 294               maxsize  = 40,
 295               inconsistentif prompt = STRING_TOKEN(STR_STRING_CHECK_ERROR_POPUP),
 296                 pushthis != stringref(STRING_TOKEN(STR_STRING_CHECK))
 297               endif
 298     endstring;
 299
 300     //
 301     // Define a numeric (EFI_IFR_NUMERIC)
 302     //
 303     numeric varid   = MyIfrNVData.HowOldAreYouInYearsManual,
 304             prompt  = STRING_TOKEN(STR_NUMERIC_READONLY_PROMPT),
 305             help    = STRING_TOKEN(STR_NUMERIC_HELP0),
 306             flags   = READ_ONLY,  // READ_ONLY indicate it's marked with EFI_IFR_FLAG_READ_ONLY
 307             minimum = 0,
 308             maximum = 0xf0,
 309             step    = 0,          // Stepping of 0 equates to a manual entering
 310                                   // of a value, otherwise it will be adjusted by "+"/"-"
 311             default = 21,         // defaultstore could be used to specify the default type
 312                                   // If no defaultstore is specified, it implies Standard Default
 313
 314     endnumeric;
 315
 316     numeric varid   = MyIfrNVData.HowOldAreYouInYearsManual,
 317             prompt  = STRING_TOKEN(STR_NUMERIC_MANUAL_PROMPT),
 318             help    = STRING_TOKEN(STR_NUMERIC_HELP0),
 319             minimum = 0,
 320             maximum = 0xf0,
 321             step    = 0,
 322             default value = questionrefval(devicepath = STRING_TOKEN (STR_DEVICE_PATH), guid = DRIVER_SAMPLE_FORMSET_GUID, 0x1111),
 323
 324             inconsistentif prompt = STRING_TOKEN(STR_ERROR_POPUP),
 325               ideqval MyIfrNVData.HowOldAreYouInYearsManual == 99
 326               OR
 327               ideqid  MyIfrNVData.HowOldAreYouInYearsManual == MyEfiVar.Field8
 328               OR
 329               ideqvallist MyIfrNVData.HowOldAreYouInYearsManual == 1 3 5 7
 330             endif
 331
 332     endnumeric;
 333
 334     numeric varid   = MyEfiVar.Field8,                    // Reference of EFI variable storage
 335             questionid  = 0x1111,
 336             prompt  = STRING_TOKEN(STR_TALL_HEX_PROMPT),
 337             help    = STRING_TOKEN(STR_NUMERIC_HELP1),
 338             flags   = DISPLAY_UINT_HEX | INTERACTIVE,     // Display in HEX format (if not specified, default is in decimal format)
 339             minimum = 0,
 340             maximum = 250,
 341             default = 18, defaultstore = MyStandardDefault,     // This is standard default value
 342             default = 19, defaultstore = MyManufactureDefault,  // This is manufacture default value
 343
 344     endnumeric;
 345
 346     //
 347     // Define numeric using Name/Value Storage
 348     //
 349     numeric varid   = MyNameValueVar[0],     // This numeric take NameValueVar0 as storage
 350             prompt  = STRING_TOKEN(STR_NAME_VALUE_VAR_NAME0),
 351             help    = STRING_TOKEN(STR_NAME_VALUE_VAR_NAME0_HELP),
 352             //
 353             // Size should be defined for numeric when use Name/Value storage
 354             // Valid value for numerice size are: NUMERIC_SIZE_1, NUMERIC_SIZE_2, NUMERIC_SIZE_4 and NUMERIC_SIZE_8
 355             //
 356             flags   = NUMERIC_SIZE_1,        // Size of this numeric is 1 byte
 357             minimum = 0,
 358             maximum = 0xff,
 359             step    = 0,
 360             locked,
 361             default = 16, defaultstore = MyStandardDefault,     // This is standard default value
 362             default = 17, defaultstore = MyManufactureDefault,  // This is manufacture default value
 363     endnumeric;
 364
 365     numeric varid   = MyNameValueVar[1],     // This numeric take NameValueVar1 as storage
 366             prompt  = STRING_TOKEN(STR_NAME_VALUE_VAR_NAME1),
 367             help    = STRING_TOKEN(STR_NAME_VALUE_VAR_NAME1_HELP),
 368             flags   = NUMERIC_SIZE_2,        // Size of this numeric is 2 bytes
 369             minimum = 0,
 370             maximum = 0xffff,
 371             step    = 0,
 372             default = 18, defaultstore = MyStandardDefault,     // This is standard default value
 373             default = 19, defaultstore = MyManufactureDefault,  // This is manufacture default value
 374     endnumeric;
 375
 376     //
 377     // Define string using Name/Value Storage
 378     //
 379     string    varid    = MyNameValueVar[2],     // This string take NameValueVar2 as storage
 380               prompt   = STRING_TOKEN(STR_NAME_VALUE_VAR_NAME2),
 381               help     = STRING_TOKEN(STR_NAME_VALUE_VAR_NAME2_HELP),
 382               minsize  = 2,
 383               maxsize  = 0x14,
 384     endstring;
 385
 386     oneof varid   = MyEfiVar.Field16,
 387       prompt      = STRING_TOKEN(STR_ONE_OF_PROMPT),
 388       help        = STRING_TOKEN(STR_NUMERIC_NUM_HELP),
 389       option text = STRING_TOKEN(STR_BOOT_ORDER1), value = 0x0, flags = 0;
 390       option text = STRING_TOKEN(STR_BOOT_ORDER2), value = 0x1, flags = DEFAULT;
 391     endoneof;
 392
 393     label LABEL_1_VALUE;
 394     label LABEL_2_VALUE;
 395
 396     grayoutif  ideqval MyIfrNVData.HowOldAreYouInYearsManual == 23 AND ideqval MyIfrNVData.SuppressGrayOutSomething == 0x1;
 397       numeric varid   = MyIfrNVData.HowOldAreYouInYears,
 398               prompt  = STRING_TOKEN(STR_NUMERIC_STEP_PROMPT),
 399               help    = STRING_TOKEN(STR_NUMERIC_HELP2),
 400               minimum = 0,
 401               maximum = 243,
 402               step    = 1,
 403               default = 18, defaultstore = MyStandardDefault,     // This is standard default value
 404               default = 19, defaultstore = MyManufactureDefault,  // This is manufacture default value
 405
 406       endnumeric;
 407     endif;
 408
 409     numeric varid   = MyIfrNVData.GetDefaultValueFromAccess,
 410             questionid = 0x1239,
 411             prompt  = STRING_TOKEN(STR_DEFAULT_VALUE_FROM_ACCESS_PROMPT),
 412             help    = STRING_TOKEN(STR_DEFAULT_VALUE_FROM_ACCESS_HELP),
 413             flags   = DISPLAY_UINT_HEX | INTERACTIVE,
 414             minimum = 0,
 415             maximum = 255,
 416             step    = 1,
 417             default = 18,
 418     endnumeric;
 419
 420     numeric varid   = MyIfrNVData.GetDefaultValueFromCallBack,
 421             questionid = 0x1240,
 422             prompt  = STRING_TOKEN(STR_DEFAULT_VALUE_FROM_CALLBACK_PROMPT),
 423             help    = STRING_TOKEN(STR_DEFAULT_VALUE_FROM_CALLBACK_HELP),
 424             flags   = DISPLAY_UINT_HEX | INTERACTIVE,
 425             minimum = 0,
 426             maximum = 255,
 427             step    = 1,
 428             default = 18,
 429     endnumeric;
 430
 431     resetbutton
 432       defaultstore = MyStandardDefault,
 433       prompt   = STRING_TOKEN(STR_STANDARD_DEFAULT_PROMPT),
 434       help     = STRING_TOKEN(STR_STANDARD_DEFAULT_HELP),
 435     endresetbutton;
 436
 437     resetbutton
 438       defaultstore = MyManufactureDefault,
 439       prompt   = STRING_TOKEN(STR_MANUFACTURE_DEFAULT_PROMPT),
 440       help     = STRING_TOKEN(STR_MANUFACTURE_DEFAULT_HELP),
 441     endresetbutton;
 442
 443     //
 444     // Non-interactive password, validate by Setup Browser
 445     //
 446     password  varid    = MyIfrNVData.WhatIsThePassword,
 447               prompt   = STRING_TOKEN(STR_PASSWORD_PROMPT),
 448               help     = STRING_TOKEN(STR_PASSWORD_HELP),
 449               minsize  = 6,
 450               maxsize  = 20,
 451     endpassword;
 452
 453     string    varid    = MyIfrNVData.PasswordClearText,
 454               prompt   = STRING_TOKEN(STR_MY_STRING_PROMPT),
 455               help     = STRING_TOKEN(STR_MY_STRING_HELP),
 456               minsize  = 6,
 457               maxsize  = 0x14,
 458     endstring;
 459
 460     //
 461     // Interactive password, validate via ConfigAccess.Callback()
 462     //
 463     password  varid    = MyIfrNVData.WhatIsThePassword2,
 464               prompt   = STRING_TOKEN(STR_PASSWORD_CALLBACK_PROMPT),
 465               help     = STRING_TOKEN(STR_PASSWORD_HELP),
 466               flags    = INTERACTIVE,
 467               key      = 0x2000,
 468               minsize  = 6,
 469               maxsize  = 20,
 470     endpassword;
 471
 472     //
 473     // Sample use case for IFR Security op-code
 474     //
 475     grayoutif NOT security (EFI_USER_INFO_ACCESS_SETUP_ADMIN_GUID);
 476       text
 477         help = STRING_TOKEN(STR_TEXT_SECRUITY_TEST_HELP),
 478         text = STRING_TOKEN(STR_TEXT_SECRUITY_TEST_TEXT);
 479     endif;
 480
 481     goto 2,
 482       prompt = STRING_TOKEN(STR_GOTO_FORM2), //SecondSetupPage  // this too has no end-op and basically it's a jump to a form ONLY
 483       help   = STRING_TOKEN(STR_GOTO_HELP);
 484
 485     goto 3,
 486       prompt = STRING_TOKEN(STR_GOTO_FORM3), //ThirdSetupPage  // this too has no end-op and basically it's a jump to a form ONLY
 487       help   = STRING_TOKEN(STR_GOTO_HELP);
 488
 489     goto 4,
 490       prompt = STRING_TOKEN(STR_GOTO_FORM4), //FourthSetupPage  // this too has no end-op and basically it's a jump to a form ONLY
 491       help   = STRING_TOKEN(STR_GOTO_HELP);
 492
 493     goto 5,
 494       prompt = STRING_TOKEN(STR_GOTO_FORM5), //FifthSetupPage  // this too has no end-op and basically it's a jump to a form ONLY
 495       help   = STRING_TOKEN(STR_GOTO_FORM5_HELP);
 496
 497     goto 6,
 498       prompt = STRING_TOKEN(STR_GOTO_FORM6), //SixthSetupPage  // this too has no end-op and basically it's a jump to a form ONLY
 499       help   = STRING_TOKEN(STR_GOTO_HELP);
 500
 501     goto
 502       formsetguid = DRIVER_SAMPLE_INVENTORY_GUID,
 503       formid  = 0x1,
 504       question = 0x1,
 505       prompt  = STRING_TOKEN(STR_GOTO_ANOTHER_FORMSET),
 506       help    = STRING_TOKEN(STR_GOTO_ANOTHER_FORMSET_HELP);
 507
 508     guidop
 509       guid = DRIVER_SAMPLE_FORMSET_GUID,
 510       datatype = MY_EFI_VARSTORE_DATA,
 511         data.Field8  = 0x21,
 512         data.Field16 = 0x2121,
 513         data.OrderedList[0] = 0x21,
 514     endguidop;
 515
 516
 517   endform;
 518
 519   suppressif ideqval MyIfrNVData.BootOrderLarge == 0;
 520     form formid = 2,               // SecondSetupPage,
 521       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
 522
 523       date
 524         name    = Date,
 525         prompt  = STRING_TOKEN(STR_DATE_PROMPT),
 526         help    = STRING_TOKEN(STR_DATE_HELP),
 527         flags   = STORAGE_TIME,
 528         default = 2004/1/1,
 529
 530         inconsistentif prompt = STRING_TOKEN(STR_ERROR_POPUP),
 531           ideqval Date.Day == 31
 532           AND
 533           ideqvallist Date.Month == 2 4 6 9 11
 534         endif
 535
 536         //
 537         // If the day is 30 AND month is 2
 538         //
 539         inconsistentif prompt = STRING_TOKEN(STR_ERROR_POPUP),
 540           ideqval Date.Day == 30
 541           AND
 542           ideqval Date.Month == 2
 543         endif
 544
 545         //
 546         // If the day is 29 AND month is 2 AND it year is NOT a leapyear
 547         //
 548         inconsistentif prompt = STRING_TOKEN(STR_ERROR_POPUP),
 549           ideqval Date.Day == 0x1D
 550           AND
 551           ideqval Date.Month == 2
 552           AND
 553           NOT
 554           ideqvallist Date.Year == 2004 2008 20012 20016 2020 2024 2028 2032 2036
 555         endif
 556
 557       enddate;
 558
 559       text
 560         help   = STRING_TOKEN(STR_SAVE_CURRENT_AND_EXIT),
 561         text   = STRING_TOKEN(STR_SAVE_CURRENT_AND_EXIT),
 562         flags  = INTERACTIVE,
 563         key    = 0x1241;
 564
 565       text
 566         help   = STRING_TOKEN(STR_DISCARD_CURRENT),
 567         text   = STRING_TOKEN(STR_DISCARD_CURRENT),
 568         flags  = INTERACTIVE,
 569         key    = 0x1242;
 570
 571       time
 572         prompt  = STRING_TOKEN(STR_TIME_PROMPT),
 573         help    = STRING_TOKEN(STR_TIME_HELP),
 574         flags   = STORAGE_TIME,
 575       endtime;
 576
 577       time
 578             name    = MyTime,
 579             varid   = MyIfrNVData.Time,
 580             prompt  = STRING_TOKEN(STR_TIME_PROMPT),
 581             help    = STRING_TOKEN(STR_TIME_PROMPT),
 582             flags   = STORAGE_NORMAL | SECOND_SUPPRESS,
 583             default = 15:33:33,
 584       endtime;
 585
 586       checkbox varid   = MyIfrNVData.ChooseToActivateNuclearWeaponry,
 587               prompt   = STRING_TOKEN(STR_CHECK_BOX_PROMPT),
 588               help     = STRING_TOKEN(STR_CHECK_BOX_HELP),
 589               flags    = CHECKBOX_DEFAULT,
 590               key      = 0,
 591       endcheckbox;
 592
 593       text
 594         help = STRING_TOKEN(STR_TEXT_HELP),
 595         text = STRING_TOKEN(STR_TEXT_TEXT_1);
 596
 597       text
 598         help   = STRING_TOKEN(STR_TEXT_HELP),
 599         text   = STRING_TOKEN(STR_TEXT_TEXT_1),
 600         text   = STRING_TOKEN(STR_TEXT_TEXT_2);
 601
 602       goto 1,
 603         prompt = STRING_TOKEN(STR_GOTO_FORM1), //MainSetupPage  // this too has no end-op and basically it's a jump to a form ONLY
 604         help   = STRING_TOKEN(STR_GOTO_HELP);
 605
 606     goto
 607       varid   = MyIfrNVData.RefData,
 608       prompt  = STRING_TOKEN(STR_GOTO_DYNAMIC3),
 609       help    = STRING_TOKEN(STR_GOTO_DYNAMIC3_HELP),
 610       flags   = INTERACTIVE,
 611       key     = 0x1248,
 612       //
 613       // Set the defult value, format is QuestionId; FormId; FormsetGuid; Device Path String Token
 614       //
 615       default = 0;0;ZERO_GUID;STRING_TOKEN(STR_NULL_STRING),
 616     ;                                                         // goto opcode end flag.
 617
 618     goto
 619       prompt  = STRING_TOKEN(STR_GOTO_DYNAMIC4),
 620       help    = STRING_TOKEN(STR_GOTO_DYNAMIC4_HELP),
 621       flags   = INTERACTIVE,
 622       key     = 0x1249;
 623
 624     endform;
 625   endif;
 626
 627   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
 628
 629     suppressif  ideqval MyEfiVar.Field8 == 111;
 630       text
 631         help = STRING_TOKEN(STR_TEXT_HELP),
 632         text = STRING_TOKEN(STR_TEXT_TEXT_1);
 633     endif;
 634
 635     goto 1,
 636       prompt = STRING_TOKEN(STR_GOTO_FORM1), //MainSetupPage
 637       help   = STRING_TOKEN(STR_GOTO_HELP);
 638
 639     numeric varid   = MyIfrNVData.DynamicRefresh,
 640             prompt  = STRING_TOKEN(STR_NUMERIC_MANUAL_PROMPT),
 641             help    = STRING_TOKEN(STR_NUMERIC_HELP0),
 642             flags   = INTERACTIVE,
 643             key     = 0x5678,
 644             minimum = 0,
 645             maximum = 0xff,
 646             step    = 0,
 647             default = 0,
 648             refresh interval = 3             // Refresh interval in seconds
 649     endnumeric;
 650
 651     label LABEL_UPDATE2;
 652     label LABEL_END;
 653
 654   endform;
 655
 656   formmap formid = 4,
 657     maptitle = STRING_TOKEN(STR_SAMPL_MAP_METHOD);
 658     mapguid  = DRIVER_SAMPLE_FORMSET_GUID;
 659     maptitle = STRING_TOKEN(STR_STANDARD_MAP_METHOD);
 660     mapguid  = EFI_HII_STANDARD_FORM_GUID;
 661
 662     oneof varid = MyIfrNVData.SerialPortNo,
 663       prompt  = STRING_TOKEN(STR_SERIAL_PORT),
 664       help    = STRING_TOKEN(STR_ONE_OF_HELP),
 665
 666       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;)));
 667       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;));
 668
 669       option text = STRING_TOKEN(STR_SERIAL_PORT_DISABLE), value = 0x0, flags = DEFAULT;
 670       option text = STRING_TOKEN(STR_SERIAL_PORT1), value = 0x1, flags = 0;
 671       option text = STRING_TOKEN(STR_SERIAL_PORT2), value = 0x2, flags = 0;
 672       option text = STRING_TOKEN(STR_SERIAL_PORT3), value = 0x3, flags = 0;
 673       option text = STRING_TOKEN(STR_SERIAL_PORT4), value = 0x4, flags = 0;
 674     endoneof;
 675
 676     grayoutif TRUE;
 677       checkbox varid = MyIfrNVData.SerialPortStatus,
 678         prompt   = STRING_TOKEN(STR_SERIAL_PORT_STATUS),
 679         help     = STRING_TOKEN(STR_CHECK_BOX_HELP),
 680       endcheckbox;
 681     endif;
 682
 683     grayoutif TRUE;
 684       suppressif ideqval MyIfrNVData.SerialPortStatus == 0;
 685         oneof varid = MyIfrNVData.SerialPortIo,
 686           prompt  = STRING_TOKEN(STR_SERIAL_PORT_IO_ADDRESS),
 687           help    = STRING_TOKEN(STR_ONE_OF_HELP),
 688
 689           option text = STRING_TOKEN(STR_SERIAL_PORT1_IOADDR), value = 0x3F8, flags = DEFAULT;
 690           option text = STRING_TOKEN(STR_SERIAL_PORT2_IOADDR), value = 0x2F8, flags = 0;
 691           option text = STRING_TOKEN(STR_SERIAL_PORT3_IOADDR), value = 0x3E8, flags = 0;
 692           option text = STRING_TOKEN(STR_SERIAL_PORT4_IOADDR), value = 0x2E8, flags = 0;
 693         endoneof;
 694       endif;
 695     endif;
 696
 697     grayoutif TRUE;
 698       suppressif ideqval MyIfrNVData.SerialPortStatus == 0;
 699         oneof varid = MyIfrNVData.SerialPortIrq,
 700           prompt  = STRING_TOKEN(STR_SERIAL_PORT_IRQ),
 701           help    = STRING_TOKEN(STR_ONE_OF_HELP),
 702
 703           option text = STRING_TOKEN(STR_SERIAL_PORT13_IRQ), value = 0x4, flags = DEFAULT;
 704           option text = STRING_TOKEN(STR_SERIAL_PORT24_IRQ), value = 0x3, flags = 0;
 705         endoneof;
 706       endif;
 707     endif;
 708
 709     goto 1,
 710       prompt = STRING_TOKEN(STR_GOTO_FORM1), //MainSetupPage
 711       help   = STRING_TOKEN(STR_GOTO_HELP);
 712
 713   endform;
 714
 715   form formid = 5,            // Modal form
 716        title = STRING_TOKEN(STR_MODAL_FORM_TITLE);
 717     //
 718     //  This form is a modal form.
 719     //
 720     modal;
 721     text
 722       help   = STRING_TOKEN(STR_EXIT_TEXT),
 723       text   = STRING_TOKEN(STR_EXIT_TEXT),
 724       flags  = INTERACTIVE,   // VfrCompiler will generate opcode EFI_IFR_ACTION for Text marked as INTERACTIVE
 725       key    = 0x1245;
 726
 727     text
 728       help   = STRING_TOKEN(STR_SAVE_TEXT),
 729       text   = STRING_TOKEN(STR_SAVE_TEXT),
 730       flags  = INTERACTIVE,   // VfrCompiler will generate opcode EFI_IFR_ACTION for Text marked as INTERACTIVE
 731       key    = 0x1246;
 732   endform;
 733
 734   form formid = 6,            // Form to show the refresh guid group op-code
 735        title = STRING_TOKEN(STR_FORM6_TITLE);
 736
 737     text
 738       help   = STRING_TOKEN(STR_TEXT_REFRESH_GUID),
 739       text   = STRING_TOKEN(STR_TEXT_REFRESH_GUID);
 740
 741     numeric varid   = MyIfrNVData.RefreshGuidCount,
 742             prompt  = STRING_TOKEN(STR_TEXT_REFRESH_GUID_COUNT),
 743             help    = STRING_TOKEN(STR_NUMERIC_HELP0),
 744             flags   = INTERACTIVE,
 745             key     = 0x1247,
 746             minimum = 0,
 747             maximum = 0xff,
 748             step    = 0,
 749             default = 0,
 750             refreshguid = EFI_IFR_REFRESH_ID_OP_GUID,
 751     endnumeric;
 752
 753     label LABEL_UPDATE3;
 754     label LABEL_END;
 755
 756   endform;
 757
 758   form formid = 0x1234,            // Dynamically created page,
 759        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
 760
 761     label LABEL_UPDATE1;
 762     //
 763     // This is where we will insert dynamic created opcodes
 764     //
 765     label LABEL_END;
 766
 767   endform;
 768
 769 endformset;