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
5 Copyright (c) 2004 - 2008, Intel Corporation
6 All rights reserved. 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
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.
17 #include "DriverSample.h"
19 #define DISPLAY_ONLY_MY_ITEM 0x0002
21 EFI_GUID mFormSetGuid
= FORMSET_GUID
;
22 EFI_GUID mInventoryGuid
= INVENTORY_GUID
;
24 CHAR16 VariableName
[] = L
"MyIfrNVData";
26 EFI_HANDLE DriverHandle
[2] = {NULL
, NULL
};
27 DRIVER_SAMPLE_PRIVATE_DATA
*PrivateData
= NULL
;
29 HII_VENDOR_DEVICE_PATH mHiiVendorDevicePath0
= {
35 (UINT8
) (sizeof (VENDOR_DEVICE_PATH
)),
36 (UINT8
) ((sizeof (VENDOR_DEVICE_PATH
)) >> 8)
40 // {C153B68D-EBFC-488e-B110-662867745B87}
42 { 0xc153b68d, 0xebfc, 0x488e, { 0xb1, 0x10, 0x66, 0x28, 0x67, 0x74, 0x5b, 0x87 } }
46 END_ENTIRE_DEVICE_PATH_SUBTYPE
,
48 (UINT8
) (END_DEVICE_PATH_LENGTH
),
49 (UINT8
) ((END_DEVICE_PATH_LENGTH
) >> 8)
54 HII_VENDOR_DEVICE_PATH mHiiVendorDevicePath1
= {
60 (UINT8
) (sizeof (VENDOR_DEVICE_PATH
)),
61 (UINT8
) ((sizeof (VENDOR_DEVICE_PATH
)) >> 8)
65 // {06F37F07-0C48-40e9-8436-0A08A0BB76B0}
67 { 0x6f37f07, 0xc48, 0x40e9, { 0x84, 0x36, 0xa, 0x8, 0xa0, 0xbb, 0x76, 0xb0 } }
71 END_ENTIRE_DEVICE_PATH_SUBTYPE
,
73 (UINT8
) (END_DEVICE_PATH_LENGTH
),
74 (UINT8
) ((END_DEVICE_PATH_LENGTH
) >> 8)
80 Encode the password using a simple algorithm.
82 @param Password The string to be encoded.
83 @param MaxSize The size of the string.
98 Buffer
= AllocateZeroPool (MaxSize
);
99 ASSERT (Buffer
!= NULL
);
101 for (Index
= 0; Key
[Index
] != 0; Index
++) {
102 for (Loop
= 0; Loop
< (UINT8
) (MaxSize
/ 2); Loop
++) {
103 Buffer
[Loop
] = (CHAR16
) (Password
[Loop
] ^ Key
[Index
]);
107 CopyMem (Password
, Buffer
, MaxSize
);
114 Validate the user's password.
116 @param PrivateData This driver's private context data.
117 @param StringId The user's input.
119 @retval EFI_SUCCESS The user's input matches the password.
120 @retval EFI_NOT_READY The user's input does not match the password.
124 IN DRIVER_SAMPLE_PRIVATE_DATA
*PrivateData
,
125 IN EFI_STRING_ID StringId
131 UINTN PasswordMaxSize
;
133 CHAR16
*EncodedPassword
;
137 // Get encoded password first
139 BufferSize
= sizeof (DRIVER_SAMPLE_CONFIGURATION
);
140 Status
= gRT
->GetVariable (
145 &PrivateData
->Configuration
147 if (EFI_ERROR (Status
)) {
149 // Old password not exist, prompt for new password
155 PasswordMaxSize
= sizeof (PrivateData
->Configuration
.WhatIsThePassword2
);
157 // Check whether we have any old password set
159 for (Index
= 0; Index
< PasswordMaxSize
/ sizeof (UINT16
); Index
++) {
160 if (PrivateData
->Configuration
.WhatIsThePassword2
[Index
] != 0) {
167 // Old password not exist, return EFI_SUCCESS to prompt for new password
173 // Get user input password
175 Password
= HiiGetString (PrivateData
->HiiHandle
[0], StringId
, NULL
);
176 if (Password
== NULL
) {
177 return EFI_NOT_READY
;
179 if (StrSize (Password
) > PasswordMaxSize
) {
181 return EFI_NOT_READY
;
185 // Validate old password
187 EncodedPassword
= AllocateZeroPool (PasswordMaxSize
);
188 ASSERT (EncodedPassword
!= NULL
);
189 StrnCpy (EncodedPassword
, Password
, StrLen (Password
));
190 EncodePassword (EncodedPassword
, StrLen (EncodedPassword
) * sizeof (CHAR16
));
191 if (CompareMem (EncodedPassword
, PrivateData
->Configuration
.WhatIsThePassword2
, StrLen (EncodedPassword
) * sizeof (CHAR16
)) != 0) {
193 // Old password mismatch, return EFI_NOT_READY to prompt for error message
195 Status
= EFI_NOT_READY
;
197 Status
= EFI_SUCCESS
;
201 FreePool (EncodedPassword
);
207 Encode the password using a simple algorithm.
209 @param PrivateData This driver's private context data.
210 @param StringId The password from User.
212 @retval EFI_SUCESS The operation is successful.
213 @return Other value if gRT->SetVariable () fails.
218 IN DRIVER_SAMPLE_PRIVATE_DATA
*PrivateData
,
219 IN EFI_STRING_ID StringId
224 CHAR16
*TempPassword
;
226 DRIVER_SAMPLE_CONFIGURATION
*Configuration
;
230 // Get Buffer Storage data from EFI variable
232 BufferSize
= sizeof (DRIVER_SAMPLE_CONFIGURATION
);
233 Status
= gRT
->GetVariable (
238 &PrivateData
->Configuration
240 if (EFI_ERROR (Status
)) {
245 // Get user input password
247 Password
= &PrivateData
->Configuration
.WhatIsThePassword2
[0];
248 PasswordSize
= sizeof (PrivateData
->Configuration
.WhatIsThePassword2
);
249 ZeroMem (Password
, PasswordSize
);
251 TempPassword
= HiiGetString (PrivateData
->HiiHandle
[0], StringId
, NULL
);
252 if (TempPassword
== NULL
) {
253 return EFI_NOT_READY
;
255 if (StrSize (TempPassword
) > PasswordSize
) {
256 FreePool (TempPassword
);
257 return EFI_NOT_READY
;
259 StrnCpy (Password
, TempPassword
, StrLen (TempPassword
));
260 FreePool (TempPassword
);
263 // Retrive uncommitted data from Browser
265 Configuration
= AllocateZeroPool (sizeof (DRIVER_SAMPLE_CONFIGURATION
));
266 ASSERT (Configuration
!= NULL
);
267 if (HiiGetBrowserData (&mFormSetGuid
, VariableName
, sizeof (DRIVER_SAMPLE_CONFIGURATION
), (UINT8
*) Configuration
)) {
269 // Update password's clear text in the screen
271 CopyMem (Configuration
->PasswordClearText
, Password
, StrSize (Password
));
274 // Update uncommitted data of Browser
279 sizeof (DRIVER_SAMPLE_CONFIGURATION
),
280 (UINT8
*) Configuration
,
286 // Free Configuration Buffer
288 FreePool (Configuration
);
294 EncodePassword (Password
, StrLen (Password
) * 2);
295 Status
= gRT
->SetVariable(
298 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
,
299 sizeof (DRIVER_SAMPLE_CONFIGURATION
),
300 &PrivateData
->Configuration
307 This function allows a caller to extract the current configuration for one
308 or more named elements from the target driver.
310 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
311 @param Request A null-terminated Unicode string in
312 <ConfigRequest> format.
313 @param Progress On return, points to a character in the Request
314 string. Points to the string's null terminator if
315 request was successful. Points to the most recent
316 '&' before the first failing name/value pair (or
317 the beginning of the string if the failure is in
318 the first name/value pair) if the request was not
320 @param Results A null-terminated Unicode string in
321 <ConfigAltResp> format which has all values filled
322 in for the names in the Request string. String to
323 be allocated by the called function.
325 @retval EFI_SUCCESS The Results is filled with the requested values.
326 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.
327 @retval EFI_INVALID_PARAMETER Request is NULL, illegal syntax, or unknown name.
328 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this
335 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
336 IN CONST EFI_STRING Request
,
337 OUT EFI_STRING
*Progress
,
338 OUT EFI_STRING
*Results
343 DRIVER_SAMPLE_PRIVATE_DATA
*PrivateData
;
344 EFI_HII_CONFIG_ROUTING_PROTOCOL
*HiiConfigRouting
;
345 EFI_STRING ConfigRequestHdr
;
346 EFI_STRING ConfigRequest
;
350 // Initialize the local variables.
352 ConfigRequestHdr
= NULL
;
353 ConfigRequest
= NULL
;
357 PrivateData
= DRIVER_SAMPLE_PRIVATE_FROM_THIS (This
);
358 HiiConfigRouting
= PrivateData
->HiiConfigRouting
;
361 // Get Buffer Storage data from EFI variable.
362 // Try to get the current setting from variable.
364 BufferSize
= sizeof (DRIVER_SAMPLE_CONFIGURATION
);
365 Status
= gRT
->GetVariable (
370 &PrivateData
->Configuration
372 if (EFI_ERROR (Status
)) {
376 if (Request
== NULL
) {
378 // Request is set to NULL, construct full request string.
382 // First Set ConfigRequestHdr string.
384 ConfigRequestHdr
= HiiConstructConfigHdr (&mFormSetGuid
, VariableName
, PrivateData
->DriverHandle
[0]);
385 ASSERT (ConfigRequestHdr
!= NULL
);
388 // Allocate and fill a buffer large enough to hold the <ConfigHdr> template
389 // followed by "&OFFSET=0&WIDTH=WWWWWWWWWWWWWWWW" followed by a Null-terminator
391 Size
= (StrLen (ConfigRequestHdr
) + 32 + 1) * sizeof (CHAR16
);
392 ConfigRequest
= AllocateZeroPool (Size
);
393 UnicodeSPrint (ConfigRequest
, Size
, L
"%s&OFFSET=0&WIDTH=%016LX", ConfigRequestHdr
, (UINT64
)BufferSize
);
394 FreePool (ConfigRequestHdr
);
396 ConfigRequest
= Request
;
400 // Check routing data in <ConfigHdr>.
401 // Note: if only one Storage is used, then this checking could be skipped.
403 if (!HiiIsConfigHdrMatch (ConfigRequest
, &mFormSetGuid
, VariableName
)) {
404 if (Request
== NULL
) {
405 FreePool (ConfigRequest
);
407 return EFI_NOT_FOUND
;
411 // Convert buffer data to <ConfigResp> by helper function BlockToConfig()
413 Status
= HiiConfigRouting
->BlockToConfig (
416 (UINT8
*) &PrivateData
->Configuration
,
422 if (Request
== NULL
) {
423 FreePool (ConfigRequest
);
432 This function processes the results of changes in configuration.
434 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
435 @param Configuration A null-terminated Unicode string in <ConfigResp>
437 @param Progress A pointer to a string filled in with the offset of
438 the most recent '&' before the first failing
439 name/value pair (or the beginning of the string if
440 the failure is in the first name/value pair) or
441 the terminating NULL if all was successful.
443 @retval EFI_SUCCESS The Results is processed successfully.
444 @retval EFI_INVALID_PARAMETER Configuration is NULL.
445 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this
452 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
453 IN CONST EFI_STRING Configuration
,
454 OUT EFI_STRING
*Progress
459 DRIVER_SAMPLE_PRIVATE_DATA
*PrivateData
;
460 EFI_HII_CONFIG_ROUTING_PROTOCOL
*HiiConfigRouting
;
462 if (Configuration
== NULL
) {
463 return EFI_INVALID_PARAMETER
;
466 PrivateData
= DRIVER_SAMPLE_PRIVATE_FROM_THIS (This
);
467 HiiConfigRouting
= PrivateData
->HiiConfigRouting
;
470 // Check routing data in <ConfigHdr>.
471 // Note: if only one Storage is used, then this checking could be skipped.
473 if (!HiiIsConfigHdrMatch (Configuration
, &mFormSetGuid
, VariableName
)) {
474 *Progress
= Configuration
;
475 return EFI_NOT_FOUND
;
479 // Get Buffer Storage data from EFI variable
481 BufferSize
= sizeof (DRIVER_SAMPLE_CONFIGURATION
);
482 Status
= gRT
->GetVariable (
487 &PrivateData
->Configuration
489 if (EFI_ERROR (Status
)) {
494 // Convert <ConfigResp> to buffer data by helper function ConfigToBlock()
496 BufferSize
= sizeof (DRIVER_SAMPLE_CONFIGURATION
);
497 Status
= HiiConfigRouting
->ConfigToBlock (
500 (UINT8
*) &PrivateData
->Configuration
,
504 if (EFI_ERROR (Status
)) {
509 // Store Buffer Storage back to EFI variable
511 Status
= gRT
->SetVariable(
514 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
,
515 sizeof (DRIVER_SAMPLE_CONFIGURATION
),
516 &PrivateData
->Configuration
524 This function processes the results of changes in configuration.
526 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
527 @param Action Specifies the type of action taken by the browser.
528 @param QuestionId A unique value which is sent to the original
529 exporting driver so that it can identify the type
531 @param Type The type of value for the question.
532 @param Value A pointer to the data being sent to the original
534 @param ActionRequest On return, points to the action requested by the
537 @retval EFI_SUCCESS The callback successfully handled the action.
538 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the
539 variable and its data.
540 @retval EFI_DEVICE_ERROR The variable could not be saved.
541 @retval EFI_UNSUPPORTED The specified Action is not supported by the
548 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
549 IN EFI_BROWSER_ACTION Action
,
550 IN EFI_QUESTION_ID QuestionId
,
552 IN EFI_IFR_TYPE_VALUE
*Value
,
553 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest
556 DRIVER_SAMPLE_PRIVATE_DATA
*PrivateData
;
559 VOID
*StartOpCodeHandle
;
560 VOID
*OptionsOpCodeHandle
;
561 EFI_IFR_GUID_LABEL
*StartLabel
;
562 VOID
*EndOpCodeHandle
;
563 EFI_IFR_GUID_LABEL
*EndLabel
;
565 if ((Value
== NULL
) || (ActionRequest
== NULL
)) {
566 return EFI_INVALID_PARAMETER
;
569 if ((Type
== EFI_IFR_TYPE_STRING
) && (Value
->string
== 0)) {
570 return EFI_INVALID_PARAMETER
;
574 Status
= EFI_SUCCESS
;
575 PrivateData
= DRIVER_SAMPLE_PRIVATE_FROM_THIS (This
);
577 switch (QuestionId
) {
580 // Initialize the container for dynamic opcodes
582 StartOpCodeHandle
= HiiAllocateOpCodeHandle ();
583 ASSERT (StartOpCodeHandle
!= NULL
);
585 EndOpCodeHandle
= HiiAllocateOpCodeHandle ();
586 ASSERT (EndOpCodeHandle
!= NULL
);
589 // Create Hii Extend Label OpCode as the start opcode
591 StartLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (StartOpCodeHandle
, &gEfiIfrTianoGuid
, NULL
, sizeof (EFI_IFR_GUID_LABEL
));
592 StartLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
593 StartLabel
->Number
= LABEL_UPDATE1
;
596 // Create Hii Extend Label OpCode as the end opcode
598 EndLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (EndOpCodeHandle
, &gEfiIfrTianoGuid
, NULL
, sizeof (EFI_IFR_GUID_LABEL
));
599 EndLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
600 EndLabel
->Number
= LABEL_END
;
602 HiiCreateActionOpCode (
603 StartOpCodeHandle
, // Container for dynamic created opcodes
604 0x1237, // Question ID
605 STRING_TOKEN(STR_EXIT_TEXT
), // Prompt text
606 STRING_TOKEN(STR_EXIT_TEXT
), // Help text
607 EFI_IFR_FLAG_CALLBACK
, // Question flag
608 0 // Action String ID
612 // Create Option OpCode
614 OptionsOpCodeHandle
= HiiAllocateOpCodeHandle ();
615 ASSERT (OptionsOpCodeHandle
!= NULL
);
617 HiiCreateOneOfOptionOpCode (
619 STRING_TOKEN (STR_BOOT_OPTION1
),
621 EFI_IFR_NUMERIC_SIZE_1
,
625 HiiCreateOneOfOptionOpCode (
627 STRING_TOKEN (STR_BOOT_OPTION2
),
629 EFI_IFR_NUMERIC_SIZE_1
,
634 // Prepare initial value for the dynamic created oneof Question
636 PrivateData
->Configuration
.DynamicOneof
= 2;
637 Status
= gRT
->SetVariable(
640 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
,
641 sizeof (DRIVER_SAMPLE_CONFIGURATION
),
642 &PrivateData
->Configuration
645 HiiCreateOneOfOpCode (
646 StartOpCodeHandle
, // Container for dynamic created opcodes
647 0x8001, // Question ID (or call it "key")
648 CONFIGURATION_VARSTORE_ID
, // VarStore ID
649 (UINT16
) DYNAMIC_ONE_OF_VAR_OFFSET
, // Offset in Buffer Storage
650 STRING_TOKEN (STR_ONE_OF_PROMPT
), // Question prompt text
651 STRING_TOKEN (STR_ONE_OF_HELP
), // Question help text
652 EFI_IFR_FLAG_CALLBACK
, // Question flag
653 EFI_IFR_NUMERIC_SIZE_1
, // Data type of Question Value
654 OptionsOpCodeHandle
, // Option Opcode list
655 NULL
// Default Opcode is NULl
658 HiiCreateOrderedListOpCode (
659 StartOpCodeHandle
, // Container for dynamic created opcodes
660 0x8002, // Question ID
661 CONFIGURATION_VARSTORE_ID
, // VarStore ID
662 (UINT16
) DYNAMIC_ORDERED_LIST_VAR_OFFSET
, // Offset in Buffer Storage
663 STRING_TOKEN (STR_BOOT_OPTIONS
), // Question prompt text
664 STRING_TOKEN (STR_BOOT_OPTIONS
), // Question help text
665 EFI_IFR_FLAG_RESET_REQUIRED
, // Question flag
666 0, // Ordered list flag, e.g. EFI_IFR_UNIQUE_SET
667 EFI_IFR_NUMERIC_SIZE_1
, // Data type of Question value
668 5, // Maximum container
669 OptionsOpCodeHandle
, // Option Opcode list
670 NULL
// Default Opcode is NULl
673 HiiCreateGotoOpCode (
674 StartOpCodeHandle
, // Container for dynamic created opcodes
676 STRING_TOKEN (STR_GOTO_FORM1
), // Prompt text
677 STRING_TOKEN (STR_GOTO_HELP
), // Help text
679 0x8003 // Question ID
683 PrivateData
->HiiHandle
[0], // HII handle
684 &mFormSetGuid
, // Formset GUID
686 StartOpCodeHandle
, // Label for where to insert opcodes
687 EndOpCodeHandle
// Replace data
690 HiiFreeOpCodeHandle (StartOpCodeHandle
);
691 HiiFreeOpCodeHandle (OptionsOpCodeHandle
);
696 // We will reach here once the Question is refreshed
700 // Initialize the container for dynamic opcodes
702 StartOpCodeHandle
= HiiAllocateOpCodeHandle ();
703 ASSERT (StartOpCodeHandle
!= NULL
);
706 // Create Hii Extend Label OpCode as the start opcode
708 StartLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (StartOpCodeHandle
, &gEfiIfrTianoGuid
, NULL
, sizeof (EFI_IFR_GUID_LABEL
));
709 StartLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
710 StartLabel
->Number
= LABEL_UPDATE2
;
712 HiiCreateActionOpCode (
713 StartOpCodeHandle
, // Container for dynamic created opcodes
714 0x1237, // Question ID
715 STRING_TOKEN(STR_EXIT_TEXT
), // Prompt text
716 STRING_TOKEN(STR_EXIT_TEXT
), // Help text
717 EFI_IFR_FLAG_CALLBACK
, // Question flag
718 0 // Action String ID
722 PrivateData
->HiiHandle
[0], // HII handle
723 &mFormSetGuid
, // Formset GUID
725 StartOpCodeHandle
, // Label for where to insert opcodes
729 HiiFreeOpCodeHandle (StartOpCodeHandle
);
732 // Refresh the Question value
734 PrivateData
->Configuration
.DynamicRefresh
++;
735 Status
= gRT
->SetVariable(
738 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
,
739 sizeof (DRIVER_SAMPLE_CONFIGURATION
),
740 &PrivateData
->Configuration
744 // Change an EFI Variable storage (MyEfiVar) asynchronous, this will cause
745 // the first statement in Form 3 be suppressed
748 Status
= gRT
->SetVariable(
751 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
,
759 // User press "Exit now", request Browser to exit
761 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_EXIT
;
766 // User press "Save now", request Browser to save the uncommitted data.
768 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_SUBMIT
;
773 // When try to set a new password, user will be chanlleged with old password.
774 // The Callback is responsible for validating old password input by user,
775 // If Callback return EFI_SUCCESS, it indicates validation pass.
777 switch (PrivateData
->PasswordState
) {
778 case BROWSER_STATE_VALIDATE_PASSWORD
:
779 Status
= ValidatePassword (PrivateData
, Value
->string
);
780 if (Status
== EFI_SUCCESS
) {
781 PrivateData
->PasswordState
= BROWSER_STATE_SET_PASSWORD
;
785 case BROWSER_STATE_SET_PASSWORD
:
786 Status
= SetPassword (PrivateData
, Value
->string
);
787 PrivateData
->PasswordState
= BROWSER_STATE_VALIDATE_PASSWORD
;
804 Main entry for this driver.
806 @param ImageHandle Image handle this driver.
807 @param SystemTable Pointer to SystemTable.
809 @retval EFI_SUCESS This function always complete successfully.
815 IN EFI_HANDLE ImageHandle
,
816 IN EFI_SYSTEM_TABLE
*SystemTable
820 EFI_HII_HANDLE HiiHandle
[2];
821 EFI_SCREEN_DESCRIPTOR Screen
;
822 EFI_HII_DATABASE_PROTOCOL
*HiiDatabase
;
823 EFI_HII_STRING_PROTOCOL
*HiiString
;
824 EFI_FORM_BROWSER2_PROTOCOL
*FormBrowser2
;
825 EFI_HII_CONFIG_ROUTING_PROTOCOL
*HiiConfigRouting
;
828 DRIVER_SAMPLE_CONFIGURATION
*Configuration
;
830 EFI_STRING ConfigRequestHdr
;
833 // Initialize the local variables.
835 ConfigRequestHdr
= NULL
;
838 // Initialize screen dimensions for SendForm().
839 // Remove 3 characters from top and bottom
841 ZeroMem (&Screen
, sizeof (EFI_SCREEN_DESCRIPTOR
));
842 gST
->ConOut
->QueryMode (gST
->ConOut
, gST
->ConOut
->Mode
->Mode
, &Screen
.RightColumn
, &Screen
.BottomRow
);
845 Screen
.BottomRow
= Screen
.BottomRow
- 3;
848 // Initialize driver private data
850 PrivateData
= AllocatePool (sizeof (DRIVER_SAMPLE_PRIVATE_DATA
));
851 if (PrivateData
== NULL
) {
852 return EFI_OUT_OF_RESOURCES
;
855 PrivateData
->Signature
= DRIVER_SAMPLE_PRIVATE_SIGNATURE
;
857 PrivateData
->ConfigAccess
.ExtractConfig
= ExtractConfig
;
858 PrivateData
->ConfigAccess
.RouteConfig
= RouteConfig
;
859 PrivateData
->ConfigAccess
.Callback
= DriverCallback
;
860 PrivateData
->PasswordState
= BROWSER_STATE_VALIDATE_PASSWORD
;
863 // Locate Hii Database protocol
865 Status
= gBS
->LocateProtocol (&gEfiHiiDatabaseProtocolGuid
, NULL
, (VOID
**) &HiiDatabase
);
866 if (EFI_ERROR (Status
)) {
869 PrivateData
->HiiDatabase
= HiiDatabase
;
872 // Locate HiiString protocol
874 Status
= gBS
->LocateProtocol (&gEfiHiiStringProtocolGuid
, NULL
, (VOID
**) &HiiString
);
875 if (EFI_ERROR (Status
)) {
878 PrivateData
->HiiString
= HiiString
;
881 // Locate Formbrowser2 protocol
883 Status
= gBS
->LocateProtocol (&gEfiFormBrowser2ProtocolGuid
, NULL
, (VOID
**) &FormBrowser2
);
884 if (EFI_ERROR (Status
)) {
887 PrivateData
->FormBrowser2
= FormBrowser2
;
890 // Locate ConfigRouting protocol
892 Status
= gBS
->LocateProtocol (&gEfiHiiConfigRoutingProtocolGuid
, NULL
, (VOID
**) &HiiConfigRouting
);
893 if (EFI_ERROR (Status
)) {
896 PrivateData
->HiiConfigRouting
= HiiConfigRouting
;
898 Status
= gBS
->InstallMultipleProtocolInterfaces (
900 &gEfiDevicePathProtocolGuid
,
901 &mHiiVendorDevicePath0
,
902 &gEfiHiiConfigAccessProtocolGuid
,
903 &PrivateData
->ConfigAccess
,
906 ASSERT_EFI_ERROR (Status
);
908 PrivateData
->DriverHandle
[0] = DriverHandle
[0];
911 // Publish our HII data
913 HiiHandle
[0] = HiiAddPackages (
920 if (HiiHandle
[0] == NULL
) {
921 return EFI_OUT_OF_RESOURCES
;
924 PrivateData
->HiiHandle
[0] = HiiHandle
[0];
927 // Publish another Fromset
929 Status
= gBS
->InstallMultipleProtocolInterfaces (
931 &gEfiDevicePathProtocolGuid
,
932 &mHiiVendorDevicePath1
,
935 ASSERT_EFI_ERROR (Status
);
937 PrivateData
->DriverHandle
[1] = DriverHandle
[1];
939 HiiHandle
[1] = HiiAddPackages (
946 if (HiiHandle
[1] == NULL
) {
947 return EFI_OUT_OF_RESOURCES
;
950 PrivateData
->HiiHandle
[1] = HiiHandle
[1];
953 // Very simple example of how one would update a string that is already
954 // in the HII database
956 NewString
= L
"700 Mhz";
958 if (HiiSetString (HiiHandle
[0], STRING_TOKEN (STR_CPU_STRING2
), NewString
, NULL
) == 0) {
959 return EFI_OUT_OF_RESOURCES
;
963 // Initialize configuration data
965 Configuration
= &PrivateData
->Configuration
;
966 ZeroMem (Configuration
, sizeof (DRIVER_SAMPLE_CONFIGURATION
));
969 // Try to read NV config EFI variable first
971 ConfigRequestHdr
= HiiConstructConfigHdr (&mFormSetGuid
, VariableName
, DriverHandle
[0]);
972 ASSERT (ConfigRequestHdr
!= NULL
);
974 BufferSize
= sizeof (DRIVER_SAMPLE_CONFIGURATION
);
975 Status
= gRT
->GetVariable (VariableName
, &mFormSetGuid
, NULL
, &BufferSize
, Configuration
);
976 if (EFI_ERROR (Status
)) {
978 // Store zero data Buffer Storage to EFI variable
980 Status
= gRT
->SetVariable(
983 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
,
984 sizeof (DRIVER_SAMPLE_CONFIGURATION
),
987 ASSERT (Status
== EFI_SUCCESS
);
989 // EFI variable for NV config doesn't exit, we should build this variable
990 // based on default values stored in IFR
992 ActionFlag
= HiiSetToDefaults (ConfigRequestHdr
, EFI_HII_DEFAULT_CLASS_STANDARD
);
996 // EFI variable does exist and Validate Current Setting
998 ActionFlag
= HiiValidateSettings (ConfigRequestHdr
);
1002 FreePool (ConfigRequestHdr
);
1006 // In default, this driver is built into Flash device image,
1007 // the following code doesn't run.
1011 // Example of how to display only the item we sent to HII
1012 // When this driver is not built into Flash device image,
1013 // it need to call SendForm to show front page by itself.
1015 if (DISPLAY_ONLY_MY_ITEM
<= 1) {
1017 // Have the browser pull out our copy of the data, and only display our data
1019 Status
= FormBrowser2
->SendForm (
1021 &(HiiHandle
[DISPLAY_ONLY_MY_ITEM
]),
1029 HiiRemovePackages (HiiHandle
[0]);
1031 HiiRemovePackages (HiiHandle
[1]);
1038 Unloads the application and its installed protocol.
1040 @param[in] ImageHandle Handle that identifies the image to be unloaded.
1042 @retval EFI_SUCCESS The image has been unloaded.
1046 DriverSampleUnload (
1047 IN EFI_HANDLE ImageHandle
1050 if (DriverHandle
[0] != NULL
) {
1051 gBS
->UninstallMultipleProtocolInterfaces (
1053 &gEfiDevicePathProtocolGuid
,
1054 &mHiiVendorDevicePath0
,
1055 &gEfiHiiConfigAccessProtocolGuid
,
1056 &PrivateData
->ConfigAccess
,
1061 if (DriverHandle
[1] != NULL
) {
1062 gBS
->UninstallMultipleProtocolInterfaces (
1064 &gEfiDevicePathProtocolGuid
,
1065 &mHiiVendorDevicePath1
,
1070 if (PrivateData
->HiiHandle
[0] != NULL
) {
1071 HiiRemovePackages (PrivateData
->HiiHandle
[0]);
1074 if (PrivateData
->HiiHandle
[1] != NULL
) {
1075 HiiRemovePackages (PrivateData
->HiiHandle
[1]);
1078 if (PrivateData
!= NULL
) {
1079 FreePool (PrivateData
);