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