]> 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
Correct DriverSample to produce the ConfigAccess protocol
[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 Status = gRT->GetVariable (\r
366 VariableName,\r
367 &mFormSetGuid,\r
368 NULL,\r
369 &BufferSize,\r
370 &PrivateData->Configuration\r
371 );\r
372 if (EFI_ERROR (Status)) {\r
373 return Status;\r
374 }\r
375 \r
376 if (Request == NULL) {\r
377 //\r
378 // Request is set to NULL, construct full request string.\r
379 //\r
380\r
381 //\r
382 // First Set ConfigRequestHdr string.\r
383 //\r
384 ConfigRequestHdr = HiiConstructConfigHdr (&mFormSetGuid, VariableName, PrivateData->DriverHandle[0]);\r
385 ASSERT (ConfigRequestHdr != NULL);\r
386\r
387 //\r
388 // Allocate and fill a buffer large enough to hold the <ConfigHdr> template \r
389 // followed by "&OFFSET=0&WIDTH=WWWWWWWWWWWWWWWW" followed by a Null-terminator\r
390 //\r
391 Size = (StrLen (ConfigRequestHdr) + 32 + 1) * sizeof (CHAR16);\r
392 ConfigRequest = AllocateZeroPool (Size);\r
393 UnicodeSPrint (ConfigRequest, Size, L"%s&OFFSET=0&WIDTH=%016LX", ConfigRequestHdr, (UINT64)BufferSize);\r
394 FreePool (ConfigRequestHdr);\r
395 } else {\r
396 ConfigRequest = Request;\r
397 }\r
398\r
399 //\r
400 // Check routing data in <ConfigHdr>.\r
401 // Note: if only one Storage is used, then this checking could be skipped.\r
402 //\r
403 if (!HiiIsConfigHdrMatch (ConfigRequest, &mFormSetGuid, VariableName)) {\r
404 if (Request == NULL) {\r
405 FreePool (ConfigRequest);\r
406 }\r
407 return EFI_NOT_FOUND;\r
408 }\r
409\r
410 //\r
411 // Convert buffer data to <ConfigResp> by helper function BlockToConfig()\r
412 //\r
413 Status = HiiConfigRouting->BlockToConfig (\r
414 HiiConfigRouting,\r
415 ConfigRequest,\r
416 (UINT8 *) &PrivateData->Configuration,\r
417 BufferSize,\r
418 Results,\r
419 Progress\r
420 );\r
421 \r
422 if (Request == NULL) {\r
423 FreePool (ConfigRequest);\r
424 *Progress = NULL;\r
425 }\r
426\r
427 return Status;\r
428}\r
429\r
430\r
431/**\r
432 This function processes the results of changes in configuration.\r
433\r
434 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
435 @param Configuration A null-terminated Unicode string in <ConfigResp>\r
436 format.\r
437 @param Progress A pointer to a string filled in with the offset of\r
438 the most recent '&' before the first failing\r
439 name/value pair (or the beginning of the string if\r
440 the failure is in the first name/value pair) or\r
441 the terminating NULL if all was successful.\r
442\r
443 @retval EFI_SUCCESS The Results is processed successfully.\r
444 @retval EFI_INVALID_PARAMETER Configuration is NULL.\r
445 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this\r
446 driver.\r
447\r
448**/\r
449EFI_STATUS\r
450EFIAPI\r
451RouteConfig (\r
452 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r
453 IN CONST EFI_STRING Configuration,\r
454 OUT EFI_STRING *Progress\r
455 )\r
456{\r
457 EFI_STATUS Status;\r
458 UINTN BufferSize;\r
459 DRIVER_SAMPLE_PRIVATE_DATA *PrivateData;\r
460 EFI_HII_CONFIG_ROUTING_PROTOCOL *HiiConfigRouting;\r
461\r
462 if (Configuration == NULL) {\r
463 return EFI_INVALID_PARAMETER;\r
464 }\r
465\r
466 PrivateData = DRIVER_SAMPLE_PRIVATE_FROM_THIS (This);\r
467 HiiConfigRouting = PrivateData->HiiConfigRouting;\r
468\r
469 //\r
470 // Check routing data in <ConfigHdr>.\r
471 // Note: if only one Storage is used, then this checking could be skipped.\r
472 //\r
473 if (!HiiIsConfigHdrMatch (Configuration, &mFormSetGuid, VariableName)) {\r
474 *Progress = Configuration;\r
475 return EFI_NOT_FOUND;\r
476 }\r
477\r
478 //\r
479 // Get Buffer Storage data from EFI variable\r
480 //\r
481 BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r
482 Status = gRT->GetVariable (\r
483 VariableName,\r
484 &mFormSetGuid,\r
485 NULL,\r
486 &BufferSize,\r
487 &PrivateData->Configuration\r
488 );\r
489 if (EFI_ERROR (Status)) {\r
490 return Status;\r
491 }\r
492\r
493 //\r
494 // Convert <ConfigResp> to buffer data by helper function ConfigToBlock()\r
495 //\r
496 BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r
497 Status = HiiConfigRouting->ConfigToBlock (\r
498 HiiConfigRouting,\r
499 Configuration,\r
500 (UINT8 *) &PrivateData->Configuration,\r
501 &BufferSize,\r
502 Progress\r
503 );\r
504 if (EFI_ERROR (Status)) {\r
505 return Status;\r
506 }\r
507\r
508 //\r
509 // Store Buffer Storage back to EFI variable\r
510 //\r
511 Status = gRT->SetVariable(\r
512 VariableName,\r
513 &mFormSetGuid,\r
514 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
515 sizeof (DRIVER_SAMPLE_CONFIGURATION),\r
516 &PrivateData->Configuration\r
517 );\r
518\r
519 return Status;\r
520}\r
521\r
522\r
523/**\r
524 This function processes the results of changes in configuration.\r
525\r
526 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
527 @param Action Specifies the type of action taken by the browser.\r
528 @param QuestionId A unique value which is sent to the original\r
529 exporting driver so that it can identify the type\r
530 of data to expect.\r
531 @param Type The type of value for the question.\r
532 @param Value A pointer to the data being sent to the original\r
533 exporting driver.\r
534 @param ActionRequest On return, points to the action requested by the\r
535 callback function.\r
536\r
537 @retval EFI_SUCCESS The callback successfully handled the action.\r
538 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the\r
539 variable and its data.\r
540 @retval EFI_DEVICE_ERROR The variable could not be saved.\r
541 @retval EFI_UNSUPPORTED The specified Action is not supported by the\r
542 callback.\r
543\r
544**/\r
545EFI_STATUS\r
546EFIAPI\r
547DriverCallback (\r
548 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r
549 IN EFI_BROWSER_ACTION Action,\r
550 IN EFI_QUESTION_ID QuestionId,\r
551 IN UINT8 Type,\r
552 IN EFI_IFR_TYPE_VALUE *Value,\r
553 OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest\r
554 )\r
555{\r
556 DRIVER_SAMPLE_PRIVATE_DATA *PrivateData;\r
557 EFI_STATUS Status;\r
558 UINT8 MyVar;\r
559 VOID *StartOpCodeHandle;\r
560 VOID *OptionsOpCodeHandle;\r
561 EFI_IFR_GUID_LABEL *StartLabel;\r
562 VOID *EndOpCodeHandle;\r
563 EFI_IFR_GUID_LABEL *EndLabel;\r
564\r
565 if ((Value == NULL) || (ActionRequest == NULL)) {\r
566 return EFI_INVALID_PARAMETER;\r
567 }\r
568 \r
569 if ((Type == EFI_IFR_TYPE_STRING) && (Value->string == 0)) {\r
570 return EFI_INVALID_PARAMETER;\r
571 }\r
572 \r
573\r
574 Status = EFI_SUCCESS;\r
575 PrivateData = DRIVER_SAMPLE_PRIVATE_FROM_THIS (This);\r
576\r
577 switch (QuestionId) {\r
578 case 0x1234:\r
579 //\r
580 // Initialize the container for dynamic opcodes\r
581 //\r
582 StartOpCodeHandle = HiiAllocateOpCodeHandle ();\r
583 ASSERT (StartOpCodeHandle != NULL);\r
584\r
585 EndOpCodeHandle = HiiAllocateOpCodeHandle ();\r
586 ASSERT (EndOpCodeHandle != NULL);\r
587\r
588 //\r
589 // Create Hii Extend Label OpCode as the start opcode\r
590 //\r
591 StartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (StartOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));\r
592 StartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;\r
593 StartLabel->Number = LABEL_UPDATE1;\r
594\r
595 //\r
596 // Create Hii Extend Label OpCode as the end opcode\r
597 //\r
598 EndLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (EndOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));\r
599 EndLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;\r
600 EndLabel->Number = LABEL_END;\r
601\r
602 HiiCreateActionOpCode (\r
603 StartOpCodeHandle, // Container for dynamic created opcodes\r
604 0x1237, // Question ID\r
605 STRING_TOKEN(STR_EXIT_TEXT), // Prompt text\r
606 STRING_TOKEN(STR_EXIT_TEXT), // Help text\r
607 EFI_IFR_FLAG_CALLBACK, // Question flag\r
608 0 // Action String ID\r
609 );\r
610\r
611 //\r
612 // Create Option OpCode\r
613 //\r
614 OptionsOpCodeHandle = HiiAllocateOpCodeHandle ();\r
615 ASSERT (OptionsOpCodeHandle != NULL);\r
616\r
617 HiiCreateOneOfOptionOpCode (\r
618 OptionsOpCodeHandle,\r
619 STRING_TOKEN (STR_BOOT_OPTION1),\r
620 0,\r
621 EFI_IFR_NUMERIC_SIZE_1,\r
622 1\r
623 );\r
624\r
625 HiiCreateOneOfOptionOpCode (\r
626 OptionsOpCodeHandle,\r
627 STRING_TOKEN (STR_BOOT_OPTION2),\r
628 0,\r
629 EFI_IFR_NUMERIC_SIZE_1,\r
630 2\r
631 );\r
632\r
633 //\r
634 // Prepare initial value for the dynamic created oneof Question\r
635 //\r
636 PrivateData->Configuration.DynamicOneof = 2;\r
637 Status = gRT->SetVariable(\r
638 VariableName,\r
639 &mFormSetGuid,\r
640 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
641 sizeof (DRIVER_SAMPLE_CONFIGURATION),\r
642 &PrivateData->Configuration\r
643 );\r
644\r
645 HiiCreateOneOfOpCode (\r
646 StartOpCodeHandle, // Container for dynamic created opcodes\r
647 0x8001, // Question ID (or call it "key")\r
648 CONFIGURATION_VARSTORE_ID, // VarStore ID\r
649 (UINT16) DYNAMIC_ONE_OF_VAR_OFFSET, // Offset in Buffer Storage\r
650 STRING_TOKEN (STR_ONE_OF_PROMPT), // Question prompt text\r
651 STRING_TOKEN (STR_ONE_OF_HELP), // Question help text\r
652 EFI_IFR_FLAG_CALLBACK, // Question flag\r
653 EFI_IFR_NUMERIC_SIZE_1, // Data type of Question Value\r
654 OptionsOpCodeHandle, // Option Opcode list\r
655 NULL // Default Opcode is NULl\r
656 );\r
657\r
658 HiiCreateOrderedListOpCode (\r
659 StartOpCodeHandle, // Container for dynamic created opcodes\r
660 0x8002, // Question ID\r
661 CONFIGURATION_VARSTORE_ID, // VarStore ID\r
662 (UINT16) DYNAMIC_ORDERED_LIST_VAR_OFFSET, // Offset in Buffer Storage\r
663 STRING_TOKEN (STR_BOOT_OPTIONS), // Question prompt text\r
664 STRING_TOKEN (STR_BOOT_OPTIONS), // Question help text\r
665 EFI_IFR_FLAG_RESET_REQUIRED, // Question flag\r
666 0, // Ordered list flag, e.g. EFI_IFR_UNIQUE_SET\r
667 EFI_IFR_NUMERIC_SIZE_1, // Data type of Question value\r
668 5, // Maximum container\r
669 OptionsOpCodeHandle, // Option Opcode list\r
670 NULL // Default Opcode is NULl\r
671 );\r
672\r
673 HiiCreateGotoOpCode (\r
674 StartOpCodeHandle, // Container for dynamic created opcodes\r
675 1, // Target Form ID\r
676 STRING_TOKEN (STR_GOTO_FORM1), // Prompt text\r
677 STRING_TOKEN (STR_GOTO_HELP), // Help text\r
678 0, // Question flag\r
679 0x8003 // Question ID\r
680 );\r
681\r
682 HiiUpdateForm (\r
683 PrivateData->HiiHandle[0], // HII handle\r
684 &mFormSetGuid, // Formset GUID\r
685 0x1234, // Form ID\r
686 StartOpCodeHandle, // Label for where to insert opcodes\r
687 EndOpCodeHandle // Replace data\r
688 );\r
689\r
690 HiiFreeOpCodeHandle (StartOpCodeHandle);\r
691 HiiFreeOpCodeHandle (OptionsOpCodeHandle);\r
692 break;\r
693 \r
694 case 0x5678:\r
695 //\r
696 // We will reach here once the Question is refreshed\r
697 //\r
698\r
699 //\r
700 // Initialize the container for dynamic opcodes\r
701 //\r
702 StartOpCodeHandle = HiiAllocateOpCodeHandle ();\r
703 ASSERT (StartOpCodeHandle != NULL);\r
704\r
705 //\r
706 // Create Hii Extend Label OpCode as the start opcode\r
707 //\r
708 StartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (StartOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));\r
709 StartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;\r
710 StartLabel->Number = LABEL_UPDATE2;\r
711\r
712 HiiCreateActionOpCode (\r
713 StartOpCodeHandle, // Container for dynamic created opcodes\r
714 0x1237, // Question ID\r
715 STRING_TOKEN(STR_EXIT_TEXT), // Prompt text\r
716 STRING_TOKEN(STR_EXIT_TEXT), // Help text\r
717 EFI_IFR_FLAG_CALLBACK, // Question flag\r
718 0 // Action String ID\r
719 );\r
720 \r
721 HiiUpdateForm (\r
722 PrivateData->HiiHandle[0], // HII handle\r
723 &mFormSetGuid, // Formset GUID\r
724 0x3, // Form ID\r
725 StartOpCodeHandle, // Label for where to insert opcodes\r
726 NULL // Insert data\r
727 );\r
728\r
729 HiiFreeOpCodeHandle (StartOpCodeHandle); \r
730 \r
731 //\r
732 // Refresh the Question value\r
733 //\r
734 PrivateData->Configuration.DynamicRefresh++;\r
735 Status = gRT->SetVariable(\r
736 VariableName,\r
737 &mFormSetGuid,\r
738 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
739 sizeof (DRIVER_SAMPLE_CONFIGURATION),\r
740 &PrivateData->Configuration\r
741 );\r
742 \r
743 //\r
744 // Change an EFI Variable storage (MyEfiVar) asynchronous, this will cause\r
745 // the first statement in Form 3 be suppressed\r
746 //\r
747 MyVar = 111;\r
748 Status = gRT->SetVariable(\r
749 L"MyVar",\r
750 &mFormSetGuid,\r
751 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
752 1,\r
753 &MyVar\r
754 );\r
755 break;\r
756\r
757 case 0x1237:\r
758 //\r
759 // User press "Exit now", request Browser to exit\r
760 //\r
761 *ActionRequest = EFI_BROWSER_ACTION_REQUEST_EXIT;\r
762 break;\r
763\r
764 case 0x1238:\r
765 //\r
766 // User press "Save now", request Browser to save the uncommitted data.\r
767 //\r
768 *ActionRequest = EFI_BROWSER_ACTION_REQUEST_SUBMIT;\r
769 break;\r
770\r
771 case 0x2000:\r
772 //\r
773 // When try to set a new password, user will be chanlleged with old password.\r
774 // The Callback is responsible for validating old password input by user,\r
775 // If Callback return EFI_SUCCESS, it indicates validation pass.\r
776 //\r
777 switch (PrivateData->PasswordState) {\r
778 case BROWSER_STATE_VALIDATE_PASSWORD:\r
779 Status = ValidatePassword (PrivateData, Value->string);\r
780 if (Status == EFI_SUCCESS) {\r
781 PrivateData->PasswordState = BROWSER_STATE_SET_PASSWORD;\r
782 }\r
783 break;\r
784\r
785 case BROWSER_STATE_SET_PASSWORD:\r
786 Status = SetPassword (PrivateData, Value->string);\r
787 PrivateData->PasswordState = BROWSER_STATE_VALIDATE_PASSWORD;\r
788 break;\r
789\r
790 default:\r
791 break;\r
792 }\r
793\r
794 break;\r
795\r
796 default:\r
797 break;\r
798 }\r
799\r
800 return Status;\r
801}\r
802\r
803/**\r
804 Main entry for this driver.\r
805 \r
806 @param ImageHandle Image handle this driver.\r
807 @param SystemTable Pointer to SystemTable.\r
808\r
809 @retval EFI_SUCESS This function always complete successfully.\r
810\r
811**/\r
812EFI_STATUS\r
813EFIAPI\r
814DriverSampleInit (\r
815 IN EFI_HANDLE ImageHandle,\r
816 IN EFI_SYSTEM_TABLE *SystemTable\r
817 )\r
818{\r
819 EFI_STATUS Status;\r
820 EFI_HII_HANDLE HiiHandle[2];\r
821 EFI_SCREEN_DESCRIPTOR Screen;\r
822 EFI_HII_DATABASE_PROTOCOL *HiiDatabase;\r
823 EFI_HII_STRING_PROTOCOL *HiiString;\r
824 EFI_FORM_BROWSER2_PROTOCOL *FormBrowser2;\r
825 EFI_HII_CONFIG_ROUTING_PROTOCOL *HiiConfigRouting;\r
826 CHAR16 *NewString;\r
827 UINTN BufferSize;\r
828 DRIVER_SAMPLE_CONFIGURATION *Configuration;\r
829 BOOLEAN ActionFlag;\r
830 EFI_STRING ConfigRequestHdr; \r
831\r
832 //\r
833 // Initialize the local variables.\r
834 //\r
835 ConfigRequestHdr = NULL;\r
836\r
837 //\r
838 // Initialize screen dimensions for SendForm().\r
839 // Remove 3 characters from top and bottom\r
840 //\r
841 ZeroMem (&Screen, sizeof (EFI_SCREEN_DESCRIPTOR));\r
842 gST->ConOut->QueryMode (gST->ConOut, gST->ConOut->Mode->Mode, &Screen.RightColumn, &Screen.BottomRow);\r
843\r
844 Screen.TopRow = 3;\r
845 Screen.BottomRow = Screen.BottomRow - 3;\r
846\r
847 //\r
848 // Initialize driver private data\r
849 //\r
850 PrivateData = AllocatePool (sizeof (DRIVER_SAMPLE_PRIVATE_DATA));\r
851 if (PrivateData == NULL) {\r
852 return EFI_OUT_OF_RESOURCES;\r
853 }\r
854\r
855 PrivateData->Signature = DRIVER_SAMPLE_PRIVATE_SIGNATURE;\r
856\r
857 PrivateData->ConfigAccess.ExtractConfig = ExtractConfig;\r
858 PrivateData->ConfigAccess.RouteConfig = RouteConfig;\r
859 PrivateData->ConfigAccess.Callback = DriverCallback;\r
860 PrivateData->PasswordState = BROWSER_STATE_VALIDATE_PASSWORD;\r
861\r
862 //\r
863 // Locate Hii Database protocol\r
864 //\r
865 Status = gBS->LocateProtocol (&gEfiHiiDatabaseProtocolGuid, NULL, (VOID **) &HiiDatabase);\r
866 if (EFI_ERROR (Status)) {\r
867 return Status;\r
868 }\r
869 PrivateData->HiiDatabase = HiiDatabase;\r
870\r
871 //\r
872 // Locate HiiString protocol\r
873 //\r
874 Status = gBS->LocateProtocol (&gEfiHiiStringProtocolGuid, NULL, (VOID **) &HiiString);\r
875 if (EFI_ERROR (Status)) {\r
876 return Status;\r
877 }\r
878 PrivateData->HiiString = HiiString;\r
879\r
880 //\r
881 // Locate Formbrowser2 protocol\r
882 //\r
883 Status = gBS->LocateProtocol (&gEfiFormBrowser2ProtocolGuid, NULL, (VOID **) &FormBrowser2);\r
884 if (EFI_ERROR (Status)) {\r
885 return Status;\r
886 }\r
887 PrivateData->FormBrowser2 = FormBrowser2;\r
888\r
889 //\r
890 // Locate ConfigRouting protocol\r
891 //\r
892 Status = gBS->LocateProtocol (&gEfiHiiConfigRoutingProtocolGuid, NULL, (VOID **) &HiiConfigRouting);\r
893 if (EFI_ERROR (Status)) {\r
894 return Status;\r
895 }\r
896 PrivateData->HiiConfigRouting = HiiConfigRouting;\r
897\r
898 Status = gBS->InstallMultipleProtocolInterfaces (\r
899 &DriverHandle[0],\r
900 &gEfiDevicePathProtocolGuid,\r
901 &mHiiVendorDevicePath0,\r
902 &gEfiHiiConfigAccessProtocolGuid,\r
903 &PrivateData->ConfigAccess,\r
904 NULL\r
905 );\r
906 ASSERT_EFI_ERROR (Status);\r
907\r
908 PrivateData->DriverHandle[0] = DriverHandle[0];\r
909\r
910 //\r
911 // Publish our HII data\r
912 //\r
913 HiiHandle[0] = HiiAddPackages (\r
914 &mFormSetGuid,\r
915 DriverHandle[0],\r
916 DriverSampleStrings,\r
917 VfrBin,\r
918 NULL\r
919 );\r
920 if (HiiHandle[0] == NULL) {\r
921 return EFI_OUT_OF_RESOURCES;\r
922 }\r
923\r
924 PrivateData->HiiHandle[0] = HiiHandle[0];\r
925\r
926 //\r
927 // Publish another Fromset\r
928 //\r
929 Status = gBS->InstallMultipleProtocolInterfaces (\r
930 &DriverHandle[1],\r
931 &gEfiDevicePathProtocolGuid,\r
932 &mHiiVendorDevicePath1,\r
933 NULL\r
934 );\r
935 ASSERT_EFI_ERROR (Status);\r
936\r
937 PrivateData->DriverHandle[1] = DriverHandle[1];\r
938\r
939 HiiHandle[1] = HiiAddPackages (\r
940 &mInventoryGuid,\r
941 DriverHandle[1],\r
942 DriverSampleStrings,\r
943 InventoryBin,\r
944 NULL\r
945 );\r
946 if (HiiHandle[1] == NULL) {\r
947 return EFI_OUT_OF_RESOURCES;\r
948 }\r
949\r
950 PrivateData->HiiHandle[1] = HiiHandle[1];\r
951\r
952 //\r
953 // Very simple example of how one would update a string that is already\r
954 // in the HII database\r
955 //\r
956 NewString = L"700 Mhz";\r
957\r
958 if (HiiSetString (HiiHandle[0], STRING_TOKEN (STR_CPU_STRING2), NewString, NULL) == 0) {\r
959 return EFI_OUT_OF_RESOURCES;\r
960 }\r
961\r
962 //\r
963 // Initialize configuration data\r
964 //\r
965 Configuration = &PrivateData->Configuration;\r
966 ZeroMem (Configuration, sizeof (DRIVER_SAMPLE_CONFIGURATION));\r
967\r
968 //\r
969 // Try to read NV config EFI variable first\r
970 //\r
971 ConfigRequestHdr = HiiConstructConfigHdr (&mFormSetGuid, VariableName, DriverHandle[0]);\r
972 ASSERT (ConfigRequestHdr != NULL);\r
973\r
974 BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r
975 Status = gRT->GetVariable (VariableName, &mFormSetGuid, NULL, &BufferSize, Configuration);\r
976 if (EFI_ERROR (Status)) {\r
977 //\r
978 // Store zero data Buffer Storage to EFI variable\r
979 //\r
980 Status = gRT->SetVariable(\r
981 VariableName,\r
982 &mFormSetGuid,\r
983 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
984 sizeof (DRIVER_SAMPLE_CONFIGURATION),\r
985 Configuration\r
986 );\r
987 ASSERT (Status == EFI_SUCCESS);\r
988 //\r
989 // EFI variable for NV config doesn't exit, we should build this variable\r
990 // based on default values stored in IFR\r
991 //\r
992 ActionFlag = HiiSetToDefaults (ConfigRequestHdr, EFI_HII_DEFAULT_CLASS_STANDARD);\r
993 ASSERT (ActionFlag);\r
994 } else {\r
995 //\r
996 // EFI variable does exist and Validate Current Setting\r
997 //\r
998 ActionFlag = HiiValidateSettings (ConfigRequestHdr);\r
999 ASSERT (ActionFlag);\r
1000 }\r
1001 \r
1002 FreePool (ConfigRequestHdr);\r
1003\r
1004\r
1005 //\r
1006 // In default, this driver is built into Flash device image, \r
1007 // the following code doesn't run.\r
1008 //\r
1009\r
1010 //\r
1011 // Example of how to display only the item we sent to HII\r
1012 // When this driver is not built into Flash device image, \r
1013 // it need to call SendForm to show front page by itself.\r
1014 //\r
1015 if (DISPLAY_ONLY_MY_ITEM <= 1) {\r
1016 //\r
1017 // Have the browser pull out our copy of the data, and only display our data\r
1018 //\r
1019 Status = FormBrowser2->SendForm (\r
1020 FormBrowser2,\r
1021 &(HiiHandle[DISPLAY_ONLY_MY_ITEM]),\r
1022 1,\r
1023 NULL,\r
1024 0,\r
1025 NULL,\r
1026 NULL\r
1027 );\r
1028 \r
1029 HiiRemovePackages (HiiHandle[0]);\r
1030 \r
1031 HiiRemovePackages (HiiHandle[1]);\r
1032 }\r
1033\r
1034 return EFI_SUCCESS;\r
1035}\r
1036\r
1037/**\r
1038 Unloads the application and its installed protocol.\r
1039\r
1040 @param[in] ImageHandle Handle that identifies the image to be unloaded.\r
1041\r
1042 @retval EFI_SUCCESS The image has been unloaded.\r
1043**/\r
1044EFI_STATUS\r
1045EFIAPI\r
1046DriverSampleUnload (\r
1047 IN EFI_HANDLE ImageHandle\r
1048 )\r
1049{\r
1050 if (DriverHandle[0] != NULL) {\r
1051 gBS->UninstallMultipleProtocolInterfaces (\r
1052 DriverHandle[0],\r
1053 &gEfiDevicePathProtocolGuid,\r
1054 &mHiiVendorDevicePath0,\r
1055 &gEfiHiiConfigAccessProtocolGuid,\r
1056 &PrivateData->ConfigAccess,\r
1057 NULL\r
1058 );\r
1059 }\r
1060\r
1061 if (DriverHandle[1] != NULL) {\r
1062 gBS->UninstallMultipleProtocolInterfaces (\r
1063 DriverHandle[1],\r
1064 &gEfiDevicePathProtocolGuid,\r
1065 &mHiiVendorDevicePath1,\r
1066 NULL\r
1067 );\r
1068 }\r
1069\r
1070 if (PrivateData->HiiHandle[0] != NULL) {\r
1071 HiiRemovePackages (PrivateData->HiiHandle[0]);\r
1072 }\r
1073\r
1074 if (PrivateData->HiiHandle[1] != NULL) {\r
1075 HiiRemovePackages (PrivateData->HiiHandle[1]);\r
1076 }\r
1077\r
1078 if (PrivateData != NULL) {\r
1079 FreePool (PrivateData);\r
1080 }\r
1081\r
1082 return EFI_SUCCESS;\r
1083}\r
EFI Development Kit II mirror for PVE