]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Universal/DriverSampleDxe/DriverSample.c
9b664b4958c50912d98dfe3e2cd2d4f29caa0964
[mirror_edk2.git] / MdeModulePkg / Universal / DriverSampleDxe / DriverSample.c
1 /** @file
2 This is an example of how a driver might export data to the HII protocol to be
3 later utilized by the Setup Protocol
4
5 Copyright (c) 2004 - 2010, 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 "DriverSample.h"
18
19 #define DISPLAY_ONLY_MY_ITEM 0x0002
20
21 EFI_GUID mFormSetGuid = FORMSET_GUID;
22 EFI_GUID mInventoryGuid = INVENTORY_GUID;
23
24 CHAR16 VariableName[] = L"MyIfrNVData";
25 EFI_HANDLE DriverHandle[2] = {NULL, NULL};
26 DRIVER_SAMPLE_PRIVATE_DATA *PrivateData = NULL;
27
28 HII_VENDOR_DEVICE_PATH mHiiVendorDevicePath0 = {
29 {
30 {
31 HARDWARE_DEVICE_PATH,
32 HW_VENDOR_DP,
33 {
34 (UINT8) (sizeof (VENDOR_DEVICE_PATH)),
35 (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)
36 }
37 },
38 //
39 // {C153B68D-EBFC-488e-B110-662867745B87}
40 //
41 { 0xc153b68d, 0xebfc, 0x488e, { 0xb1, 0x10, 0x66, 0x28, 0x67, 0x74, 0x5b, 0x87 } }
42 },
43 {
44 END_DEVICE_PATH_TYPE,
45 END_ENTIRE_DEVICE_PATH_SUBTYPE,
46 {
47 (UINT8) (END_DEVICE_PATH_LENGTH),
48 (UINT8) ((END_DEVICE_PATH_LENGTH) >> 8)
49 }
50 }
51 };
52
53 HII_VENDOR_DEVICE_PATH mHiiVendorDevicePath1 = {
54 {
55 {
56 HARDWARE_DEVICE_PATH,
57 HW_VENDOR_DP,
58 {
59 (UINT8) (sizeof (VENDOR_DEVICE_PATH)),
60 (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)
61 }
62 },
63 //
64 // {06F37F07-0C48-40e9-8436-0A08A0BB76B0}
65 //
66 { 0x6f37f07, 0xc48, 0x40e9, { 0x84, 0x36, 0xa, 0x8, 0xa0, 0xbb, 0x76, 0xb0 } }
67 },
68 {
69 END_DEVICE_PATH_TYPE,
70 END_ENTIRE_DEVICE_PATH_SUBTYPE,
71 {
72 (UINT8) (END_DEVICE_PATH_LENGTH),
73 (UINT8) ((END_DEVICE_PATH_LENGTH) >> 8)
74 }
75 }
76 };
77
78 /**
79 Encode the password using a simple algorithm.
80
81 @param Password The string to be encoded.
82 @param MaxSize The size of the string.
83
84 **/
85 VOID
86 EncodePassword (
87 IN CHAR16 *Password,
88 IN UINTN MaxSize
89 )
90 {
91 UINTN Index;
92 UINTN Loop;
93 CHAR16 *Buffer;
94 CHAR16 *Key;
95
96 Key = L"MAR10648567";
97 Buffer = AllocateZeroPool (MaxSize);
98 ASSERT (Buffer != NULL);
99
100 for (Index = 0; Key[Index] != 0; Index++) {
101 for (Loop = 0; Loop < (UINT8) (MaxSize / 2); Loop++) {
102 Buffer[Loop] = (CHAR16) (Password[Loop] ^ Key[Index]);
103 }
104 }
105
106 CopyMem (Password, Buffer, MaxSize);
107
108 FreePool (Buffer);
109 return ;
110 }
111
112 /**
113 Validate the user's password.
114
115 @param PrivateData This driver's private context data.
116 @param StringId The user's input.
117
118 @retval EFI_SUCCESS The user's input matches the password.
119 @retval EFI_NOT_READY The user's input does not match the password.
120 **/
121 EFI_STATUS
122 ValidatePassword (
123 IN DRIVER_SAMPLE_PRIVATE_DATA *PrivateData,
124 IN EFI_STRING_ID StringId
125 )
126 {
127 EFI_STATUS Status;
128 UINTN Index;
129 UINTN BufferSize;
130 UINTN PasswordMaxSize;
131 CHAR16 *Password;
132 CHAR16 *EncodedPassword;
133 BOOLEAN OldPassword;
134
135 //
136 // Get encoded password first
137 //
138 BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);
139 Status = gRT->GetVariable (
140 VariableName,
141 &mFormSetGuid,
142 NULL,
143 &BufferSize,
144 &PrivateData->Configuration
145 );
146 if (EFI_ERROR (Status)) {
147 //
148 // Old password not exist, prompt for new password
149 //
150 return EFI_SUCCESS;
151 }
152
153 OldPassword = FALSE;
154 PasswordMaxSize = sizeof (PrivateData->Configuration.WhatIsThePassword2);
155 //
156 // Check whether we have any old password set
157 //
158 for (Index = 0; Index < PasswordMaxSize / sizeof (UINT16); Index++) {
159 if (PrivateData->Configuration.WhatIsThePassword2[Index] != 0) {
160 OldPassword = TRUE;
161 break;
162 }
163 }
164 if (!OldPassword) {
165 //
166 // Old password not exist, return EFI_SUCCESS to prompt for new password
167 //
168 return EFI_SUCCESS;
169 }
170
171 //
172 // Get user input password
173 //
174 Password = HiiGetString (PrivateData->HiiHandle[0], StringId, NULL);
175 if (Password == NULL) {
176 return EFI_NOT_READY;
177 }
178 if (StrSize (Password) > PasswordMaxSize) {
179 FreePool (Password);
180 return EFI_NOT_READY;
181 }
182
183 //
184 // Validate old password
185 //
186 EncodedPassword = AllocateZeroPool (PasswordMaxSize);
187 ASSERT (EncodedPassword != NULL);
188 StrnCpy (EncodedPassword, Password, StrLen (Password));
189 EncodePassword (EncodedPassword, StrLen (EncodedPassword) * sizeof (CHAR16));
190 if (CompareMem (EncodedPassword, PrivateData->Configuration.WhatIsThePassword2, PasswordMaxSize) != 0) {
191 //
192 // Old password mismatch, return EFI_NOT_READY to prompt for error message
193 //
194 Status = EFI_NOT_READY;
195 } else {
196 Status = EFI_SUCCESS;
197 }
198
199 FreePool (Password);
200 FreePool (EncodedPassword);
201
202 return Status;
203 }
204
205 /**
206 Encode the password using a simple algorithm.
207
208 @param PrivateData This driver's private context data.
209 @param StringId The password from User.
210
211 @retval EFI_SUCESS The operation is successful.
212 @return Other value if gRT->SetVariable () fails.
213
214 **/
215 EFI_STATUS
216 SetPassword (
217 IN DRIVER_SAMPLE_PRIVATE_DATA *PrivateData,
218 IN EFI_STRING_ID StringId
219 )
220 {
221 EFI_STATUS Status;
222 CHAR16 *Password;
223 CHAR16 *TempPassword;
224 UINTN PasswordSize;
225 DRIVER_SAMPLE_CONFIGURATION *Configuration;
226 UINTN BufferSize;
227
228 //
229 // Get Buffer Storage data from EFI variable
230 //
231 BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);
232 Status = gRT->GetVariable (
233 VariableName,
234 &mFormSetGuid,
235 NULL,
236 &BufferSize,
237 &PrivateData->Configuration
238 );
239 if (EFI_ERROR (Status)) {
240 return Status;
241 }
242
243 //
244 // Get user input password
245 //
246 Password = &PrivateData->Configuration.WhatIsThePassword2[0];
247 PasswordSize = sizeof (PrivateData->Configuration.WhatIsThePassword2);
248 ZeroMem (Password, PasswordSize);
249
250 TempPassword = HiiGetString (PrivateData->HiiHandle[0], StringId, NULL);
251 if (TempPassword == NULL) {
252 return EFI_NOT_READY;
253 }
254 if (StrSize (TempPassword) > PasswordSize) {
255 FreePool (TempPassword);
256 return EFI_NOT_READY;
257 }
258 StrnCpy (Password, TempPassword, StrLen (TempPassword));
259 FreePool (TempPassword);
260
261 //
262 // Retrive uncommitted data from Browser
263 //
264 Configuration = AllocateZeroPool (sizeof (DRIVER_SAMPLE_CONFIGURATION));
265 ASSERT (Configuration != NULL);
266 if (HiiGetBrowserData (&mFormSetGuid, VariableName, sizeof (DRIVER_SAMPLE_CONFIGURATION), (UINT8 *) Configuration)) {
267 //
268 // Update password's clear text in the screen
269 //
270 CopyMem (Configuration->PasswordClearText, Password, StrSize (Password));
271
272 //
273 // Update uncommitted data of Browser
274 //
275 HiiSetBrowserData (
276 &mFormSetGuid,
277 VariableName,
278 sizeof (DRIVER_SAMPLE_CONFIGURATION),
279 (UINT8 *) Configuration,
280 NULL
281 );
282 }
283
284 //
285 // Free Configuration Buffer
286 //
287 FreePool (Configuration);
288
289
290 //
291 // Set password
292 //
293 EncodePassword (Password, StrLen (Password) * 2);
294 Status = gRT->SetVariable(
295 VariableName,
296 &mFormSetGuid,
297 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,
298 sizeof (DRIVER_SAMPLE_CONFIGURATION),
299 &PrivateData->Configuration
300 );
301 return Status;
302 }
303
304 /**
305 Update names of Name/Value storage to current language.
306
307 @param PrivateData Points to the driver private data.
308
309 @retval EFI_SUCCESS All names are successfully updated.
310 @retval EFI_NOT_FOUND Failed to get Name from HII database.
311
312 **/
313 EFI_STATUS
314 LoadNameValueNames (
315 IN DRIVER_SAMPLE_PRIVATE_DATA *PrivateData
316 )
317 {
318 UINTN Index;
319
320 //
321 // Get Name/Value name string of current language
322 //
323 for (Index = 0; Index < NAME_VALUE_NAME_NUMBER; Index++) {
324 PrivateData->NameValueName[Index] = HiiGetString (
325 PrivateData->HiiHandle[0],
326 PrivateData->NameStringId[Index],
327 NULL
328 );
329 if (PrivateData->NameValueName[Index] == NULL) {
330 return EFI_NOT_FOUND;
331 }
332 }
333
334 return EFI_SUCCESS;
335 }
336
337 /**
338 This function allows a caller to extract the current configuration for one
339 or more named elements from the target driver.
340
341 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
342 @param Request A null-terminated Unicode string in
343 <ConfigRequest> format.
344 @param Progress On return, points to a character in the Request
345 string. Points to the string's null terminator if
346 request was successful. Points to the most recent
347 '&' before the first failing name/value pair (or
348 the beginning of the string if the failure is in
349 the first name/value pair) if the request was not
350 successful.
351 @param Results A null-terminated Unicode string in
352 <ConfigAltResp> format which has all values filled
353 in for the names in the Request string. String to
354 be allocated by the called function.
355
356 @retval EFI_SUCCESS The Results is filled with the requested values.
357 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.
358 @retval EFI_INVALID_PARAMETER Request is illegal syntax, or unknown name.
359 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this
360 driver.
361
362 **/
363 EFI_STATUS
364 EFIAPI
365 ExtractConfig (
366 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,
367 IN CONST EFI_STRING Request,
368 OUT EFI_STRING *Progress,
369 OUT EFI_STRING *Results
370 )
371 {
372 EFI_STATUS Status;
373 UINTN BufferSize;
374 DRIVER_SAMPLE_PRIVATE_DATA *PrivateData;
375 EFI_HII_CONFIG_ROUTING_PROTOCOL *HiiConfigRouting;
376 EFI_STRING ConfigRequest;
377 EFI_STRING ConfigRequestHdr;
378 UINTN Size;
379 EFI_STRING Value;
380 UINTN ValueStrLen;
381 CHAR16 BackupChar;
382 CHAR16 *StrPointer;
383 BOOLEAN AllocatedRequest;
384
385 if (Progress == NULL || Results == NULL) {
386 return EFI_INVALID_PARAMETER;
387 }
388 //
389 // Initialize the local variables.
390 //
391 ConfigRequestHdr = NULL;
392 ConfigRequest = NULL;
393 Size = 0;
394 *Progress = Request;
395 AllocatedRequest = FALSE;
396
397 PrivateData = DRIVER_SAMPLE_PRIVATE_FROM_THIS (This);
398 HiiConfigRouting = PrivateData->HiiConfigRouting;
399
400 //
401 // Get Buffer Storage data from EFI variable.
402 // Try to get the current setting from variable.
403 //
404 BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);
405 Status = gRT->GetVariable (
406 VariableName,
407 &mFormSetGuid,
408 NULL,
409 &BufferSize,
410 &PrivateData->Configuration
411 );
412 if (EFI_ERROR (Status)) {
413 return EFI_NOT_FOUND;
414 }
415
416 if (Request == NULL) {
417 //
418 // Request is set to NULL, construct full request string.
419 //
420
421 //
422 // Allocate and fill a buffer large enough to hold the <ConfigHdr> template
423 // followed by "&OFFSET=0&WIDTH=WWWWWWWWWWWWWWWW" followed by a Null-terminator
424 //
425 ConfigRequestHdr = HiiConstructConfigHdr (&mFormSetGuid, VariableName, PrivateData->DriverHandle[0]);
426 Size = (StrLen (ConfigRequestHdr) + 32 + 1) * sizeof (CHAR16);
427 ConfigRequest = AllocateZeroPool (Size);
428 ASSERT (ConfigRequest != NULL);
429 AllocatedRequest = TRUE;
430 UnicodeSPrint (ConfigRequest, Size, L"%s&OFFSET=0&WIDTH=%016LX", ConfigRequestHdr, (UINT64)BufferSize);
431 FreePool (ConfigRequestHdr);
432 } else {
433 //
434 // Check routing data in <ConfigHdr>.
435 // Note: if only one Storage is used, then this checking could be skipped.
436 //
437 if (!HiiIsConfigHdrMatch (Request, &mFormSetGuid, NULL)) {
438 return EFI_NOT_FOUND;
439 }
440 //
441 // Set Request to the unified request string.
442 //
443 ConfigRequest = Request;
444 //
445 // Check whether Request includes Request Element.
446 //
447 if (StrStr (Request, L"OFFSET") == NULL) {
448 //
449 // Check Request Element does exist in Reques String
450 //
451 StrPointer = StrStr (Request, L"PATH");
452 if (StrPointer == NULL) {
453 return EFI_INVALID_PARAMETER;
454 }
455 if (StrStr (StrPointer, L"&") == NULL) {
456 Size = (StrLen (Request) + 32 + 1) * sizeof (CHAR16);
457 ConfigRequest = AllocateZeroPool (Size);
458 ASSERT (ConfigRequest != NULL);
459 AllocatedRequest = TRUE;
460 UnicodeSPrint (ConfigRequest, Size, L"%s&OFFSET=0&WIDTH=%016LX", Request, (UINT64)BufferSize);
461 }
462 }
463 }
464
465 //
466 // Check if requesting Name/Value storage
467 //
468 if (StrStr (ConfigRequest, L"OFFSET") == NULL) {
469 //
470 // Update Name/Value storage Names
471 //
472 Status = LoadNameValueNames (PrivateData);
473 if (EFI_ERROR (Status)) {
474 return Status;
475 }
476
477 //
478 // Allocate memory for <ConfigResp>, e.g. Name0=0x11, Name1=0x1234, Name2="ABCD"
479 // <Request> ::=<ConfigHdr>&Name0&Name1&Name2
480 // <ConfigResp>::=<ConfigHdr>&Name0=11&Name1=1234&Name2=0041004200430044
481 //
482 BufferSize = (StrLen (ConfigRequest) +
483 1 + sizeof (PrivateData->Configuration.NameValueVar0) * 2 +
484 1 + sizeof (PrivateData->Configuration.NameValueVar1) * 2 +
485 1 + sizeof (PrivateData->Configuration.NameValueVar2) * 2 + 1) * sizeof (CHAR16);
486 *Results = AllocateZeroPool (BufferSize);
487 ASSERT (*Results != NULL);
488 StrCpy (*Results, ConfigRequest);
489 Value = *Results;
490
491 //
492 // Append value of NameValueVar0, type is UINT8
493 //
494 if ((Value = StrStr (*Results, PrivateData->NameValueName[0])) != NULL) {
495 Value += StrLen (PrivateData->NameValueName[0]);
496 ValueStrLen = ((sizeof (PrivateData->Configuration.NameValueVar0) * 2) + 1);
497 CopyMem (Value + ValueStrLen, Value, StrSize (Value));
498
499 BackupChar = Value[ValueStrLen];
500 *Value++ = L'=';
501 Value += UnicodeValueToString (
502 Value,
503 PREFIX_ZERO | RADIX_HEX,
504 PrivateData->Configuration.NameValueVar0,
505 sizeof (PrivateData->Configuration.NameValueVar0) * 2
506 );
507 *Value = BackupChar;
508 }
509
510 //
511 // Append value of NameValueVar1, type is UINT16
512 //
513 if ((Value = StrStr (*Results, PrivateData->NameValueName[1])) != NULL) {
514 Value += StrLen (PrivateData->NameValueName[1]);
515 ValueStrLen = ((sizeof (PrivateData->Configuration.NameValueVar1) * 2) + 1);
516 CopyMem (Value + ValueStrLen, Value, StrSize (Value));
517
518 BackupChar = Value[ValueStrLen];
519 *Value++ = L'=';
520 Value += UnicodeValueToString (
521 Value,
522 PREFIX_ZERO | RADIX_HEX,
523 PrivateData->Configuration.NameValueVar1,
524 sizeof (PrivateData->Configuration.NameValueVar1) * 2
525 );
526 *Value = BackupChar;
527 }
528
529 //
530 // Append value of NameValueVar2, type is CHAR16 *
531 //
532 if ((Value = StrStr (*Results, PrivateData->NameValueName[2])) != NULL) {
533 Value += StrLen (PrivateData->NameValueName[2]);
534 ValueStrLen = StrLen (PrivateData->Configuration.NameValueVar2) * 4 + 1;
535 CopyMem (Value + ValueStrLen, Value, StrSize (Value));
536
537 *Value++ = L'=';
538 //
539 // Convert Unicode String to Config String, e.g. "ABCD" => "0041004200430044"
540 //
541 StrPointer = (CHAR16 *) PrivateData->Configuration.NameValueVar2;
542 for (; *StrPointer != L'\0'; StrPointer++) {
543 Value += UnicodeValueToString (Value, PREFIX_ZERO | RADIX_HEX, *StrPointer, 4);
544 }
545 }
546
547 Status = EFI_SUCCESS;
548 } else {
549 //
550 // Convert buffer data to <ConfigResp> by helper function BlockToConfig()
551 //
552 Status = HiiConfigRouting->BlockToConfig (
553 HiiConfigRouting,
554 ConfigRequest,
555 (UINT8 *) &PrivateData->Configuration,
556 BufferSize,
557 Results,
558 Progress
559 );
560 }
561
562 //
563 // Free the allocated config request string.
564 //
565 if (AllocatedRequest) {
566 FreePool (ConfigRequest);
567 }
568 //
569 // Set Progress string to the original request string.
570 //
571 if (Request == NULL) {
572 *Progress = NULL;
573 } else if (StrStr (Request, L"OFFSET") == NULL) {
574 *Progress = Request + StrLen (Request);
575 }
576
577 return Status;
578 }
579
580
581 /**
582 This function processes the results of changes in configuration.
583
584 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
585 @param Configuration A null-terminated Unicode string in <ConfigResp>
586 format.
587 @param Progress A pointer to a string filled in with the offset of
588 the most recent '&' before the first failing
589 name/value pair (or the beginning of the string if
590 the failure is in the first name/value pair) or
591 the terminating NULL if all was successful.
592
593 @retval EFI_SUCCESS The Results is processed successfully.
594 @retval EFI_INVALID_PARAMETER Configuration is NULL.
595 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this
596 driver.
597
598 **/
599 EFI_STATUS
600 EFIAPI
601 RouteConfig (
602 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,
603 IN CONST EFI_STRING Configuration,
604 OUT EFI_STRING *Progress
605 )
606 {
607 EFI_STATUS Status;
608 UINTN BufferSize;
609 DRIVER_SAMPLE_PRIVATE_DATA *PrivateData;
610 EFI_HII_CONFIG_ROUTING_PROTOCOL *HiiConfigRouting;
611 CHAR16 *Value;
612 CHAR16 *StrPtr;
613 CHAR16 TemStr[5];
614 UINT8 *DataBuffer;
615 UINT8 DigitUint8;
616 UINTN Index;
617 CHAR16 *StrBuffer;
618
619 if (Configuration == NULL || Progress == NULL) {
620 return EFI_INVALID_PARAMETER;
621 }
622
623 PrivateData = DRIVER_SAMPLE_PRIVATE_FROM_THIS (This);
624 HiiConfigRouting = PrivateData->HiiConfigRouting;
625 *Progress = Configuration;
626
627 //
628 // Check routing data in <ConfigHdr>.
629 // Note: if only one Storage is used, then this checking could be skipped.
630 //
631 if (!HiiIsConfigHdrMatch (Configuration, &mFormSetGuid, NULL)) {
632 return EFI_NOT_FOUND;
633 }
634
635 //
636 // Get Buffer Storage data from EFI variable
637 //
638 BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);
639 Status = gRT->GetVariable (
640 VariableName,
641 &mFormSetGuid,
642 NULL,
643 &BufferSize,
644 &PrivateData->Configuration
645 );
646 if (EFI_ERROR (Status)) {
647 return Status;
648 }
649
650 //
651 // Check if configuring Name/Value storage
652 //
653 if (StrStr (Configuration, L"OFFSET") == NULL) {
654 //
655 // Update Name/Value storage Names
656 //
657 Status = LoadNameValueNames (PrivateData);
658 if (EFI_ERROR (Status)) {
659 return Status;
660 }
661
662 //
663 // Convert value for NameValueVar0
664 //
665 if ((Value = StrStr (Configuration, PrivateData->NameValueName[0])) != NULL) {
666 //
667 // Skip "Name="
668 //
669 Value += StrLen (PrivateData->NameValueName[0]);
670 Value++;
671 //
672 // Get Value String
673 //
674 StrPtr = StrStr (Value, L"&");
675 if (StrPtr == NULL) {
676 StrPtr = Value + StrLen (Value);
677 }
678 //
679 // Convert Value to Buffer data
680 //
681 DataBuffer = (UINT8 *) &PrivateData->Configuration.NameValueVar0;
682 ZeroMem (TemStr, sizeof (TemStr));
683 for (Index = 0, StrPtr --; StrPtr >= Value; StrPtr --, Index ++) {
684 TemStr[0] = *StrPtr;
685 DigitUint8 = (UINT8) StrHexToUint64 (TemStr);
686 if ((Index & 1) == 0) {
687 DataBuffer [Index/2] = DigitUint8;
688 } else {
689 DataBuffer [Index/2] = (UINT8) ((UINT8) (DigitUint8 << 4) + DataBuffer [Index/2]);
690 }
691 }
692 }
693
694 //
695 // Convert value for NameValueVar1
696 //
697 if ((Value = StrStr (Configuration, PrivateData->NameValueName[1])) != NULL) {
698 //
699 // Skip "Name="
700 //
701 Value += StrLen (PrivateData->NameValueName[1]);
702 Value++;
703 //
704 // Get Value String
705 //
706 StrPtr = StrStr (Value, L"&");
707 if (StrPtr == NULL) {
708 StrPtr = Value + StrLen (Value);
709 }
710 //
711 // Convert Value to Buffer data
712 //
713 DataBuffer = (UINT8 *) &PrivateData->Configuration.NameValueVar1;
714 ZeroMem (TemStr, sizeof (TemStr));
715 for (Index = 0, StrPtr --; StrPtr >= Value; StrPtr --, Index ++) {
716 TemStr[0] = *StrPtr;
717 DigitUint8 = (UINT8) StrHexToUint64 (TemStr);
718 if ((Index & 1) == 0) {
719 DataBuffer [Index/2] = DigitUint8;
720 } else {
721 DataBuffer [Index/2] = (UINT8) ((UINT8) (DigitUint8 << 4) + DataBuffer [Index/2]);
722 }
723 }
724 }
725
726 //
727 // Convert value for NameValueVar2
728 //
729 if ((Value = StrStr (Configuration, PrivateData->NameValueName[2])) != NULL) {
730 //
731 // Skip "Name="
732 //
733 Value += StrLen (PrivateData->NameValueName[2]);
734 Value++;
735 //
736 // Get Value String
737 //
738 StrPtr = StrStr (Value, L"&");
739 if (StrPtr == NULL) {
740 StrPtr = Value + StrLen (Value);
741 }
742 //
743 // Convert Config String to Unicode String, e.g "0041004200430044" => "ABCD"
744 //
745 StrBuffer = (CHAR16 *) PrivateData->Configuration.NameValueVar2;
746 ZeroMem (TemStr, sizeof (TemStr));
747 while (Value < StrPtr) {
748 StrnCpy (TemStr, Value, 4);
749 *(StrBuffer++) = (CHAR16) StrHexToUint64 (TemStr);
750 Value += 4;
751 }
752 *StrBuffer = L'\0';
753 }
754
755 //
756 // Store Buffer Storage back to EFI variable
757 //
758 Status = gRT->SetVariable(
759 VariableName,
760 &mFormSetGuid,
761 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,
762 sizeof (DRIVER_SAMPLE_CONFIGURATION),
763 &PrivateData->Configuration
764 );
765
766 return Status;
767 }
768
769 //
770 // Convert <ConfigResp> to buffer data by helper function ConfigToBlock()
771 //
772 BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);
773 Status = HiiConfigRouting->ConfigToBlock (
774 HiiConfigRouting,
775 Configuration,
776 (UINT8 *) &PrivateData->Configuration,
777 &BufferSize,
778 Progress
779 );
780 if (EFI_ERROR (Status)) {
781 return Status;
782 }
783
784 //
785 // Store Buffer Storage back to EFI variable
786 //
787 Status = gRT->SetVariable(
788 VariableName,
789 &mFormSetGuid,
790 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,
791 sizeof (DRIVER_SAMPLE_CONFIGURATION),
792 &PrivateData->Configuration
793 );
794
795 return Status;
796 }
797
798
799 /**
800 This function processes the results of changes in configuration.
801
802 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
803 @param Action Specifies the type of action taken by the browser.
804 @param QuestionId A unique value which is sent to the original
805 exporting driver so that it can identify the type
806 of data to expect.
807 @param Type The type of value for the question.
808 @param Value A pointer to the data being sent to the original
809 exporting driver.
810 @param ActionRequest On return, points to the action requested by the
811 callback function.
812
813 @retval EFI_SUCCESS The callback successfully handled the action.
814 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the
815 variable and its data.
816 @retval EFI_DEVICE_ERROR The variable could not be saved.
817 @retval EFI_UNSUPPORTED The specified Action is not supported by the
818 callback.
819
820 **/
821 EFI_STATUS
822 EFIAPI
823 DriverCallback (
824 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,
825 IN EFI_BROWSER_ACTION Action,
826 IN EFI_QUESTION_ID QuestionId,
827 IN UINT8 Type,
828 IN EFI_IFR_TYPE_VALUE *Value,
829 OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest
830 )
831 {
832 DRIVER_SAMPLE_PRIVATE_DATA *PrivateData;
833 EFI_STATUS Status;
834 UINT8 MyVar;
835 VOID *StartOpCodeHandle;
836 VOID *OptionsOpCodeHandle;
837 EFI_IFR_GUID_LABEL *StartLabel;
838 VOID *EndOpCodeHandle;
839 EFI_IFR_GUID_LABEL *EndLabel;
840 EFI_INPUT_KEY Key;
841 DRIVER_SAMPLE_CONFIGURATION *Configuration;
842 UINTN MyVarSize;
843
844 if (Action == EFI_BROWSER_ACTION_FORM_OPEN) {
845 if (QuestionId == 0x1234) {
846 //
847 // Sample CallBack for UEFI FORM_OPEN action:
848 // Add Save action into Form 3 when Form 1 is opened.
849 // This will be done only in FORM_OPEN CallBack of question with ID 0x1234 from Form 1.
850 //
851 PrivateData = DRIVER_SAMPLE_PRIVATE_FROM_THIS (This);
852
853 //
854 // Initialize the container for dynamic opcodes
855 //
856 StartOpCodeHandle = HiiAllocateOpCodeHandle ();
857 ASSERT (StartOpCodeHandle != NULL);
858
859 //
860 // Create Hii Extend Label OpCode as the start opcode
861 //
862 StartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (StartOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));
863 StartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
864 StartLabel->Number = LABEL_UPDATE2;
865
866 HiiCreateActionOpCode (
867 StartOpCodeHandle, // Container for dynamic created opcodes
868 0x1238, // Question ID
869 STRING_TOKEN(STR_SAVE_TEXT), // Prompt text
870 STRING_TOKEN(STR_SAVE_TEXT), // Help text
871 EFI_IFR_FLAG_CALLBACK, // Question flag
872 0 // Action String ID
873 );
874
875 HiiUpdateForm (
876 PrivateData->HiiHandle[0], // HII handle
877 &mFormSetGuid, // Formset GUID
878 0x3, // Form ID
879 StartOpCodeHandle, // Label for where to insert opcodes
880 NULL // Insert data
881 );
882
883 HiiFreeOpCodeHandle (StartOpCodeHandle);
884 }
885 return EFI_SUCCESS;
886 }
887
888 if (Action == EFI_BROWSER_ACTION_FORM_CLOSE) {
889 if (QuestionId == 0x5678) {
890 //
891 // Sample CallBack for UEFI FORM_CLOSE action:
892 // Show up a pop-up to specify Form 3 will be closed when exit Form 3.
893 //
894 do {
895 CreatePopUp (
896 EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE,
897 &Key,
898 L"",
899 L"You are going to leave third Form!",
900 L"Press ESC or ENTER to continue ...",
901 L"",
902 NULL
903 );
904 } while ((Key.ScanCode != SCAN_ESC) && (Key.UnicodeChar != CHAR_CARRIAGE_RETURN));
905 }
906 return EFI_SUCCESS;
907 }
908
909 if ((Value == NULL) || (ActionRequest == NULL)) {
910 return EFI_INVALID_PARAMETER;
911 }
912
913
914 Status = EFI_SUCCESS;
915 PrivateData = DRIVER_SAMPLE_PRIVATE_FROM_THIS (This);
916
917 switch (QuestionId) {
918 case 0x1234:
919 //
920 // Initialize the container for dynamic opcodes
921 //
922 StartOpCodeHandle = HiiAllocateOpCodeHandle ();
923 ASSERT (StartOpCodeHandle != NULL);
924
925 EndOpCodeHandle = HiiAllocateOpCodeHandle ();
926 ASSERT (EndOpCodeHandle != NULL);
927
928 //
929 // Create Hii Extend Label OpCode as the start opcode
930 //
931 StartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (StartOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));
932 StartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
933 StartLabel->Number = LABEL_UPDATE1;
934
935 //
936 // Create Hii Extend Label OpCode as the end opcode
937 //
938 EndLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (EndOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));
939 EndLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
940 EndLabel->Number = LABEL_END;
941
942 HiiCreateActionOpCode (
943 StartOpCodeHandle, // Container for dynamic created opcodes
944 0x1237, // Question ID
945 STRING_TOKEN(STR_EXIT_TEXT), // Prompt text
946 STRING_TOKEN(STR_EXIT_TEXT), // Help text
947 EFI_IFR_FLAG_CALLBACK, // Question flag
948 0 // Action String ID
949 );
950
951 //
952 // Create Option OpCode
953 //
954 OptionsOpCodeHandle = HiiAllocateOpCodeHandle ();
955 ASSERT (OptionsOpCodeHandle != NULL);
956
957 HiiCreateOneOfOptionOpCode (
958 OptionsOpCodeHandle,
959 STRING_TOKEN (STR_BOOT_OPTION1),
960 0,
961 EFI_IFR_NUMERIC_SIZE_1,
962 1
963 );
964
965 HiiCreateOneOfOptionOpCode (
966 OptionsOpCodeHandle,
967 STRING_TOKEN (STR_BOOT_OPTION2),
968 0,
969 EFI_IFR_NUMERIC_SIZE_1,
970 2
971 );
972
973 //
974 // Prepare initial value for the dynamic created oneof Question
975 //
976 PrivateData->Configuration.DynamicOneof = 2;
977 Status = gRT->SetVariable(
978 VariableName,
979 &mFormSetGuid,
980 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,
981 sizeof (DRIVER_SAMPLE_CONFIGURATION),
982 &PrivateData->Configuration
983 );
984
985 //
986 // Set initial vlaue of dynamic created oneof Question in Form Browser
987 //
988 Configuration = AllocateZeroPool (sizeof (DRIVER_SAMPLE_CONFIGURATION));
989 ASSERT (Configuration != NULL);
990 if (HiiGetBrowserData (&mFormSetGuid, VariableName, sizeof (DRIVER_SAMPLE_CONFIGURATION), (UINT8 *) Configuration)) {
991 Configuration->DynamicOneof = 2;
992
993 //
994 // Update uncommitted data of Browser
995 //
996 HiiSetBrowserData (
997 &mFormSetGuid,
998 VariableName,
999 sizeof (DRIVER_SAMPLE_CONFIGURATION),
1000 (UINT8 *) Configuration,
1001 NULL
1002 );
1003 }
1004 FreePool (Configuration);
1005
1006 HiiCreateOneOfOpCode (
1007 StartOpCodeHandle, // Container for dynamic created opcodes
1008 0x8001, // Question ID (or call it "key")
1009 CONFIGURATION_VARSTORE_ID, // VarStore ID
1010 (UINT16) DYNAMIC_ONE_OF_VAR_OFFSET, // Offset in Buffer Storage
1011 STRING_TOKEN (STR_ONE_OF_PROMPT), // Question prompt text
1012 STRING_TOKEN (STR_ONE_OF_HELP), // Question help text
1013 EFI_IFR_FLAG_CALLBACK, // Question flag
1014 EFI_IFR_NUMERIC_SIZE_1, // Data type of Question Value
1015 OptionsOpCodeHandle, // Option Opcode list
1016 NULL // Default Opcode is NULl
1017 );
1018
1019 HiiCreateOrderedListOpCode (
1020 StartOpCodeHandle, // Container for dynamic created opcodes
1021 0x8002, // Question ID
1022 CONFIGURATION_VARSTORE_ID, // VarStore ID
1023 (UINT16) DYNAMIC_ORDERED_LIST_VAR_OFFSET, // Offset in Buffer Storage
1024 STRING_TOKEN (STR_BOOT_OPTIONS), // Question prompt text
1025 STRING_TOKEN (STR_BOOT_OPTIONS), // Question help text
1026 EFI_IFR_FLAG_RESET_REQUIRED, // Question flag
1027 0, // Ordered list flag, e.g. EFI_IFR_UNIQUE_SET
1028 EFI_IFR_NUMERIC_SIZE_1, // Data type of Question value
1029 5, // Maximum container
1030 OptionsOpCodeHandle, // Option Opcode list
1031 NULL // Default Opcode is NULl
1032 );
1033
1034 HiiCreateTextOpCode (
1035 StartOpCodeHandle,
1036 STRING_TOKEN(STR_TEXT_SAMPLE_HELP),
1037 STRING_TOKEN(STR_TEXT_SAMPLE_HELP),
1038 STRING_TOKEN(STR_TEXT_SAMPLE_STRING)
1039 );
1040
1041 HiiCreateDateOpCode (
1042 StartOpCodeHandle,
1043 0x8004,
1044 0x0,
1045 0x0,
1046 STRING_TOKEN(STR_DATE_SAMPLE_HELP),
1047 STRING_TOKEN(STR_DATE_SAMPLE_HELP),
1048 0,
1049 QF_DATE_STORAGE_TIME,
1050 NULL
1051 );
1052
1053 HiiCreateTimeOpCode (
1054 StartOpCodeHandle,
1055 0x8005,
1056 0x0,
1057 0x0,
1058 STRING_TOKEN(STR_TIME_SAMPLE_HELP),
1059 STRING_TOKEN(STR_TIME_SAMPLE_HELP),
1060 0,
1061 QF_TIME_STORAGE_TIME,
1062 NULL
1063 );
1064
1065 HiiCreateGotoOpCode (
1066 StartOpCodeHandle, // Container for dynamic created opcodes
1067 1, // Target Form ID
1068 STRING_TOKEN (STR_GOTO_FORM1), // Prompt text
1069 STRING_TOKEN (STR_GOTO_HELP), // Help text
1070 0, // Question flag
1071 0x8003 // Question ID
1072 );
1073
1074 HiiUpdateForm (
1075 PrivateData->HiiHandle[0], // HII handle
1076 &mFormSetGuid, // Formset GUID
1077 0x1234, // Form ID
1078 StartOpCodeHandle, // Label for where to insert opcodes
1079 EndOpCodeHandle // Replace data
1080 );
1081
1082 HiiFreeOpCodeHandle (StartOpCodeHandle);
1083 HiiFreeOpCodeHandle (OptionsOpCodeHandle);
1084 HiiFreeOpCodeHandle (EndOpCodeHandle);
1085 break;
1086
1087 case 0x5678:
1088 //
1089 // We will reach here once the Question is refreshed
1090 //
1091
1092 //
1093 // Initialize the container for dynamic opcodes
1094 //
1095 StartOpCodeHandle = HiiAllocateOpCodeHandle ();
1096 ASSERT (StartOpCodeHandle != NULL);
1097
1098 //
1099 // Create Hii Extend Label OpCode as the start opcode
1100 //
1101 StartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (StartOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));
1102 StartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
1103 StartLabel->Number = LABEL_UPDATE2;
1104
1105 HiiCreateActionOpCode (
1106 StartOpCodeHandle, // Container for dynamic created opcodes
1107 0x1237, // Question ID
1108 STRING_TOKEN(STR_EXIT_TEXT), // Prompt text
1109 STRING_TOKEN(STR_EXIT_TEXT), // Help text
1110 EFI_IFR_FLAG_CALLBACK, // Question flag
1111 0 // Action String ID
1112 );
1113
1114 HiiUpdateForm (
1115 PrivateData->HiiHandle[0], // HII handle
1116 &mFormSetGuid, // Formset GUID
1117 0x3, // Form ID
1118 StartOpCodeHandle, // Label for where to insert opcodes
1119 NULL // Insert data
1120 );
1121
1122 HiiFreeOpCodeHandle (StartOpCodeHandle);
1123
1124 //
1125 // Refresh the Question value
1126 //
1127 PrivateData->Configuration.DynamicRefresh++;
1128 Status = gRT->SetVariable(
1129 VariableName,
1130 &mFormSetGuid,
1131 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,
1132 sizeof (DRIVER_SAMPLE_CONFIGURATION),
1133 &PrivateData->Configuration
1134 );
1135
1136 //
1137 // Change an EFI Variable storage (MyEfiVar) asynchronous, this will cause
1138 // the first statement in Form 3 be suppressed
1139 //
1140 MyVarSize = 1;
1141 MyVar = 111;
1142 Status = gRT->SetVariable(
1143 L"MyVar",
1144 &mFormSetGuid,
1145 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,
1146 MyVarSize,
1147 &MyVar
1148 );
1149 break;
1150
1151 case 0x1237:
1152 //
1153 // User press "Exit now", request Browser to exit
1154 //
1155 *ActionRequest = EFI_BROWSER_ACTION_REQUEST_EXIT;
1156 break;
1157
1158 case 0x1238:
1159 //
1160 // User press "Save now", request Browser to save the uncommitted data.
1161 //
1162 *ActionRequest = EFI_BROWSER_ACTION_REQUEST_SUBMIT;
1163 break;
1164
1165 case 0x2000:
1166 //
1167 // Only used to update the state.
1168 //
1169 if ((Type == EFI_IFR_TYPE_STRING) && (Value->string == 0) &&
1170 (PrivateData->PasswordState == BROWSER_STATE_SET_PASSWORD)) {
1171 PrivateData->PasswordState = BROWSER_STATE_VALIDATE_PASSWORD;
1172 return EFI_INVALID_PARAMETER;
1173 }
1174
1175 //
1176 // When try to set a new password, user will be chanlleged with old password.
1177 // The Callback is responsible for validating old password input by user,
1178 // If Callback return EFI_SUCCESS, it indicates validation pass.
1179 //
1180 switch (PrivateData->PasswordState) {
1181 case BROWSER_STATE_VALIDATE_PASSWORD:
1182 Status = ValidatePassword (PrivateData, Value->string);
1183 if (Status == EFI_SUCCESS) {
1184 PrivateData->PasswordState = BROWSER_STATE_SET_PASSWORD;
1185 }
1186 break;
1187
1188 case BROWSER_STATE_SET_PASSWORD:
1189 Status = SetPassword (PrivateData, Value->string);
1190 PrivateData->PasswordState = BROWSER_STATE_VALIDATE_PASSWORD;
1191 break;
1192
1193 default:
1194 break;
1195 }
1196
1197 break;
1198
1199 case 0x1111:
1200 //
1201 // EfiVarstore question takes sample action (print value as debug information)
1202 // after read/write question.
1203 //
1204 MyVarSize = 1;
1205 Status = gRT->GetVariable(
1206 L"MyVar",
1207 &mFormSetGuid,
1208 NULL,
1209 &MyVarSize,
1210 &MyVar
1211 );
1212 ASSERT_EFI_ERROR (Status);
1213 DEBUG ((DEBUG_INFO, "EfiVarstore question: Tall value is %d with value width %d\n", MyVar, MyVarSize));
1214 default:
1215 break;
1216 }
1217
1218 return Status;
1219 }
1220
1221 /**
1222 Main entry for this driver.
1223
1224 @param ImageHandle Image handle this driver.
1225 @param SystemTable Pointer to SystemTable.
1226
1227 @retval EFI_SUCESS This function always complete successfully.
1228
1229 **/
1230 EFI_STATUS
1231 EFIAPI
1232 DriverSampleInit (
1233 IN EFI_HANDLE ImageHandle,
1234 IN EFI_SYSTEM_TABLE *SystemTable
1235 )
1236 {
1237 EFI_STATUS Status;
1238 EFI_HII_HANDLE HiiHandle[2];
1239 EFI_SCREEN_DESCRIPTOR Screen;
1240 EFI_HII_DATABASE_PROTOCOL *HiiDatabase;
1241 EFI_HII_STRING_PROTOCOL *HiiString;
1242 EFI_FORM_BROWSER2_PROTOCOL *FormBrowser2;
1243 EFI_HII_CONFIG_ROUTING_PROTOCOL *HiiConfigRouting;
1244 CHAR16 *NewString;
1245 UINTN BufferSize;
1246 DRIVER_SAMPLE_CONFIGURATION *Configuration;
1247 BOOLEAN ActionFlag;
1248 EFI_STRING ConfigRequestHdr;
1249
1250 //
1251 // Initialize the local variables.
1252 //
1253 ConfigRequestHdr = NULL;
1254 //
1255 // Initialize screen dimensions for SendForm().
1256 // Remove 3 characters from top and bottom
1257 //
1258 ZeroMem (&Screen, sizeof (EFI_SCREEN_DESCRIPTOR));
1259 gST->ConOut->QueryMode (gST->ConOut, gST->ConOut->Mode->Mode, &Screen.RightColumn, &Screen.BottomRow);
1260
1261 Screen.TopRow = 3;
1262 Screen.BottomRow = Screen.BottomRow - 3;
1263
1264 //
1265 // Initialize driver private data
1266 //
1267 PrivateData = AllocateZeroPool (sizeof (DRIVER_SAMPLE_PRIVATE_DATA));
1268 if (PrivateData == NULL) {
1269 return EFI_OUT_OF_RESOURCES;
1270 }
1271
1272 PrivateData->Signature = DRIVER_SAMPLE_PRIVATE_SIGNATURE;
1273
1274 PrivateData->ConfigAccess.ExtractConfig = ExtractConfig;
1275 PrivateData->ConfigAccess.RouteConfig = RouteConfig;
1276 PrivateData->ConfigAccess.Callback = DriverCallback;
1277 PrivateData->PasswordState = BROWSER_STATE_VALIDATE_PASSWORD;
1278
1279 //
1280 // Locate Hii Database protocol
1281 //
1282 Status = gBS->LocateProtocol (&gEfiHiiDatabaseProtocolGuid, NULL, (VOID **) &HiiDatabase);
1283 if (EFI_ERROR (Status)) {
1284 return Status;
1285 }
1286 PrivateData->HiiDatabase = HiiDatabase;
1287
1288 //
1289 // Locate HiiString protocol
1290 //
1291 Status = gBS->LocateProtocol (&gEfiHiiStringProtocolGuid, NULL, (VOID **) &HiiString);
1292 if (EFI_ERROR (Status)) {
1293 return Status;
1294 }
1295 PrivateData->HiiString = HiiString;
1296
1297 //
1298 // Locate Formbrowser2 protocol
1299 //
1300 Status = gBS->LocateProtocol (&gEfiFormBrowser2ProtocolGuid, NULL, (VOID **) &FormBrowser2);
1301 if (EFI_ERROR (Status)) {
1302 return Status;
1303 }
1304 PrivateData->FormBrowser2 = FormBrowser2;
1305
1306 //
1307 // Locate ConfigRouting protocol
1308 //
1309 Status = gBS->LocateProtocol (&gEfiHiiConfigRoutingProtocolGuid, NULL, (VOID **) &HiiConfigRouting);
1310 if (EFI_ERROR (Status)) {
1311 return Status;
1312 }
1313 PrivateData->HiiConfigRouting = HiiConfigRouting;
1314
1315 Status = gBS->InstallMultipleProtocolInterfaces (
1316 &DriverHandle[0],
1317 &gEfiDevicePathProtocolGuid,
1318 &mHiiVendorDevicePath0,
1319 &gEfiHiiConfigAccessProtocolGuid,
1320 &PrivateData->ConfigAccess,
1321 NULL
1322 );
1323 ASSERT_EFI_ERROR (Status);
1324
1325 PrivateData->DriverHandle[0] = DriverHandle[0];
1326
1327 //
1328 // Publish our HII data
1329 //
1330 HiiHandle[0] = HiiAddPackages (
1331 &mFormSetGuid,
1332 DriverHandle[0],
1333 DriverSampleStrings,
1334 VfrBin,
1335 NULL
1336 );
1337 if (HiiHandle[0] == NULL) {
1338 return EFI_OUT_OF_RESOURCES;
1339 }
1340
1341 PrivateData->HiiHandle[0] = HiiHandle[0];
1342
1343 //
1344 // Publish another Fromset
1345 //
1346 Status = gBS->InstallMultipleProtocolInterfaces (
1347 &DriverHandle[1],
1348 &gEfiDevicePathProtocolGuid,
1349 &mHiiVendorDevicePath1,
1350 NULL
1351 );
1352 ASSERT_EFI_ERROR (Status);
1353
1354 PrivateData->DriverHandle[1] = DriverHandle[1];
1355
1356 HiiHandle[1] = HiiAddPackages (
1357 &mInventoryGuid,
1358 DriverHandle[1],
1359 DriverSampleStrings,
1360 InventoryBin,
1361 NULL
1362 );
1363 if (HiiHandle[1] == NULL) {
1364 DriverSampleUnload (ImageHandle);
1365 return EFI_OUT_OF_RESOURCES;
1366 }
1367
1368 PrivateData->HiiHandle[1] = HiiHandle[1];
1369
1370 //
1371 // Very simple example of how one would update a string that is already
1372 // in the HII database
1373 //
1374 NewString = L"700 Mhz";
1375
1376 if (HiiSetString (HiiHandle[0], STRING_TOKEN (STR_CPU_STRING2), NewString, NULL) == 0) {
1377 DriverSampleUnload (ImageHandle);
1378 return EFI_OUT_OF_RESOURCES;
1379 }
1380
1381 HiiSetString (HiiHandle[0], 0, NewString, NULL);
1382
1383 //
1384 // Initialize Name/Value name String ID
1385 //
1386 PrivateData->NameStringId[0] = STR_NAME_VALUE_VAR_NAME0;
1387 PrivateData->NameStringId[1] = STR_NAME_VALUE_VAR_NAME1;
1388 PrivateData->NameStringId[2] = STR_NAME_VALUE_VAR_NAME2;
1389
1390 //
1391 // Initialize configuration data
1392 //
1393 Configuration = &PrivateData->Configuration;
1394 ZeroMem (Configuration, sizeof (DRIVER_SAMPLE_CONFIGURATION));
1395
1396 //
1397 // Try to read NV config EFI variable first
1398 //
1399 ConfigRequestHdr = HiiConstructConfigHdr (&mFormSetGuid, VariableName, DriverHandle[0]);
1400 ASSERT (ConfigRequestHdr != NULL);
1401
1402 BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);
1403 Status = gRT->GetVariable (VariableName, &mFormSetGuid, NULL, &BufferSize, Configuration);
1404 if (EFI_ERROR (Status)) {
1405 //
1406 // Store zero data Buffer Storage to EFI variable
1407 //
1408 Status = gRT->SetVariable(
1409 VariableName,
1410 &mFormSetGuid,
1411 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,
1412 sizeof (DRIVER_SAMPLE_CONFIGURATION),
1413 Configuration
1414 );
1415 ASSERT (Status == EFI_SUCCESS);
1416 //
1417 // EFI variable for NV config doesn't exit, we should build this variable
1418 // based on default values stored in IFR
1419 //
1420 ActionFlag = HiiSetToDefaults (ConfigRequestHdr, EFI_HII_DEFAULT_CLASS_STANDARD);
1421 ASSERT (ActionFlag);
1422 } else {
1423 //
1424 // EFI variable does exist and Validate Current Setting
1425 //
1426 ActionFlag = HiiValidateSettings (ConfigRequestHdr);
1427 ASSERT (ActionFlag);
1428 }
1429
1430 FreePool (ConfigRequestHdr);
1431
1432
1433 //
1434 // In default, this driver is built into Flash device image,
1435 // the following code doesn't run.
1436 //
1437
1438 //
1439 // Example of how to display only the item we sent to HII
1440 // When this driver is not built into Flash device image,
1441 // it need to call SendForm to show front page by itself.
1442 //
1443 if (DISPLAY_ONLY_MY_ITEM <= 1) {
1444 //
1445 // Have the browser pull out our copy of the data, and only display our data
1446 //
1447 Status = FormBrowser2->SendForm (
1448 FormBrowser2,
1449 &(HiiHandle[DISPLAY_ONLY_MY_ITEM]),
1450 1,
1451 NULL,
1452 0,
1453 NULL,
1454 NULL
1455 );
1456
1457 HiiRemovePackages (HiiHandle[0]);
1458
1459 HiiRemovePackages (HiiHandle[1]);
1460 }
1461
1462 return EFI_SUCCESS;
1463 }
1464
1465 /**
1466 Unloads the application and its installed protocol.
1467
1468 @param[in] ImageHandle Handle that identifies the image to be unloaded.
1469
1470 @retval EFI_SUCCESS The image has been unloaded.
1471 **/
1472 EFI_STATUS
1473 EFIAPI
1474 DriverSampleUnload (
1475 IN EFI_HANDLE ImageHandle
1476 )
1477 {
1478 UINTN Index;
1479
1480 ASSERT (PrivateData != NULL);
1481
1482 if (DriverHandle[0] != NULL) {
1483 gBS->UninstallMultipleProtocolInterfaces (
1484 DriverHandle[0],
1485 &gEfiDevicePathProtocolGuid,
1486 &mHiiVendorDevicePath0,
1487 &gEfiHiiConfigAccessProtocolGuid,
1488 &PrivateData->ConfigAccess,
1489 NULL
1490 );
1491 DriverHandle[0] = NULL;
1492 }
1493
1494 if (DriverHandle[1] != NULL) {
1495 gBS->UninstallMultipleProtocolInterfaces (
1496 DriverHandle[1],
1497 &gEfiDevicePathProtocolGuid,
1498 &mHiiVendorDevicePath1,
1499 NULL
1500 );
1501 DriverHandle[1] = NULL;
1502 }
1503
1504 if (PrivateData->HiiHandle[0] != NULL) {
1505 HiiRemovePackages (PrivateData->HiiHandle[0]);
1506 }
1507
1508 if (PrivateData->HiiHandle[1] != NULL) {
1509 HiiRemovePackages (PrivateData->HiiHandle[1]);
1510 }
1511
1512 for (Index = 0; Index < NAME_VALUE_NAME_NUMBER; Index++) {
1513 if (PrivateData->NameValueName[Index] != NULL) {
1514 FreePool (PrivateData->NameValueName[Index]);
1515 }
1516 }
1517 FreePool (PrivateData);
1518 PrivateData = NULL;
1519
1520 return EFI_SUCCESS;
1521 }