]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Universal/DriverSampleDxe/Vfr.vfr
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Fixed an issue in default storage for checkbox and changed the format of error message.
[mirror_edk2.git] / MdeModulePkg / Universal / DriverSampleDxe / Vfr.vfr
CommitLineData
7b414b4e 1///** @file\r
93e3992d 2//\r
7b414b4e 3// Sample Setup formset.\r
93e3992d 4//\r
7b414b4e 5// Copyright (c) 2004 - 2008, Intel Corporation. <BR>\r
6// All rights reserved. This program and the accompanying materials\r
7// are licensed and made available under the terms and conditions of the BSD License\r
8// which accompanies this distribution. The full text of the license may be found at\r
9// http://opensource.org/licenses/bsd-license.php\r
93e3992d 10//\r
7b414b4e 11// THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12// WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
93e3992d 13//\r
7b414b4e 14//**/\r
93e3992d 15\r
16\r
17#include "NVDataStruc.h"\r
18\r
19//\r
20// Formset class used by Device Manager\r
21//\r
22#define EFI_NON_DEVICE_CLASS 0x00\r
23#define EFI_DISK_DEVICE_CLASS 0x01\r
24#define EFI_VIDEO_DEVICE_CLASS 0x02\r
25#define EFI_NETWORK_DEVICE_CLASS 0x04\r
26#define EFI_INPUT_DEVICE_CLASS 0x08\r
27#define EFI_ON_BOARD_DEVICE_CLASS 0x10\r
28#define EFI_OTHER_DEVICE_CLASS 0x20\r
29\r
30//\r
31// Formset subclass\r
32//\r
33#define EFI_SETUP_APPLICATION_SUBCLASS 0x00\r
34#define EFI_GENERAL_APPLICATION_SUBCLASS 0x01\r
35#define EFI_FRONT_PAGE_SUBCLASS 0x02\r
36#define EFI_SINGLE_USE_SUBCLASS 0x03\r
37\r
38//\r
39// EFI Variable attributes\r
40//\r
41#define EFI_VARIABLE_NON_VOLATILE 0x00000001\r
42#define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x00000002\r
43#define EFI_VARIABLE_RUNTIME_ACCESS 0x00000004\r
44#define EFI_VARIABLE_READ_ONLY 0x00000008\r
45\r
46//\r
47// NV data structure definition\r
48//\r
49typedef struct {\r
50 UINT8 Field8;\r
51 UINT16 Field16;\r
52 UINT8 OrderedList[3];\r
53} MY_DATA2;\r
54\r
55//\r
56// Labels definition\r
57//\r
58#define LABEL_1_VALUE 0x01\r
59#define LABEL_2_VALUE 0x1000\r
60#define LABEL_UPDATE_BBS 0x2222\r
61#define LABEL_END 0x2223\r
62\r
63formset\r
64 guid = FORMSET_GUID,\r
65 title = STRING_TOKEN(STR_FORM_SET_TITLE),\r
66 help = STRING_TOKEN(STR_FORM_SET_TITLE_HELP),\r
67 class = EFI_ON_BOARD_DEVICE_CLASS,\r
68 subclass = EFI_SETUP_APPLICATION_SUBCLASS,\r
69\r
70 //\r
71 // Define a Buffer Storage (EFI_IFR_VARSTORE)\r
72 //\r
73 varstore DRIVER_SAMPLE_CONFIGURATION, // This is the data structure type\r
74 varid = 0x1234, // Optional VarStore ID\r
75 name = MyIfrNVData, // Define referenced name in vfr\r
76 guid = FORMSET_GUID; // GUID of this buffer storage\r
77\r
78 //\r
79 // Define another Buffer Storage\r
80 //\r
81 varstore MY_DATA2,\r
82 name = MyIfrNVData2,\r
83 guid = FORMSET_GUID;\r
84\r
85 //\r
86 // Define a EFI variable Storage (EFI_IFR_VARSTORE_EFI)\r
87 //\r
88 efivarstore MyEfiVar, // Define referenced name in vfr\r
89 attribute = EFI_VARIABLE_BOOTSERVICE_ACCESS, // EFI variable attribures\r
90 name = STRING_TOKEN(STR_VAR_NAME), // EFI variable name\r
91 varsize = 1, // Size of the EFI variable\r
92 guid = FORMSET_GUID; // EFI variable GUID\r
93\r
94 //\r
95 // Define a Form (EFI_IFR_FORM)\r
96 //\r
97 form formid = 1, // Form ID\r
98 title = STRING_TOKEN(STR_FORM1_TITLE); // Form title\r
99\r
100 subtitle text = STRING_TOKEN(STR_SUBTITLE_TEXT);\r
101\r
102 subtitle text = STRING_TOKEN(STR_SUBTITLE_TEXT2);\r
103\r
104 //\r
105 // Define a display only text (EFI_IFR_TEXT)\r
106 //\r
107 text\r
108 help = STRING_TOKEN(STR_TEXT_HELP), // Help string\r
109 text = STRING_TOKEN(STR_CPU_STRING), // Prompt string\r
110 text = STRING_TOKEN(STR_CPU_STRING2); // TextTwo\r
111\r
112 text\r
113 help = STRING_TOKEN(STR_EXIT_TEXT),\r
114 text = STRING_TOKEN(STR_EXIT_TEXT),\r
115 text = STRING_TOKEN(STR_EXIT_TEXT),\r
116 flags = INTERACTIVE,\r
117 key = 0x1237;\r
118\r
119 text\r
120 help = STRING_TOKEN(STR_SAVE_TEXT),\r
121 text = STRING_TOKEN(STR_SAVE_TEXT),\r
122 text = STRING_TOKEN(STR_SAVE_TEXT),\r
123 flags = INTERACTIVE,\r
124 key = 0x1238;\r
125\r
126 //\r
127 // Define oneof (EFI_IFR_ONE_OF)\r
128 //\r
129 oneof varid = MyIfrNVData.SuppressGrayOutSomething, // Use "DataStructure.Member" to reference Buffer Storage\r
130 prompt = STRING_TOKEN(STR_ONE_OF_PROMPT),\r
131 help = STRING_TOKEN(STR_ONE_OF_HELP),\r
132 //\r
133 // Define an option (EFI_IFR_ONE_OF_OPTION)\r
134 //\r
135 option text = STRING_TOKEN(STR_ONE_OF_TEXT4), value = 0x0, flags = 0;\r
136 option text = STRING_TOKEN(STR_ONE_OF_TEXT5), value = 0x1, flags = 0;\r
137 //\r
138 // DEFAULT indicate this option will be marked with EFI_IFR_OPTION_DEFAULT\r
139 //\r
140 option text = STRING_TOKEN(STR_ONE_OF_TEXT6), value = 0x2, flags = DEFAULT;\r
141 endoneof;\r
142\r
143 oneof varid = MyIfrNVData.BootOrderLarge,\r
144 prompt = STRING_TOKEN(STR_ONE_OF_PROMPT),\r
145 help = STRING_TOKEN(STR_ONE_OF_HELP),\r
146 option text = STRING_TOKEN(STR_BOOT_ORDER1), value = 0x0, flags = 0;\r
147 option text = STRING_TOKEN(STR_BOOT_ORDER2), value = 0x1, flags = DEFAULT;\r
148 endoneof;\r
149\r
150 grayoutif ideqval MyIfrNVData.SuppressGrayOutSomething == 0x1;\r
151 suppressif ideqval MyIfrNVData.SuppressGrayOutSomething == 0x0;\r
152\r
153 checkbox varid = MyIfrNVData.ChooseToActivateNuclearWeaponry,\r
154 prompt = STRING_TOKEN(STR_CHECK_BOX_PROMPT),\r
155 help = STRING_TOKEN(STR_CHECK_BOX_HELP),\r
156 //\r
157 // CHECKBOX_DEFAULT indicate this checkbox is marked with EFI_IFR_CHECKBOX_DEFAULT\r
158 //\r
159 flags = CHECKBOX_DEFAULT,\r
160 key = 0,\r
161\r
162 endcheckbox;\r
163 endif;\r
164 endif;\r
165\r
166 //\r
167 // Ordered list:\r
168 // sizeof(MyIfrNVData) storage must be UINT8 array, and\r
169 // size written for the variable must be size of the entire\r
170 // variable.\r
171 //\r
172 //\r
173 suppressif ideqval MyIfrNVData.SuppressGrayOutSomething == 0x0;\r
174\r
175 //\r
176 // label is defined as an anchor where you want to insert some dynamic\r
177 // opcodes created on-the-fly\r
178 //\r
179 label LABEL_UPDATE_BBS;\r
180\r
181 orderedlist\r
182 varid = MyIfrNVData.BootOrder,\r
183 prompt = STRING_TOKEN(STR_BOOT_OPTIONS),\r
184 help = STRING_TOKEN(STR_NULL_STRING),\r
185 option text = STRING_TOKEN(STR_BOOT_OPTION2), value = 2, flags = RESET_REQUIRED;\r
186 option text = STRING_TOKEN(STR_BOOT_OPTION1), value = 1, flags = RESET_REQUIRED;\r
187 option text = STRING_TOKEN(STR_BOOT_OPTION3), value = 3, flags = RESET_REQUIRED;\r
188 suppressif ideqval MyIfrNVData.BootOrderLarge == 0;\r
189 option text = STRING_TOKEN(STR_BOOT_OPTION4), value = 4, flags = 0;\r
190 endif\r
191 endlist;\r
192\r
193 //\r
194 // label should be paired with each other\r
195 //\r
196 label LABEL_END;\r
197\r
198 endif; // end suppressif\r
199\r
200 suppressif ideqval MyIfrNVData.SuppressGrayOutSomething == 0x2;\r
201 orderedlist\r
202 varid = MyIfrNVData.OrderedList,\r
203 prompt = STRING_TOKEN(STR_TEST_OPCODE),\r
204 help = STRING_TOKEN(STR_TEXT_HELP),\r
205 option text = STRING_TOKEN(STR_ONE_OF_TEXT1), value = 3, flags = RESET_REQUIRED;\r
206 option text = STRING_TOKEN(STR_ONE_OF_TEXT2), value = 2, flags = RESET_REQUIRED;\r
207 option text = STRING_TOKEN(STR_ONE_OF_TEXT3), value = 1, flags = RESET_REQUIRED;\r
208 endlist;\r
209 endif;\r
210\r
211 label 100;\r
212\r
213 //\r
214 // Define a hyperlink (EFI_IFR_REF)\r
215 //\r
216 goto 0x1234, // Destination Form ID\r
217 prompt = STRING_TOKEN(STR_GOTO_DYNAMIC), // Prompt string\r
218 help = STRING_TOKEN(STR_GOTO_HELP), // Help string\r
219 flags = INTERACTIVE, // INTERACTIVE indicate it's marked with EFI_IFR_FLAG_CALLBACK\r
220 key = 0x1234; // Question ID which will be passed-in in COnfigAccess.Callback()\r
221\r
222 goto 0x1234,\r
223 prompt = STRING_TOKEN(STR_GOTO_DYNAMIC2),\r
224 help = STRING_TOKEN(STR_GOTO_HELP),\r
225 flags = INTERACTIVE,\r
226 key = 0x1235;\r
227\r
228 oneof varid = MyIfrNVData.TestLateCheck,\r
229 prompt = STRING_TOKEN(STR_TEST_OPCODE),\r
230 help = STRING_TOKEN(STR_ONE_OF_HELP),\r
231 option text = STRING_TOKEN(STR_ONE_OF_TEXT1), value = 0, flags = RESET_REQUIRED;\r
232 option text = STRING_TOKEN(STR_ONE_OF_TEXT2), value = 1, flags = DEFAULT | RESET_REQUIRED;\r
233\r
234 endoneof;\r
235\r
236 oneof varid = MyIfrNVData.TestLateCheck2,\r
237 prompt = STRING_TOKEN(STR_TEST_OPCODE2),\r
238 help = STRING_TOKEN(STR_ONE_OF_HELP),\r
239 option text = STRING_TOKEN(STR_ONE_OF_TEXT1), value = 0, flags = DEFAULT | RESET_REQUIRED;\r
240 option text = STRING_TOKEN(STR_ONE_OF_TEXT2), value = 1, flags = RESET_REQUIRED;\r
241\r
242 inconsistentif prompt = STRING_TOKEN(STR_ERROR_POPUP),\r
243 ideqid MyIfrNVData.TestLateCheck == MyIfrNVData.TestLateCheck2\r
244 endif\r
245\r
246 endoneof;\r
247\r
248 oneof varid = MyIfrNVData.QuestionAboutTreeHugging,\r
249 prompt = STRING_TOKEN(STR_ONE_OF_PROMPT),\r
250 help = STRING_TOKEN(STR_ONE_OF_HELP),\r
251 option text = STRING_TOKEN(STR_ONE_OF_TEXT1), value = 0, flags = RESET_REQUIRED;\r
252 option text = STRING_TOKEN(STR_ONE_OF_TEXT2), value = 1, flags = DEFAULT | RESET_REQUIRED;\r
253 option text = STRING_TOKEN(STR_ONE_OF_TEXT3), value = 0x03, flags = RESET_REQUIRED;\r
254\r
255 endoneof;\r
256\r
257 //\r
258 // Define a string (EFI_IFR_STRING)\r
259 //\r
260 string varid = MyIfrNVData.MyStringData,\r
261 prompt = STRING_TOKEN(STR_MY_STRING_PROMPT2),\r
262 help = STRING_TOKEN(STR_MY_STRING_HELP2),\r
263 flags = INTERACTIVE,\r
264 key = 0x1236,\r
265 minsize = 6,\r
266 maxsize = 20,\r
267 endstring;\r
268\r
269 //\r
270 // Define a numeric (EFI_IFR_NUMERIC)\r
271 //\r
272 numeric varid = MyIfrNVData.HowOldAreYouInYearsManual,\r
273 prompt = STRING_TOKEN(STR_NUMERIC_READONLY_PROMPT),\r
274 help = STRING_TOKEN(STR_NUMERIC_HELP0),\r
275 flags = READ_ONLY, // READ_ONLY indicate it's marked with EFI_IFR_FLAG_READ_ONLY\r
276 minimum = 0,\r
277 maximum = 0xf0,\r
278 step = 0, // Stepping of 0 equates to a manual entering\r
279 // of a value, otherwise it will be adjusted by "+"/"-"\r
280 default = 20,\r
281\r
282 endnumeric;\r
283\r
284 numeric varid = MyIfrNVData.HowOldAreYouInYearsManual,\r
285 prompt = STRING_TOKEN(STR_NUMERIC_MANUAL_PROMPT),\r
286 help = STRING_TOKEN(STR_NUMERIC_HELP0),\r
287 minimum = 0,\r
288 maximum = 0xf0,\r
289 step = 0,\r
290 default = 21,\r
291\r
292 inconsistentif prompt = STRING_TOKEN(STR_ERROR_POPUP),\r
293 ideqval MyIfrNVData.HowOldAreYouInYearsManual == 99\r
294 OR\r
295 ideqid MyIfrNVData.HowOldAreYouInYearsManual == MyEfiVar\r
296 OR\r
297 ideqvallist MyIfrNVData.HowOldAreYouInYearsManual == 1 3 5 7\r
298 endif\r
299\r
300 endnumeric;\r
301\r
302 numeric varid = MyEfiVar, // Reference of EFI variable storage\r
303 prompt = STRING_TOKEN(STR_TALL_HEX_PROMPT),\r
304 help = STRING_TOKEN(STR_NUMERIC_HELP1),\r
305 flags = DISPLAY_UINT_HEX, // Display in HEX format (if not specified, default is in decimal format)\r
306 minimum = 0,\r
307 maximum = 250,\r
308 default = 175,\r
309\r
310 endnumeric;\r
311\r
312 label LABEL_1_VALUE;\r
313 label LABEL_2_VALUE;\r
314\r
315 grayoutif ideqval MyIfrNVData.HowOldAreYouInYearsManual == 23 AND ideqval MyIfrNVData.SuppressGrayOutSomething == 0x1;\r
316 numeric varid = MyIfrNVData.HowOldAreYouInYears,\r
317 prompt = STRING_TOKEN(STR_NUMERIC_STEP_PROMPT),\r
318 help = STRING_TOKEN(STR_NUMERIC_HELP2),\r
319 minimum = 0,\r
320 maximum = 243,\r
321 step = 1,\r
322 default = 18,\r
7b414b4e 323\r
93e3992d 324 endnumeric;\r
325 endif;\r
326\r
327 //\r
328 // Non-interactive password, validate by Setup Browser\r
329 //\r
330 password varid = MyIfrNVData.WhatIsThePassword,\r
331 prompt = STRING_TOKEN(STR_PASSWORD_PROMPT),\r
332 help = STRING_TOKEN(STR_PASSWORD_HELP),\r
333 minsize = 6,\r
334 maxsize = 20, // new opcode\r
335 endpassword;\r
336\r
337 string varid = MyIfrNVData.PasswordClearText,\r
338 prompt = STRING_TOKEN(STR_MY_STRING_PROMPT),\r
339 help = STRING_TOKEN(STR_MY_STRING_HELP),\r
340 minsize = 6,\r
341 maxsize = 0x14,\r
342 endstring;\r
343\r
344 //\r
345 // Interactive password, validate via ConfigAccess.Callback()\r
346 //\r
347 password varid = MyIfrNVData.WhatIsThePassword2,\r
348 prompt = STRING_TOKEN(STR_PASSWORD_CALLBACK_PROMPT),\r
349 help = STRING_TOKEN(STR_PASSWORD_HELP),\r
350 flags = INTERACTIVE,\r
351 key = 0x2000,\r
352 minsize = 6,\r
353 maxsize = 20, // new opcode\r
354 endpassword;\r
355\r
356 goto 2,\r
357 prompt = STRING_TOKEN(STR_GOTO_FORM2), //SecondSetupPage // this too has no end-op and basically it's a jump to a form ONLY\r
358 help = STRING_TOKEN(STR_GOTO_HELP);\r
359\r
360 goto 3,\r
361 prompt = STRING_TOKEN(STR_GOTO_FORM3), //ThirdSetupPage // this too has no end-op and basically it's a jump to a form ONLY\r
362 help = STRING_TOKEN(STR_GOTO_HELP);\r
363\r
364 endform;\r
365\r
366 form formid = 2, // SecondSetupPage,\r
367 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\r
368\r
369\r
370 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\r
371 prompt = STRING_TOKEN(STR_DATE_PROMPT),\r
372 help = STRING_TOKEN(STR_DATE_YEAR_HELP),\r
373 minimum = 1998,\r
374 maximum = 2099,\r
375 step = 1,\r
376 default = 2004,\r
377\r
378 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\r
379 prompt = STRING_TOKEN(STR_DATE_PROMPT),\r
380 help = STRING_TOKEN(STR_DATE_MONTH_HELP),\r
381 minimum = 1,\r
382 maximum = 12,\r
383 step = 1,\r
384 default = 1,\r
385\r
386 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\r
387 prompt = STRING_TOKEN(STR_DATE_PROMPT),\r
388 help = STRING_TOKEN(STR_DATE_DAY_HELP),\r
389 minimum = 1,\r
390 maximum = 31,\r
391 step = 0x1,\r
392 default = 1,\r
393\r
394 inconsistentif prompt = STRING_TOKEN(STR_ERROR_POPUP),\r
395 ideqval Date.Day == 31\r
396 AND\r
397 ideqvallist Date.Month == 2 4 6 9 11\r
398 endif\r
399\r
400 //\r
401 // If the day is 30 AND month is 2\r
402 //\r
403 inconsistentif prompt = STRING_TOKEN(STR_ERROR_POPUP),\r
404 ideqval Date.Day == 30\r
405 AND\r
406 ideqval Date.Month == 2\r
407 endif\r
408\r
409 //\r
410 // If the day is 29 AND month is 2 AND it year is NOT a leapyear\r
411 //\r
412 inconsistentif prompt = STRING_TOKEN(STR_ERROR_POPUP),\r
413 ideqval Date.Day == 0x1D\r
414 AND\r
415 ideqval Date.Month == 2\r
416 AND\r
417 NOT\r
418 ideqvallist Date.Year == 2004 2008 20012 20016 2020 2024 2028 2032 2036\r
419 endif\r
420\r
421 enddate;\r
422\r
423 time hour varid = Time.Hours, // Note that it is a member of NULL, so the RTC will be the system resource to retrieve and save from\r
424 prompt = STRING_TOKEN(STR_TIME_PROMPT),\r
425 help = STRING_TOKEN(STR_TIME_HOUR_HELP),\r
426 minimum = 0,\r
427 maximum = 23,\r
428 step = 1,\r
429 default = 0,\r
430\r
431 minute varid = Time.Minutes, // Note that it is a member of NULL, so the RTC will be the system resource to retrieve and save from\r
432 prompt = STRING_TOKEN(STR_TIME_PROMPT),\r
433 help = STRING_TOKEN(STR_TIME_MINUTE_HELP),\r
434 minimum = 0,\r
435 maximum = 59,\r
436 step = 1,\r
437 default = 0,\r
438\r
439 second varid = Time.Seconds, // Note that it is a member of NULL, so the RTC will be the system resource to retrieve and save from\r
440 prompt = STRING_TOKEN(STR_TIME_PROMPT),\r
441 help = STRING_TOKEN(STR_TIME_SECOND_HELP),\r
442 minimum = 0,\r
443 maximum = 59,\r
444 step = 1,\r
445 default = 0,\r
446\r
447 endtime;\r
448\r
449 checkbox varid = MyIfrNVData.ChooseToActivateNuclearWeaponry,\r
450 prompt = STRING_TOKEN(STR_CHECK_BOX_PROMPT),\r
451 help = STRING_TOKEN(STR_CHECK_BOX_HELP),\r
452 flags = CHECKBOX_DEFAULT,\r
453 key = 0,\r
454 endcheckbox;\r
455\r
456 text\r
457 help = STRING_TOKEN(STR_TEXT_HELP),\r
458 text = STRING_TOKEN(STR_TEXT_TEXT_1);\r
459\r
460 text\r
461 help = STRING_TOKEN(STR_TEXT_HELP),\r
462 text = STRING_TOKEN(STR_TEXT_TEXT_1),\r
463 text = STRING_TOKEN(STR_TEXT_TEXT_2);\r
464\r
465 goto 1,\r
466 prompt = STRING_TOKEN(STR_GOTO_FORM1), //MainSetupPage // this too has no end-op and basically it's a jump to a form ONLY\r
467 help = STRING_TOKEN(STR_GOTO_HELP);\r
468\r
469 endform;\r
470\r
471 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\r
472\r
473 grayoutif ideqval MyIfrNVData.SuppressGrayOutSomething == 0x1;\r
474 text\r
475 help = STRING_TOKEN(STR_TEXT_HELP),\r
476 text = STRING_TOKEN(STR_TEXT_TEXT_1);\r
477 endif;\r
478\r
479 endform;\r
480\r
481 form formid = 4, title = STRING_TOKEN(STR_FORM3_TITLE);\r
482\r
483 endform;\r
484\r
485 form formid = 0x1234, // Dynamically created page,\r
486 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\r
487\r
488 label 0x1234;\r
489 //\r
490 // This is where we will insert dynamic created opcodes\r
491 //\r
492 label LABEL_END;\r
493\r
494 endform;\r
495\r
496endformset;\r
EFI Development Kit II mirror for PVE