]> git.proxmox.com Git - mirror_edk2.git/blame_incremental - MdeModulePkg/Universal/DriverSampleDxe/DriverSample.c
projects / mirror_edk2.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Update HiiDataBase to fix parsing Hii package error. Some HiiPackages have no varstor...
[mirror_edk2.git] / MdeModulePkg / Universal / DriverSampleDxe / DriverSample.c
... / ...
CommitLineData
1/** @file\r
2This is an example of how a driver might export data to the HII protocol to be\r
3later utilized by the Setup Protocol\r
4\r
5Copyright (c) 2004 - 2008, Intel Corporation\r
6All rights reserved. This program and the accompanying materials\r
7are licensed and made available under the terms and conditions of the BSD License\r
8which accompanies this distribution. The full text of the license may be found at\r
9http://opensource.org/licenses/bsd-license.php\r
10\r
11THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13\r
14**/\r
15\r
16\r
17#include "DriverSample.h"\r
18\r
19#define DISPLAY_ONLY_MY_ITEM 0x0002\r
20\r
21EFI_GUID mFormSetGuid = FORMSET_GUID;\r
22EFI_GUID mInventoryGuid = INVENTORY_GUID;\r
23\r
24CHAR16 VariableName[] = L"MyIfrNVData";\r
25\r
26EFI_HANDLE DriverHandle[2] = {NULL, NULL};\r
27DRIVER_SAMPLE_PRIVATE_DATA *PrivateData = NULL;\r
28\r
29HII_VENDOR_DEVICE_PATH mHiiVendorDevicePath0 = {\r
30 {\r
31 {\r
32 HARDWARE_DEVICE_PATH,\r
33 HW_VENDOR_DP,\r
34 {\r
35 (UINT8) (sizeof (VENDOR_DEVICE_PATH)),\r
36 (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)\r
37 }\r
38 },\r
39 //\r
40 // {C153B68D-EBFC-488e-B110-662867745B87}\r
41 //\r
42 { 0xc153b68d, 0xebfc, 0x488e, { 0xb1, 0x10, 0x66, 0x28, 0x67, 0x74, 0x5b, 0x87 } }\r
43 },\r
44 {\r
45 END_DEVICE_PATH_TYPE,\r
46 END_ENTIRE_DEVICE_PATH_SUBTYPE,\r
47 { \r
48 (UINT8) (END_DEVICE_PATH_LENGTH),\r
49 (UINT8) ((END_DEVICE_PATH_LENGTH) >> 8)\r
50 }\r
51 }\r
52};\r
53\r
54HII_VENDOR_DEVICE_PATH mHiiVendorDevicePath1 = {\r
55 {\r
56 {\r
57 HARDWARE_DEVICE_PATH,\r
58 HW_VENDOR_DP,\r
59 {\r
60 (UINT8) (sizeof (VENDOR_DEVICE_PATH)),\r
61 (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)\r
62 }\r
63 },\r
64 //\r
65 // {06F37F07-0C48-40e9-8436-0A08A0BB76B0}\r
66 //\r
67 { 0x6f37f07, 0xc48, 0x40e9, { 0x84, 0x36, 0xa, 0x8, 0xa0, 0xbb, 0x76, 0xb0 } }\r
68 },\r
69 {\r
70 END_DEVICE_PATH_TYPE,\r
71 END_ENTIRE_DEVICE_PATH_SUBTYPE,\r
72 { \r
73 (UINT8) (END_DEVICE_PATH_LENGTH),\r
74 (UINT8) ((END_DEVICE_PATH_LENGTH) >> 8)\r
75 }\r
76 }\r
77};\r
78\r
79/**\r
80 Encode the password using a simple algorithm.\r
81 \r
82 @param Password The string to be encoded.\r
83 @param MaxSize The size of the string.\r
84 \r
85**/\r
86VOID\r
87EncodePassword (\r
88 IN CHAR16 *Password,\r
89 IN UINTN MaxSize\r
90 )\r
91{\r
92 UINTN Index;\r
93 UINTN Loop;\r
94 CHAR16 *Buffer;\r
95 CHAR16 *Key;\r
96\r
97 Key = L"MAR10648567";\r
98 Buffer = AllocateZeroPool (MaxSize);\r
99 ASSERT (Buffer != NULL);\r
100\r
101 for (Index = 0; Key[Index] != 0; Index++) {\r
102 for (Loop = 0; Loop < (UINT8) (MaxSize / 2); Loop++) {\r
103 Buffer[Loop] = (CHAR16) (Password[Loop] ^ Key[Index]);\r
104 }\r
105 }\r
106\r
107 CopyMem (Password, Buffer, MaxSize);\r
108\r
109 FreePool (Buffer);\r
110 return ;\r
111}\r
112\r
113/**\r
114 Validate the user's password.\r
115 \r
116 @param PrivateData This driver's private context data.\r
117 @param StringId The user's input.\r
118 \r
119 @retval EFI_SUCCESS The user's input matches the password.\r
120 @retval EFI_NOT_READY The user's input does not match the password.\r
121**/\r
122EFI_STATUS\r
123ValidatePassword (\r
124 IN DRIVER_SAMPLE_PRIVATE_DATA *PrivateData,\r
125 IN EFI_STRING_ID StringId\r
126 )\r
127{\r
128 EFI_STATUS Status;\r
129 UINTN Index;\r
130 UINTN BufferSize;\r
131 UINTN PasswordMaxSize;\r
132 CHAR16 *Password;\r
133 CHAR16 *EncodedPassword;\r
134 BOOLEAN OldPassword;\r
135\r
136 //\r
137 // Get encoded password first\r
138 //\r
139 BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r
140 Status = gRT->GetVariable (\r
141 VariableName,\r
142 &mFormSetGuid,\r
143 NULL,\r
144 &BufferSize,\r
145 &PrivateData->Configuration\r
146 );\r
147 if (EFI_ERROR (Status)) {\r
148 //\r
149 // Old password not exist, prompt for new password\r
150 //\r
151 return EFI_SUCCESS;\r
152 }\r
153\r
154 OldPassword = FALSE;\r
155 PasswordMaxSize = sizeof (PrivateData->Configuration.WhatIsThePassword2);\r
156 //\r
157 // Check whether we have any old password set\r
158 //\r
159 for (Index = 0; Index < PasswordMaxSize / sizeof (UINT16); Index++) {\r
160 if (PrivateData->Configuration.WhatIsThePassword2[Index] != 0) {\r
161 OldPassword = TRUE;\r
162 break;\r
163 }\r
164 }\r
165 if (!OldPassword) {\r
166 //\r
167 // Old password not exist, return EFI_SUCCESS to prompt for new password\r
168 //\r
169 return EFI_SUCCESS;\r
170 }\r
171\r
172 //\r
173 // Get user input password\r
174 //\r
175 Password = HiiGetString (PrivateData->HiiHandle[0], StringId, NULL);\r
176 if (Password == NULL) {\r
177 return EFI_NOT_READY;\r
178 }\r
179 if (StrSize (Password) > PasswordMaxSize) {\r
180 FreePool (Password);\r
181 return EFI_NOT_READY;\r
182 }\r
183\r
184 //\r
185 // Validate old password\r
186 //\r
187 EncodedPassword = AllocateZeroPool (PasswordMaxSize);\r
188 ASSERT (EncodedPassword != NULL);\r
189 StrnCpy (EncodedPassword, Password, StrLen (Password));\r
190 EncodePassword (EncodedPassword, StrLen (EncodedPassword) * sizeof (CHAR16));\r
191 if (CompareMem (EncodedPassword, PrivateData->Configuration.WhatIsThePassword2, StrLen (EncodedPassword) * sizeof (CHAR16)) != 0) {\r
192 //\r
193 // Old password mismatch, return EFI_NOT_READY to prompt for error message\r
194 //\r
195 Status = EFI_NOT_READY;\r
196 } else {\r
197 Status = EFI_SUCCESS;\r
198 }\r
199\r
200 FreePool (Password);\r
201 FreePool (EncodedPassword);\r
202\r
203 return Status;\r
204}\r
205\r
206/**\r
207 Encode the password using a simple algorithm.\r
208 \r
209 @param PrivateData This driver's private context data.\r
210 @param StringId The password from User.\r
211 \r
212 @retval EFI_SUCESS The operation is successful.\r
213 @return Other value if gRT->SetVariable () fails.\r
214 \r
215**/\r
216EFI_STATUS\r
217SetPassword (\r
218 IN DRIVER_SAMPLE_PRIVATE_DATA *PrivateData,\r
219 IN EFI_STRING_ID StringId\r
220 )\r
221{\r
222 EFI_STATUS Status;\r
223 CHAR16 *Password;\r
224 CHAR16 *TempPassword;\r
225 UINTN PasswordSize;\r
226 DRIVER_SAMPLE_CONFIGURATION *Configuration;\r
227 UINTN BufferSize;\r
228\r
229 //\r
230 // Get Buffer Storage data from EFI variable\r
231 //\r
232 BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r
233 Status = gRT->GetVariable (\r
234 VariableName,\r
235 &mFormSetGuid,\r
236 NULL,\r
237 &BufferSize,\r
238 &PrivateData->Configuration\r
239 );\r
240 if (EFI_ERROR (Status)) {\r
241 return Status;\r
242 }\r
243\r
244 //\r
245 // Get user input password\r
246 //\r
247 Password = &PrivateData->Configuration.WhatIsThePassword2[0];\r
248 PasswordSize = sizeof (PrivateData->Configuration.WhatIsThePassword2); \r
249 ZeroMem (Password, PasswordSize);\r
250 \r
251 TempPassword = HiiGetString (PrivateData->HiiHandle[0], StringId, NULL);\r
252 if (TempPassword == NULL) {\r
253 return EFI_NOT_READY;\r
254 }\r
255 if (StrSize (TempPassword) > PasswordSize) {\r
256 FreePool (TempPassword);\r
257 return EFI_NOT_READY;\r
258 }\r
259 StrnCpy (Password, TempPassword, StrLen (TempPassword));\r
260 FreePool (TempPassword);\r
261\r
262 //\r
263 // Retrive uncommitted data from Browser\r
264 //\r
265 Configuration = AllocateZeroPool (sizeof (DRIVER_SAMPLE_CONFIGURATION));\r
266 ASSERT (Configuration != NULL);\r
267 if (HiiGetBrowserData (&mFormSetGuid, VariableName, sizeof (DRIVER_SAMPLE_CONFIGURATION), (UINT8 *) Configuration)) {\r
268 //\r
269 // Update password's clear text in the screen\r
270 //\r
271 CopyMem (Configuration->PasswordClearText, Password, StrSize (Password));\r
272\r
273 //\r
274 // Update uncommitted data of Browser\r
275 //\r
276 HiiSetBrowserData (\r
277 &mFormSetGuid,\r
278 VariableName,\r
279 sizeof (DRIVER_SAMPLE_CONFIGURATION),\r
280 (UINT8 *) Configuration,\r
281 NULL\r
282 );\r
283 }\r
284\r
285 //\r
286 // Free Configuration Buffer\r
287 //\r
288 FreePool (Configuration);\r
289\r
290\r
291 //\r
292 // Set password\r
293 //\r
294 EncodePassword (Password, StrLen (Password) * 2);\r
295 Status = gRT->SetVariable(\r
296 VariableName,\r
297 &mFormSetGuid,\r
298 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
299 sizeof (DRIVER_SAMPLE_CONFIGURATION),\r
300 &PrivateData->Configuration\r
301 );\r
302 return Status;\r
303}\r
304\r
305\r
306/**\r
307 This function allows a caller to extract the current configuration for one\r
308 or more named elements from the target driver.\r
309\r
310 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
311 @param Request A null-terminated Unicode string in\r
312 <ConfigRequest> format.\r
313 @param Progress On return, points to a character in the Request\r
314 string. Points to the string's null terminator if\r
315 request was successful. Points to the most recent\r
316 '&' before the first failing name/value pair (or\r
317 the beginning of the string if the failure is in\r
318 the first name/value pair) if the request was not\r
319 successful.\r
320 @param Results A null-terminated Unicode string in\r
321 <ConfigAltResp> format which has all values filled\r
322 in for the names in the Request string. String to\r
323 be allocated by the called function.\r
324\r
325 @retval EFI_SUCCESS The Results is filled with the requested values.\r
326 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.\r
327 @retval EFI_INVALID_PARAMETER Request is NULL, illegal syntax, or unknown name.\r
328 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this\r
329 driver.\r
330\r
331**/\r
332EFI_STATUS\r
333EFIAPI\r
334ExtractConfig (\r
335 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r
336 IN CONST EFI_STRING Request,\r
337 OUT EFI_STRING *Progress,\r
338 OUT EFI_STRING *Results\r
339 )\r
340{\r
341 EFI_STATUS Status;\r
342 UINTN BufferSize;\r
343 DRIVER_SAMPLE_PRIVATE_DATA *PrivateData;\r
344 EFI_HII_CONFIG_ROUTING_PROTOCOL *HiiConfigRouting;\r
345 EFI_STRING ConfigRequestHdr;\r
346 EFI_STRING ConfigRequest;\r
347 UINTN Size;\r
348\r
349 //\r
350 // Initialize the local variables.\r
351 //\r
352 ConfigRequestHdr = NULL;\r
353 ConfigRequest = NULL;\r
354 Size = 0;\r
355 *Progress = Request;\r
356\r
357 PrivateData = DRIVER_SAMPLE_PRIVATE_FROM_THIS (This);\r
358 HiiConfigRouting = PrivateData->HiiConfigRouting;\r
359\r
360 //\r
361 // Get Buffer Storage data from EFI variable.\r
362 // Try to get the current setting from variable.\r
363 //\r
364 BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r
365 gRT->GetVariable (\r
366 VariableName,\r
367 &mFormSetGuid,\r
368 NULL,\r
369 &BufferSize,\r
370 &PrivateData->Configuration\r
371 );\r
372 \r
373 if (Request == NULL) {\r
374 //\r
375 // Request is set to NULL, construct full request string.\r
376 //\r
377\r
378 //\r
379 // First Set ConfigRequestHdr string.\r
380 //\r
381 ConfigRequestHdr = HiiConstructConfigHdr (&mFormSetGuid, VariableName, PrivateData->DriverHandle[0]);\r
382 ASSERT (ConfigRequestHdr != NULL);\r
383\r
384 //\r
385 // Allocate and fill a buffer large enough to hold the <ConfigHdr> template \r
386 // followed by "&OFFSET=0&WIDTH=WWWWWWWWWWWWWWWW" followed by a Null-terminator\r
387 //\r
388 Size = (StrLen (ConfigRequestHdr) + 32 + 1) * sizeof (CHAR16);\r
389 ConfigRequest = AllocateZeroPool (Size);\r
390 UnicodeSPrint (ConfigRequest, Size, L"%s&OFFSET=0&WIDTH=%016LX", ConfigRequestHdr, (UINT64)BufferSize);\r
391 FreePool (ConfigRequestHdr);\r
392 } else {\r
393 ConfigRequest = Request;\r
394 }\r
395\r
396 //\r
397 // Check routing data in <ConfigHdr>.\r
398 // Note: if only one Storage is used, then this checking could be skipped.\r
399 //\r
400 if (!HiiIsConfigHdrMatch (ConfigRequest, &mFormSetGuid, VariableName)) {\r
401 if (Request == NULL) {\r
402 FreePool (ConfigRequest);\r
403 }\r
404 return EFI_NOT_FOUND;\r
405 }\r
406\r
407 //\r
408 // Convert buffer data to <ConfigResp> by helper function BlockToConfig()\r
409 //\r
410 Status = HiiConfigRouting->BlockToConfig (\r
411 HiiConfigRouting,\r
412 ConfigRequest,\r
413 (UINT8 *) &PrivateData->Configuration,\r
414 BufferSize,\r
415 Results,\r
416 Progress\r
417 );\r
418 \r
419 if (Request == NULL) {\r
420 FreePool (ConfigRequest);\r
421 *Progress = NULL;\r
422 }\r
423\r
424 return Status;\r
425}\r
426\r
427\r
428/**\r
429 This function processes the results of changes in configuration.\r
430\r
431 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
432 @param Configuration A null-terminated Unicode string in <ConfigResp>\r
433 format.\r
434 @param Progress A pointer to a string filled in with the offset of\r
435 the most recent '&' before the first failing\r
436 name/value pair (or the beginning of the string if\r
437 the failure is in the first name/value pair) or\r
438 the terminating NULL if all was successful.\r
439\r
440 @retval EFI_SUCCESS The Results is processed successfully.\r
441 @retval EFI_INVALID_PARAMETER Configuration is NULL.\r
442 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this\r
443 driver.\r
444\r
445**/\r
446EFI_STATUS\r
447EFIAPI\r
448RouteConfig (\r
449 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r
450 IN CONST EFI_STRING Configuration,\r
451 OUT EFI_STRING *Progress\r
452 )\r
453{\r
454 EFI_STATUS Status;\r
455 UINTN BufferSize;\r
456 DRIVER_SAMPLE_PRIVATE_DATA *PrivateData;\r
457 EFI_HII_CONFIG_ROUTING_PROTOCOL *HiiConfigRouting;\r
458\r
459 if (Configuration == NULL) {\r
460 return EFI_INVALID_PARAMETER;\r
461 }\r
462\r
463 PrivateData = DRIVER_SAMPLE_PRIVATE_FROM_THIS (This);\r
464 HiiConfigRouting = PrivateData->HiiConfigRouting;\r
465\r
466 //\r
467 // Check routing data in <ConfigHdr>.\r
468 // Note: if only one Storage is used, then this checking could be skipped.\r
469 //\r
470 if (!HiiIsConfigHdrMatch (Configuration, &mFormSetGuid, VariableName)) {\r
471 *Progress = Configuration;\r
472 return EFI_NOT_FOUND;\r
473 }\r
474\r
475 //\r
476 // Get Buffer Storage data from EFI variable\r
477 //\r
478 BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r
479 gRT->GetVariable (\r
480 VariableName,\r
481 &mFormSetGuid,\r
482 NULL,\r
483 &BufferSize,\r
484 &PrivateData->Configuration\r
485 );\r
486\r
487 //\r
488 // Convert <ConfigResp> to buffer data by helper function ConfigToBlock()\r
489 //\r
490 BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r
491 Status = HiiConfigRouting->ConfigToBlock (\r
492 HiiConfigRouting,\r
493 Configuration,\r
494 (UINT8 *) &PrivateData->Configuration,\r
495 &BufferSize,\r
496 Progress\r
497 );\r
498 if (EFI_ERROR (Status)) {\r
499 return Status;\r
500 }\r
501\r
502 //\r
503 // Store Buffer Storage back to EFI variable\r
504 //\r
505 Status = gRT->SetVariable(\r
506 VariableName,\r
507 &mFormSetGuid,\r
508 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
509 sizeof (DRIVER_SAMPLE_CONFIGURATION),\r
510 &PrivateData->Configuration\r
511 );\r
512\r
513 return Status;\r
514}\r
515\r
516\r
517/**\r
518 This function processes the results of changes in configuration.\r
519\r
520 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
521 @param Action Specifies the type of action taken by the browser.\r
522 @param QuestionId A unique value which is sent to the original\r
523 exporting driver so that it can identify the type\r
524 of data to expect.\r
525 @param Type The type of value for the question.\r
526 @param Value A pointer to the data being sent to the original\r
527 exporting driver.\r
528 @param ActionRequest On return, points to the action requested by the\r
529 callback function.\r
530\r
531 @retval EFI_SUCCESS The callback successfully handled the action.\r
532 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the\r
533 variable and its data.\r
534 @retval EFI_DEVICE_ERROR The variable could not be saved.\r
535 @retval EFI_UNSUPPORTED The specified Action is not supported by the\r
536 callback.\r
537\r
538**/\r
539EFI_STATUS\r
540EFIAPI\r
541DriverCallback (\r
542 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r
543 IN EFI_BROWSER_ACTION Action,\r
544 IN EFI_QUESTION_ID QuestionId,\r
545 IN UINT8 Type,\r
546 IN EFI_IFR_TYPE_VALUE *Value,\r
547 OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest\r
548 )\r
549{\r
550 DRIVER_SAMPLE_PRIVATE_DATA *PrivateData;\r
551 EFI_STATUS Status;\r
552 UINT8 MyVar;\r
553 VOID *StartOpCodeHandle;\r
554 VOID *OptionsOpCodeHandle;\r
555 EFI_IFR_GUID_LABEL *StartLabel;\r
556 VOID *EndOpCodeHandle;\r
557 EFI_IFR_GUID_LABEL *EndLabel;\r
558\r
559 if ((Value == NULL) || (ActionRequest == NULL)) {\r
560 return EFI_INVALID_PARAMETER;\r
561 }\r
562 \r
563 if ((Type == EFI_IFR_TYPE_STRING) && (Value->string == 0)) {\r
564 return EFI_INVALID_PARAMETER;\r
565 }\r
566 \r
567\r
568 Status = EFI_SUCCESS;\r
569 PrivateData = DRIVER_SAMPLE_PRIVATE_FROM_THIS (This);\r
570\r
571 switch (QuestionId) {\r
572 case 0x1234:\r
573 //\r
574 // Initialize the container for dynamic opcodes\r
575 //\r
576 StartOpCodeHandle = HiiAllocateOpCodeHandle ();\r
577 ASSERT (StartOpCodeHandle != NULL);\r
578\r
579 EndOpCodeHandle = HiiAllocateOpCodeHandle ();\r
580 ASSERT (EndOpCodeHandle != NULL);\r
581\r
582 //\r
583 // Create Hii Extend Label OpCode as the start opcode\r
584 //\r
585 StartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (StartOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));\r
586 StartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;\r
587 StartLabel->Number = LABEL_UPDATE1;\r
588\r
589 //\r
590 // Create Hii Extend Label OpCode as the end opcode\r
591 //\r
592 EndLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (EndOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));\r
593 EndLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;\r
594 EndLabel->Number = LABEL_END;\r
595\r
596 HiiCreateActionOpCode (\r
597 StartOpCodeHandle, // Container for dynamic created opcodes\r
598 0x1237, // Question ID\r
599 STRING_TOKEN(STR_EXIT_TEXT), // Prompt text\r
600 STRING_TOKEN(STR_EXIT_TEXT), // Help text\r
601 EFI_IFR_FLAG_CALLBACK, // Question flag\r
602 0 // Action String ID\r
603 );\r
604\r
605 //\r
606 // Create Option OpCode\r
607 //\r
608 OptionsOpCodeHandle = HiiAllocateOpCodeHandle ();\r
609 ASSERT (OptionsOpCodeHandle != NULL);\r
610\r
611 HiiCreateOneOfOptionOpCode (\r
612 OptionsOpCodeHandle,\r
613 STRING_TOKEN (STR_BOOT_OPTION1),\r
614 0,\r
615 EFI_IFR_NUMERIC_SIZE_1,\r
616 1\r
617 );\r
618\r
619 HiiCreateOneOfOptionOpCode (\r
620 OptionsOpCodeHandle,\r
621 STRING_TOKEN (STR_BOOT_OPTION2),\r
622 0,\r
623 EFI_IFR_NUMERIC_SIZE_1,\r
624 2\r
625 );\r
626\r
627 //\r
628 // Prepare initial value for the dynamic created oneof Question\r
629 //\r
630 PrivateData->Configuration.DynamicOneof = 2;\r
631 Status = gRT->SetVariable(\r
632 VariableName,\r
633 &mFormSetGuid,\r
634 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
635 sizeof (DRIVER_SAMPLE_CONFIGURATION),\r
636 &PrivateData->Configuration\r
637 );\r
638\r
639 HiiCreateOneOfOpCode (\r
640 StartOpCodeHandle, // Container for dynamic created opcodes\r
641 0x8001, // Question ID (or call it "key")\r
642 CONFIGURATION_VARSTORE_ID, // VarStore ID\r
643 (UINT16) DYNAMIC_ONE_OF_VAR_OFFSET, // Offset in Buffer Storage\r
644 STRING_TOKEN (STR_ONE_OF_PROMPT), // Question prompt text\r
645 STRING_TOKEN (STR_ONE_OF_HELP), // Question help text\r
646 EFI_IFR_FLAG_CALLBACK, // Question flag\r
647 EFI_IFR_NUMERIC_SIZE_1, // Data type of Question Value\r
648 OptionsOpCodeHandle, // Option Opcode list\r
649 NULL // Default Opcode is NULl\r
650 );\r
651\r
652 HiiCreateOrderedListOpCode (\r
653 StartOpCodeHandle, // Container for dynamic created opcodes\r
654 0x8002, // Question ID\r
655 CONFIGURATION_VARSTORE_ID, // VarStore ID\r
656 (UINT16) DYNAMIC_ORDERED_LIST_VAR_OFFSET, // Offset in Buffer Storage\r
657 STRING_TOKEN (STR_BOOT_OPTIONS), // Question prompt text\r
658 STRING_TOKEN (STR_BOOT_OPTIONS), // Question help text\r
659 EFI_IFR_FLAG_RESET_REQUIRED, // Question flag\r
660 0, // Ordered list flag, e.g. EFI_IFR_UNIQUE_SET\r
661 EFI_IFR_NUMERIC_SIZE_1, // Data type of Question value\r
662 5, // Maximum container\r
663 OptionsOpCodeHandle, // Option Opcode list\r
664 NULL // Default Opcode is NULl\r
665 );\r
666\r
667 HiiCreateGotoOpCode (\r
668 StartOpCodeHandle, // Container for dynamic created opcodes\r
669 1, // Target Form ID\r
670 STRING_TOKEN (STR_GOTO_FORM1), // Prompt text\r
671 STRING_TOKEN (STR_GOTO_HELP), // Help text\r
672 0, // Question flag\r
673 0x8003 // Question ID\r
674 );\r
675\r
676 HiiUpdateForm (\r
677 PrivateData->HiiHandle[0], // HII handle\r
678 &mFormSetGuid, // Formset GUID\r
679 0x1234, // Form ID\r
680 StartOpCodeHandle, // Label for where to insert opcodes\r
681 EndOpCodeHandle // Replace data\r
682 );\r
683\r
684 HiiFreeOpCodeHandle (StartOpCodeHandle);\r
685 HiiFreeOpCodeHandle (OptionsOpCodeHandle);\r
686 break;\r
687 \r
688 case 0x5678:\r
689 //\r
690 // We will reach here once the Question is refreshed\r
691 //\r
692\r
693 //\r
694 // Initialize the container for dynamic opcodes\r
695 //\r
696 StartOpCodeHandle = HiiAllocateOpCodeHandle ();\r
697 ASSERT (StartOpCodeHandle != NULL);\r
698\r
699 //\r
700 // Create Hii Extend Label OpCode as the start opcode\r
701 //\r
702 StartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (StartOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));\r
703 StartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;\r
704 StartLabel->Number = LABEL_UPDATE2;\r
705\r
706 HiiCreateActionOpCode (\r
707 StartOpCodeHandle, // Container for dynamic created opcodes\r
708 0x1237, // Question ID\r
709 STRING_TOKEN(STR_EXIT_TEXT), // Prompt text\r
710 STRING_TOKEN(STR_EXIT_TEXT), // Help text\r
711 EFI_IFR_FLAG_CALLBACK, // Question flag\r
712 0 // Action String ID\r
713 );\r
714 \r
715 HiiUpdateForm (\r
716 PrivateData->HiiHandle[0], // HII handle\r
717 &mFormSetGuid, // Formset GUID\r
718 0x3, // Form ID\r
719 StartOpCodeHandle, // Label for where to insert opcodes\r
720 NULL // Insert data\r
721 );\r
722\r
723 HiiFreeOpCodeHandle (StartOpCodeHandle); \r
724 \r
725 //\r
726 // Refresh the Question value\r
727 //\r
728 PrivateData->Configuration.DynamicRefresh++;\r
729 Status = gRT->SetVariable(\r
730 VariableName,\r
731 &mFormSetGuid,\r
732 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
733 sizeof (DRIVER_SAMPLE_CONFIGURATION),\r
734 &PrivateData->Configuration\r
735 );\r
736 \r
737 //\r
738 // Change an EFI Variable storage (MyEfiVar) asynchronous, this will cause\r
739 // the first statement in Form 3 be suppressed\r
740 //\r
741 MyVar = 111;\r
742 Status = gRT->SetVariable(\r
743 L"MyVar",\r
744 &mFormSetGuid,\r
745 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
746 1,\r
747 &MyVar\r
748 );\r
749 break;\r
750\r
751 case 0x1237:\r
752 //\r
753 // User press "Exit now", request Browser to exit\r
754 //\r
755 *ActionRequest = EFI_BROWSER_ACTION_REQUEST_EXIT;\r
756 break;\r
757\r
758 case 0x1238:\r
759 //\r
760 // User press "Save now", request Browser to save the uncommitted data.\r
761 //\r
762 *ActionRequest = EFI_BROWSER_ACTION_REQUEST_SUBMIT;\r
763 break;\r
764\r
765 case 0x2000:\r
766 //\r
767 // When try to set a new password, user will be chanlleged with old password.\r
768 // The Callback is responsible for validating old password input by user,\r
769 // If Callback return EFI_SUCCESS, it indicates validation pass.\r
770 //\r
771 switch (PrivateData->PasswordState) {\r
772 case BROWSER_STATE_VALIDATE_PASSWORD:\r
773 Status = ValidatePassword (PrivateData, Value->string);\r
774 if (Status == EFI_SUCCESS) {\r
775 PrivateData->PasswordState = BROWSER_STATE_SET_PASSWORD;\r
776 }\r
777 break;\r
778\r
779 case BROWSER_STATE_SET_PASSWORD:\r
780 Status = SetPassword (PrivateData, Value->string);\r
781 PrivateData->PasswordState = BROWSER_STATE_VALIDATE_PASSWORD;\r
782 break;\r
783\r
784 default:\r
785 break;\r
786 }\r
787\r
788 break;\r
789\r
790 default:\r
791 break;\r
792 }\r
793\r
794 return Status;\r
795}\r
796\r
797/**\r
798 Main entry for this driver.\r
799 \r
800 @param ImageHandle Image handle this driver.\r
801 @param SystemTable Pointer to SystemTable.\r
802\r
803 @retval EFI_SUCESS This function always complete successfully.\r
804\r
805**/\r
806EFI_STATUS\r
807EFIAPI\r
808DriverSampleInit (\r
809 IN EFI_HANDLE ImageHandle,\r
810 IN EFI_SYSTEM_TABLE *SystemTable\r
811 )\r
812{\r
813 EFI_STATUS Status;\r
814 EFI_HII_HANDLE HiiHandle[2];\r
815 EFI_SCREEN_DESCRIPTOR Screen;\r
816 EFI_HII_DATABASE_PROTOCOL *HiiDatabase;\r
817 EFI_HII_STRING_PROTOCOL *HiiString;\r
818 EFI_FORM_BROWSER2_PROTOCOL *FormBrowser2;\r
819 EFI_HII_CONFIG_ROUTING_PROTOCOL *HiiConfigRouting;\r
820 CHAR16 *NewString;\r
821 UINTN BufferSize;\r
822 DRIVER_SAMPLE_CONFIGURATION *Configuration;\r
823 BOOLEAN ActionFlag;\r
824 EFI_STRING ConfigRequestHdr; \r
825\r
826 //\r
827 // Initialize the local variables.\r
828 //\r
829 ConfigRequestHdr = NULL;\r
830\r
831 //\r
832 // Initialize screen dimensions for SendForm().\r
833 // Remove 3 characters from top and bottom\r
834 //\r
835 ZeroMem (&Screen, sizeof (EFI_SCREEN_DESCRIPTOR));\r
836 gST->ConOut->QueryMode (gST->ConOut, gST->ConOut->Mode->Mode, &Screen.RightColumn, &Screen.BottomRow);\r
837\r
838 Screen.TopRow = 3;\r
839 Screen.BottomRow = Screen.BottomRow - 3;\r
840\r
841 //\r
842 // Initialize driver private data\r
843 //\r
844 PrivateData = AllocatePool (sizeof (DRIVER_SAMPLE_PRIVATE_DATA));\r
845 if (PrivateData == NULL) {\r
846 return EFI_OUT_OF_RESOURCES;\r
847 }\r
848\r
849 PrivateData->Signature = DRIVER_SAMPLE_PRIVATE_SIGNATURE;\r
850\r
851 PrivateData->ConfigAccess.ExtractConfig = ExtractConfig;\r
852 PrivateData->ConfigAccess.RouteConfig = RouteConfig;\r
853 PrivateData->ConfigAccess.Callback = DriverCallback;\r
854 PrivateData->PasswordState = BROWSER_STATE_VALIDATE_PASSWORD;\r
855\r
856 //\r
857 // Locate Hii Database protocol\r
858 //\r
859 Status = gBS->LocateProtocol (&gEfiHiiDatabaseProtocolGuid, NULL, (VOID **) &HiiDatabase);\r
860 if (EFI_ERROR (Status)) {\r
861 return Status;\r
862 }\r
863 PrivateData->HiiDatabase = HiiDatabase;\r
864\r
865 //\r
866 // Locate HiiString protocol\r
867 //\r
868 Status = gBS->LocateProtocol (&gEfiHiiStringProtocolGuid, NULL, (VOID **) &HiiString);\r
869 if (EFI_ERROR (Status)) {\r
870 return Status;\r
871 }\r
872 PrivateData->HiiString = HiiString;\r
873\r
874 //\r
875 // Locate Formbrowser2 protocol\r
876 //\r
877 Status = gBS->LocateProtocol (&gEfiFormBrowser2ProtocolGuid, NULL, (VOID **) &FormBrowser2);\r
878 if (EFI_ERROR (Status)) {\r
879 return Status;\r
880 }\r
881 PrivateData->FormBrowser2 = FormBrowser2;\r
882\r
883 //\r
884 // Locate ConfigRouting protocol\r
885 //\r
886 Status = gBS->LocateProtocol (&gEfiHiiConfigRoutingProtocolGuid, NULL, (VOID **) &HiiConfigRouting);\r
887 if (EFI_ERROR (Status)) {\r
888 return Status;\r
889 }\r
890 PrivateData->HiiConfigRouting = HiiConfigRouting;\r
891\r
892 Status = gBS->InstallMultipleProtocolInterfaces (\r
893 &DriverHandle[0],\r
894 &gEfiDevicePathProtocolGuid,\r
895 &mHiiVendorDevicePath0,\r
896 &gEfiHiiConfigAccessProtocolGuid,\r
897 &PrivateData->ConfigAccess,\r
898 NULL\r
899 );\r
900 ASSERT_EFI_ERROR (Status);\r
901\r
902 PrivateData->DriverHandle[0] = DriverHandle[0];\r
903\r
904 //\r
905 // Publish our HII data\r
906 //\r
907 HiiHandle[0] = HiiAddPackages (\r
908 &mFormSetGuid,\r
909 DriverHandle[0],\r
910 DriverSampleStrings,\r
911 VfrBin,\r
912 NULL\r
913 );\r
914 if (HiiHandle[0] == NULL) {\r
915 return EFI_OUT_OF_RESOURCES;\r
916 }\r
917\r
918 PrivateData->HiiHandle[0] = HiiHandle[0];\r
919\r
920 //\r
921 // Publish another Fromset\r
922 //\r
923 Status = gBS->InstallMultipleProtocolInterfaces (\r
924 &DriverHandle[1],\r
925 &gEfiDevicePathProtocolGuid,\r
926 &mHiiVendorDevicePath1,\r
927 NULL\r
928 );\r
929 ASSERT_EFI_ERROR (Status);\r
930\r
931 PrivateData->DriverHandle[1] = DriverHandle[1];\r
932\r
933 HiiHandle[1] = HiiAddPackages (\r
934 &mInventoryGuid,\r
935 DriverHandle[1],\r
936 DriverSampleStrings,\r
937 InventoryBin,\r
938 NULL\r
939 );\r
940 if (HiiHandle[1] == NULL) {\r
941 return EFI_OUT_OF_RESOURCES;\r
942 }\r
943\r
944 PrivateData->HiiHandle[1] = HiiHandle[1];\r
945\r
946 //\r
947 // Very simple example of how one would update a string that is already\r
948 // in the HII database\r
949 //\r
950 NewString = L"700 Mhz";\r
951\r
952 if (HiiSetString (HiiHandle[0], STRING_TOKEN (STR_CPU_STRING2), NewString, NULL) == 0) {\r
953 return EFI_OUT_OF_RESOURCES;\r
954 }\r
955\r
956 //\r
957 // Initialize configuration data\r
958 //\r
959 Configuration = &PrivateData->Configuration;\r
960 ZeroMem (Configuration, sizeof (DRIVER_SAMPLE_CONFIGURATION));\r
961\r
962 //\r
963 // Try to read NV config EFI variable first\r
964 //\r
965 ConfigRequestHdr = HiiConstructConfigHdr (&mFormSetGuid, VariableName, DriverHandle[0]);\r
966 ASSERT (ConfigRequestHdr != NULL);\r
967\r
968 BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r
969 Status = gRT->GetVariable (VariableName, &mFormSetGuid, NULL, &BufferSize, Configuration);\r
970 if (EFI_ERROR (Status)) {\r
971 //\r
972 // EFI variable for NV config doesn't exit, we should build this variable\r
973 // based on default values stored in IFR\r
974 //\r
975 ActionFlag = HiiSetToDefaults (ConfigRequestHdr, EFI_HII_DEFAULT_CLASS_STANDARD);\r
976 ASSERT (ActionFlag);\r
977 } else {\r
978 //\r
979 // EFI variable does exist and Validate Current Setting\r
980 //\r
981 ActionFlag = HiiValidateSettings (ConfigRequestHdr);\r
982 ASSERT (ActionFlag);\r
983 }\r
984 \r
985 FreePool (ConfigRequestHdr);\r
986\r
987\r
988 //\r
989 // In default, this driver is built into Flash device image, \r
990 // the following code doesn't run.\r
991 //\r
992\r
993 //\r
994 // Example of how to display only the item we sent to HII\r
995 // When this driver is not built into Flash device image, \r
996 // it need to call SendForm to show front page by itself.\r
997 //\r
998 if (DISPLAY_ONLY_MY_ITEM <= 1) {\r
999 //\r
1000 // Have the browser pull out our copy of the data, and only display our data\r
1001 //\r
1002 Status = FormBrowser2->SendForm (\r
1003 FormBrowser2,\r
1004 &(HiiHandle[DISPLAY_ONLY_MY_ITEM]),\r
1005 1,\r
1006 NULL,\r
1007 0,\r
1008 NULL,\r
1009 NULL\r
1010 );\r
1011 \r
1012 HiiRemovePackages (HiiHandle[0]);\r
1013 \r
1014 HiiRemovePackages (HiiHandle[1]);\r
1015 }\r
1016\r
1017 return EFI_SUCCESS;\r
1018}\r
1019\r
1020/**\r
1021 Unloads the application and its installed protocol.\r
1022\r
1023 @param[in] ImageHandle Handle that identifies the image to be unloaded.\r
1024\r
1025 @retval EFI_SUCCESS The image has been unloaded.\r
1026**/\r
1027EFI_STATUS\r
1028EFIAPI\r
1029DriverSampleUnload (\r
1030 IN EFI_HANDLE ImageHandle\r
1031 )\r
1032{\r
1033 if (DriverHandle[0] != NULL) {\r
1034 gBS->UninstallMultipleProtocolInterfaces (\r
1035 DriverHandle[0],\r
1036 &gEfiDevicePathProtocolGuid,\r
1037 &mHiiVendorDevicePath0,\r
1038 &gEfiHiiConfigAccessProtocolGuid,\r
1039 &PrivateData->ConfigAccess,\r
1040 NULL\r
1041 );\r
1042 }\r
1043\r
1044 if (DriverHandle[1] != NULL) {\r
1045 gBS->UninstallMultipleProtocolInterfaces (\r
1046 DriverHandle[1],\r
1047 &gEfiDevicePathProtocolGuid,\r
1048 &mHiiVendorDevicePath1,\r
1049 NULL\r
1050 );\r
1051 }\r
1052\r
1053 if (PrivateData->HiiHandle[0] != NULL) {\r
1054 HiiRemovePackages (PrivateData->HiiHandle[0]);\r
1055 }\r
1056\r
1057 if (PrivateData->HiiHandle[1] != NULL) {\r
1058 HiiRemovePackages (PrivateData->HiiHandle[1]);\r
1059 }\r
1060\r
1061 if (PrivateData != NULL) {\r
1062 FreePool (PrivateData);\r
1063 }\r
1064\r
1065 return EFI_SUCCESS;\r
1066}\r
EFI Development Kit II mirror for PVE