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
132 CHAR16
*EncodedPassword
;
136 // Get encoded password first
138 BufferSize
= sizeof (DRIVER_SAMPLE_CONFIGURATION
);
139 Status
= gRT
->GetVariable (
144 &PrivateData
->Configuration
146 if (EFI_ERROR (Status
)) {
148 // Old password not exist, prompt for new password
155 // Check whether we have any old password set
157 for (Index
= 0; Index
< 20; Index
++) {
158 if (PrivateData
->Configuration
.WhatIsThePassword2
[Index
] != 0) {
165 // Old password not exist, return EFI_SUCCESS to prompt for new password
171 // Get user input password
173 BufferSize
= 21 * sizeof (CHAR16
);
174 Password
= AllocateZeroPool (BufferSize
);
175 ASSERT (Password
!= NULL
);
177 Status
= HiiLibGetString (PrivateData
->HiiHandle
[0], StringId
, Password
, &BufferSize
);
178 if (EFI_ERROR (Status
)) {
184 // Validate old password
186 EncodedPassword
= AllocateCopyPool (21 * sizeof (CHAR16
), Password
);
187 ASSERT (EncodedPassword
!= NULL
);
188 EncodePassword (EncodedPassword
, 20 * sizeof (CHAR16
));
189 if (CompareMem (EncodedPassword
, PrivateData
->Configuration
.WhatIsThePassword2
, 20 * sizeof (CHAR16
)) != 0) {
191 // Old password mismatch, return EFI_NOT_READY to prompt for error message
193 Status
= EFI_NOT_READY
;
195 Status
= EFI_SUCCESS
;
199 FreePool (EncodedPassword
);
205 Encode the password using a simple algorithm.
207 @param PrivateData This driver's private context data.
208 @param StringId The password from User.
210 @retval EFI_SUCESS The operation is successful.
211 @return Other value if gRT->SetVariable () fails.
216 IN DRIVER_SAMPLE_PRIVATE_DATA
*PrivateData
,
217 IN EFI_STRING_ID StringId
223 DRIVER_SAMPLE_CONFIGURATION
*Configuration
;
227 // Get Buffer Storage data from EFI variable
229 BufferSize
= sizeof (DRIVER_SAMPLE_CONFIGURATION
);
230 Status
= gRT
->GetVariable (
235 &PrivateData
->Configuration
237 if (EFI_ERROR (Status
)) {
242 // Get user input password
244 Password
= &PrivateData
->Configuration
.WhatIsThePassword2
[0];
245 PasswordSize
= sizeof (PrivateData
->Configuration
.WhatIsThePassword2
);
247 ZeroMem (Password
, PasswordSize
);
248 Status
= HiiLibGetString (PrivateData
->HiiHandle
[0], StringId
, Password
, &BufferSize
);
249 if (EFI_ERROR (Status
)) {
254 // Retrive uncommitted data from Browser
256 Configuration
= (DRIVER_SAMPLE_CONFIGURATION
*) HiiGetBrowserData (&mFormSetGuid
, VariableName
, sizeof (DRIVER_SAMPLE_CONFIGURATION
));
257 if (Configuration
!= NULL
) {
259 // Update password's clear text in the screen
261 CopyMem (Configuration
->PasswordClearText
, Password
, PasswordSize
);
264 // Update uncommitted data of Browser
269 sizeof (DRIVER_SAMPLE_CONFIGURATION
),
270 (UINT8
*) Configuration
,
274 FreePool (Configuration
);
281 EncodePassword (Password
, PasswordSize
);
282 Status
= gRT
->SetVariable(
285 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
,
286 sizeof (DRIVER_SAMPLE_CONFIGURATION
),
287 &PrivateData
->Configuration
294 This function allows a caller to extract the current configuration for one
295 or more named elements from the target driver.
297 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
298 @param Request A null-terminated Unicode string in
299 <ConfigRequest> format.
300 @param Progress On return, points to a character in the Request
301 string. Points to the string's null terminator if
302 request was successful. Points to the most recent
303 '&' before the first failing name/value pair (or
304 the beginning of the string if the failure is in
305 the first name/value pair) if the request was not
307 @param Results A null-terminated Unicode string in
308 <ConfigAltResp> format which has all values filled
309 in for the names in the Request string. String to
310 be allocated by the called function.
312 @retval EFI_SUCCESS The Results is filled with the requested values.
313 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.
314 @retval EFI_INVALID_PARAMETER Request is NULL, illegal syntax, or unknown name.
315 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this
322 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
323 IN CONST EFI_STRING Request
,
324 OUT EFI_STRING
*Progress
,
325 OUT EFI_STRING
*Results
330 DRIVER_SAMPLE_PRIVATE_DATA
*PrivateData
;
331 EFI_HII_CONFIG_ROUTING_PROTOCOL
*HiiConfigRouting
;
333 PrivateData
= DRIVER_SAMPLE_PRIVATE_FROM_THIS (This
);
334 HiiConfigRouting
= PrivateData
->HiiConfigRouting
;
338 // Get Buffer Storage data from EFI variable
340 BufferSize
= sizeof (DRIVER_SAMPLE_CONFIGURATION
);
341 Status
= gRT
->GetVariable (
346 &PrivateData
->Configuration
348 if (EFI_ERROR (Status
)) {
352 if (Request
== NULL
) {
354 // Request is set to NULL, return all configurable elements together with ALTCFG
356 *Results
= HiiConstructConfigAltResp (
359 PrivateData
->DriverHandle
[0],
360 &PrivateData
->Configuration
,
362 VfrMyIfrNVDataBlockName
,
363 STRING_TOKEN (STR_STANDARD_DEFAULT_PROMPT
),
364 VfrMyIfrNVDataDefault0000
,
365 STRING_TOKEN (STR_MANUFACTURE_DEFAULT_PROMPT
),
366 VfrMyIfrNVDataDefault0001
,
372 // No matched storage is found.
374 if (*Results
== NULL
) {
375 return EFI_NOT_FOUND
;
382 // Check routing data in <ConfigHdr>.
383 // Note: if only one Storage is used, then this checking could be skipped.
385 if (!HiiIsConfigHdrMatch (Request
, &mFormSetGuid
, VariableName
)) {
387 return EFI_NOT_FOUND
;
391 // Convert buffer data to <ConfigResp> by helper function BlockToConfig()
393 Status
= HiiConfigRouting
->BlockToConfig (
396 (UINT8
*) &PrivateData
->Configuration
,
406 This function processes the results of changes in configuration.
408 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
409 @param Configuration A null-terminated Unicode string in <ConfigResp>
411 @param Progress A pointer to a string filled in with the offset of
412 the most recent '&' before the first failing
413 name/value pair (or the beginning of the string if
414 the failure is in the first name/value pair) or
415 the terminating NULL if all was successful.
417 @retval EFI_SUCCESS The Results is processed successfully.
418 @retval EFI_INVALID_PARAMETER Configuration is NULL.
419 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this
426 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
427 IN CONST EFI_STRING Configuration
,
428 OUT EFI_STRING
*Progress
433 DRIVER_SAMPLE_PRIVATE_DATA
*PrivateData
;
434 EFI_HII_CONFIG_ROUTING_PROTOCOL
*HiiConfigRouting
;
436 if (Configuration
== NULL
) {
437 return EFI_INVALID_PARAMETER
;
440 PrivateData
= DRIVER_SAMPLE_PRIVATE_FROM_THIS (This
);
441 HiiConfigRouting
= PrivateData
->HiiConfigRouting
;
443 // Check routing data in <ConfigHdr>.
444 // Note: if only one Storage is used, then this checking could be skipped.
446 if (!HiiIsConfigHdrMatch (Configuration
, &mFormSetGuid
, VariableName
)) {
447 *Progress
= Configuration
;
448 return EFI_NOT_FOUND
;
452 // Get Buffer Storage data from EFI variable
454 BufferSize
= sizeof (DRIVER_SAMPLE_CONFIGURATION
);
455 Status
= gRT
->GetVariable (
460 &PrivateData
->Configuration
462 if (EFI_ERROR (Status
)) {
467 // Convert <ConfigResp> to buffer data by helper function ConfigToBlock()
469 BufferSize
= sizeof (DRIVER_SAMPLE_CONFIGURATION
);
470 Status
= HiiConfigRouting
->ConfigToBlock (
473 (UINT8
*) &PrivateData
->Configuration
,
477 if (EFI_ERROR (Status
)) {
482 // Store Buffer Storage back to EFI variable
484 Status
= gRT
->SetVariable(
487 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
,
488 sizeof (DRIVER_SAMPLE_CONFIGURATION
),
489 &PrivateData
->Configuration
497 This function processes the results of changes in configuration.
499 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
500 @param Action Specifies the type of action taken by the browser.
501 @param QuestionId A unique value which is sent to the original
502 exporting driver so that it can identify the type
504 @param Type The type of value for the question.
505 @param Value A pointer to the data being sent to the original
507 @param ActionRequest On return, points to the action requested by the
510 @retval EFI_SUCCESS The callback successfully handled the action.
511 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the
512 variable and its data.
513 @retval EFI_DEVICE_ERROR The variable could not be saved.
514 @retval EFI_UNSUPPORTED The specified Action is not supported by the
521 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
522 IN EFI_BROWSER_ACTION Action
,
523 IN EFI_QUESTION_ID QuestionId
,
525 IN EFI_IFR_TYPE_VALUE
*Value
,
526 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest
529 DRIVER_SAMPLE_PRIVATE_DATA
*PrivateData
;
532 VOID
*StartOpCodeHandle
;
533 VOID
*OptionsOpCodeHandle
;
534 EFI_IFR_GUID_LABEL
*StartLabel
;
535 VOID
*EndOpCodeHandle
;
536 EFI_IFR_GUID_LABEL
*EndLabel
;
538 if ((Value
== NULL
) || (ActionRequest
== NULL
)) {
539 return EFI_INVALID_PARAMETER
;
542 Status
= EFI_SUCCESS
;
543 PrivateData
= DRIVER_SAMPLE_PRIVATE_FROM_THIS (This
);
545 switch (QuestionId
) {
548 // Initialize the container for dynamic opcodes
550 StartOpCodeHandle
= HiiAllocateOpCodeHandle ();
551 ASSERT (StartOpCodeHandle
!= NULL
);
553 EndOpCodeHandle
= HiiAllocateOpCodeHandle ();
554 ASSERT (EndOpCodeHandle
!= NULL
);
557 // Create Hii Extend Label OpCode as the start opcode
559 StartLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (StartOpCodeHandle
, &gEfiIfrTianoGuid
, NULL
, sizeof (EFI_IFR_GUID_LABEL
));
560 StartLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
561 StartLabel
->Number
= LABEL_UPDATE1
;
564 // Create Hii Extend Label OpCode as the end opcode
566 EndLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (EndOpCodeHandle
, &gEfiIfrTianoGuid
, NULL
, sizeof (EFI_IFR_GUID_LABEL
));
567 EndLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
568 EndLabel
->Number
= LABEL_END
;
570 HiiCreateActionOpCode (
571 StartOpCodeHandle
, // Container for dynamic created opcodes
572 0x1237, // Question ID
573 STRING_TOKEN(STR_EXIT_TEXT
), // Prompt text
574 STRING_TOKEN(STR_EXIT_TEXT
), // Help text
575 EFI_IFR_FLAG_CALLBACK
, // Question flag
576 0 // Action String ID
580 // Create Option OpCode
582 OptionsOpCodeHandle
= HiiAllocateOpCodeHandle ();
583 ASSERT (OptionsOpCodeHandle
!= NULL
);
585 HiiCreateOneOfOptionOpCode (
587 STRING_TOKEN (STR_BOOT_OPTION1
),
589 EFI_IFR_NUMERIC_SIZE_1
,
593 HiiCreateOneOfOptionOpCode (
595 STRING_TOKEN (STR_BOOT_OPTION2
),
597 EFI_IFR_NUMERIC_SIZE_1
,
602 // Prepare initial value for the dynamic created oneof Question
604 PrivateData
->Configuration
.DynamicOneof
= 2;
605 Status
= gRT
->SetVariable(
608 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
,
609 sizeof (DRIVER_SAMPLE_CONFIGURATION
),
610 &PrivateData
->Configuration
613 HiiCreateOneOfOpCode (
614 StartOpCodeHandle
, // Container for dynamic created opcodes
615 0x8001, // Question ID (or call it "key")
616 CONFIGURATION_VARSTORE_ID
, // VarStore ID
617 (UINT16
) DYNAMIC_ONE_OF_VAR_OFFSET
, // Offset in Buffer Storage
618 STRING_TOKEN (STR_ONE_OF_PROMPT
), // Question prompt text
619 STRING_TOKEN (STR_ONE_OF_HELP
), // Question help text
620 EFI_IFR_FLAG_CALLBACK
, // Question flag
621 EFI_IFR_NUMERIC_SIZE_1
, // Data type of Question Value
622 OptionsOpCodeHandle
, // Option Opcode list
623 NULL
// Default Opcode is NULl
626 HiiCreateOrderedListOpCode (
627 StartOpCodeHandle
, // Container for dynamic created opcodes
628 0x8002, // Question ID
629 CONFIGURATION_VARSTORE_ID
, // VarStore ID
630 (UINT16
) DYNAMIC_ORDERED_LIST_VAR_OFFSET
, // Offset in Buffer Storage
631 STRING_TOKEN (STR_BOOT_OPTIONS
), // Question prompt text
632 STRING_TOKEN (STR_BOOT_OPTIONS
), // Question help text
633 EFI_IFR_FLAG_RESET_REQUIRED
, // Question flag
634 0, // Ordered list flag, e.g. EFI_IFR_UNIQUE_SET
635 EFI_IFR_NUMERIC_SIZE_1
, // Data type of Question value
636 5, // Maximum container
637 OptionsOpCodeHandle
, // Option Opcode list
638 NULL
// Default Opcode is NULl
641 HiiCreateGotoOpCode (
642 StartOpCodeHandle
, // Container for dynamic created opcodes
644 STRING_TOKEN (STR_GOTO_FORM1
), // Prompt text
645 STRING_TOKEN (STR_GOTO_HELP
), // Help text
647 0x8003 // Question ID
651 PrivateData
->HiiHandle
[0], // HII handle
652 &mFormSetGuid
, // Formset GUID
654 StartOpCodeHandle
, // Label for where to insert opcodes
655 EndOpCodeHandle
// Replace data
658 HiiFreeOpCodeHandle (StartOpCodeHandle
);
659 HiiFreeOpCodeHandle (OptionsOpCodeHandle
);
664 // We will reach here once the Question is refreshed
668 // Initialize the container for dynamic opcodes
670 StartOpCodeHandle
= HiiAllocateOpCodeHandle ();
671 ASSERT (StartOpCodeHandle
!= NULL
);
674 // Create Hii Extend Label OpCode as the start opcode
676 StartLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (StartOpCodeHandle
, &gEfiIfrTianoGuid
, NULL
, sizeof (EFI_IFR_GUID_LABEL
));
677 StartLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
678 StartLabel
->Number
= LABEL_UPDATE2
;
680 HiiCreateActionOpCode (
681 StartOpCodeHandle
, // Container for dynamic created opcodes
682 0x1237, // Question ID
683 STRING_TOKEN(STR_EXIT_TEXT
), // Prompt text
684 STRING_TOKEN(STR_EXIT_TEXT
), // Help text
685 EFI_IFR_FLAG_CALLBACK
, // Question flag
686 0 // Action String ID
690 PrivateData
->HiiHandle
[0], // HII handle
691 &mFormSetGuid
, // Formset GUID
693 StartOpCodeHandle
, // Label for where to insert opcodes
697 HiiFreeOpCodeHandle (StartOpCodeHandle
);
700 // Refresh the Question value
702 PrivateData
->Configuration
.DynamicRefresh
++;
703 Status
= gRT
->SetVariable(
706 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
,
707 sizeof (DRIVER_SAMPLE_CONFIGURATION
),
708 &PrivateData
->Configuration
712 // Change an EFI Variable storage (MyEfiVar) asynchronous, this will cause
713 // the first statement in Form 3 be suppressed
716 Status
= gRT
->SetVariable(
719 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
,
727 // User press "Exit now", request Browser to exit
729 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_EXIT
;
734 // User press "Save now", request Browser to save the uncommitted data.
736 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_SUBMIT
;
741 // When try to set a new password, user will be chanlleged with old password.
742 // The Callback is responsible for validating old password input by user,
743 // If Callback return EFI_SUCCESS, it indicates validation pass.
745 switch (PrivateData
->PasswordState
) {
746 case BROWSER_STATE_VALIDATE_PASSWORD
:
747 Status
= ValidatePassword (PrivateData
, Value
->string
);
748 if (Status
== EFI_SUCCESS
) {
749 PrivateData
->PasswordState
= BROWSER_STATE_SET_PASSWORD
;
753 case BROWSER_STATE_SET_PASSWORD
:
754 Status
= SetPassword (PrivateData
, Value
->string
);
755 PrivateData
->PasswordState
= BROWSER_STATE_VALIDATE_PASSWORD
;
772 Main entry for this driver.
774 @param ImageHandle Image handle this driver.
775 @param SystemTable Pointer to SystemTable.
777 @retval EFI_SUCESS This function always complete successfully.
783 IN EFI_HANDLE ImageHandle
,
784 IN EFI_SYSTEM_TABLE
*SystemTable
788 EFI_STATUS SavedStatus
;
789 EFI_HII_PACKAGE_LIST_HEADER
*PackageList
;
790 EFI_HII_HANDLE HiiHandle
[2];
791 EFI_SCREEN_DESCRIPTOR Screen
;
792 EFI_HII_DATABASE_PROTOCOL
*HiiDatabase
;
793 EFI_HII_STRING_PROTOCOL
*HiiString
;
794 EFI_FORM_BROWSER2_PROTOCOL
*FormBrowser2
;
795 EFI_HII_CONFIG_ROUTING_PROTOCOL
*HiiConfigRouting
;
798 DRIVER_SAMPLE_CONFIGURATION
*Configuration
;
799 BOOLEAN ExtractIfrDefault
;
802 // Initialize the library and our protocol.
806 // Initialize screen dimensions for SendForm().
807 // Remove 3 characters from top and bottom
809 ZeroMem (&Screen
, sizeof (EFI_SCREEN_DESCRIPTOR
));
810 gST
->ConOut
->QueryMode (gST
->ConOut
, gST
->ConOut
->Mode
->Mode
, &Screen
.RightColumn
, &Screen
.BottomRow
);
813 Screen
.BottomRow
= Screen
.BottomRow
- 3;
816 // Initialize driver private data
818 PrivateData
= AllocatePool (sizeof (DRIVER_SAMPLE_PRIVATE_DATA
));
819 if (PrivateData
== NULL
) {
820 return EFI_OUT_OF_RESOURCES
;
823 PrivateData
->Signature
= DRIVER_SAMPLE_PRIVATE_SIGNATURE
;
825 PrivateData
->ConfigAccess
.ExtractConfig
= ExtractConfig
;
826 PrivateData
->ConfigAccess
.RouteConfig
= RouteConfig
;
827 PrivateData
->ConfigAccess
.Callback
= DriverCallback
;
828 PrivateData
->PasswordState
= BROWSER_STATE_VALIDATE_PASSWORD
;
831 // Locate Hii Database protocol
833 Status
= gBS
->LocateProtocol (&gEfiHiiDatabaseProtocolGuid
, NULL
, (VOID
**) &HiiDatabase
);
834 if (EFI_ERROR (Status
)) {
837 PrivateData
->HiiDatabase
= HiiDatabase
;
840 // Locate HiiString protocol
842 Status
= gBS
->LocateProtocol (&gEfiHiiStringProtocolGuid
, NULL
, (VOID
**) &HiiString
);
843 if (EFI_ERROR (Status
)) {
846 PrivateData
->HiiString
= HiiString
;
849 // Locate Formbrowser2 protocol
851 Status
= gBS
->LocateProtocol (&gEfiFormBrowser2ProtocolGuid
, NULL
, (VOID
**) &FormBrowser2
);
852 if (EFI_ERROR (Status
)) {
855 PrivateData
->FormBrowser2
= FormBrowser2
;
858 // Locate ConfigRouting protocol
860 Status
= gBS
->LocateProtocol (&gEfiHiiConfigRoutingProtocolGuid
, NULL
, (VOID
**) &HiiConfigRouting
);
861 if (EFI_ERROR (Status
)) {
864 PrivateData
->HiiConfigRouting
= HiiConfigRouting
;
866 Status
= gBS
->InstallMultipleProtocolInterfaces (
868 &gEfiDevicePathProtocolGuid
,
869 &mHiiVendorDevicePath0
,
870 &gEfiHiiConfigAccessProtocolGuid
,
871 &PrivateData
->ConfigAccess
,
874 ASSERT_EFI_ERROR (Status
);
876 PrivateData
->DriverHandle
[0] = DriverHandle
[0];
879 // Publish our HII data
881 PackageList
= HiiLibPreparePackageList (
887 if (PackageList
== NULL
) {
888 return EFI_OUT_OF_RESOURCES
;
891 Status
= HiiDatabase
->NewPackageList (
897 FreePool (PackageList
);
898 if (EFI_ERROR (Status
)) {
901 PrivateData
->HiiHandle
[0] = HiiHandle
[0];
904 // Publish another Fromset
906 Status
= gBS
->InstallMultipleProtocolInterfaces (
908 &gEfiDevicePathProtocolGuid
,
909 &mHiiVendorDevicePath1
,
912 ASSERT_EFI_ERROR (Status
);
914 PrivateData
->DriverHandle
[1] = DriverHandle
[1];
916 PackageList
= HiiLibPreparePackageList (
922 if (PackageList
== NULL
) {
923 return EFI_OUT_OF_RESOURCES
;
926 Status
= HiiDatabase
->NewPackageList (
932 FreePool (PackageList
);
933 if (EFI_ERROR (Status
)) {
936 PrivateData
->HiiHandle
[1] = HiiHandle
[1];
939 // Very simple example of how one would update a string that is already
940 // in the HII database
942 NewString
= L
"700 Mhz";
944 Status
= HiiLibSetString (HiiHandle
[0], STRING_TOKEN (STR_CPU_STRING2
), NewString
);
945 if (EFI_ERROR (Status
)) {
950 // Initialize configuration data
952 Configuration
= &PrivateData
->Configuration
;
953 ZeroMem (Configuration
, sizeof (DRIVER_SAMPLE_CONFIGURATION
));
956 // Try to read NV config EFI variable first
958 ExtractIfrDefault
= TRUE
;
959 BufferSize
= sizeof (DRIVER_SAMPLE_CONFIGURATION
);
960 Status
= gRT
->GetVariable (VariableName
, &mFormSetGuid
, NULL
, &BufferSize
, Configuration
);
961 if (!EFI_ERROR (Status
) && (BufferSize
== sizeof (DRIVER_SAMPLE_CONFIGURATION
))) {
962 ExtractIfrDefault
= FALSE
;
965 if (ExtractIfrDefault
) {
967 // EFI variable for NV config doesn't exit, we should build this variable
968 // based on default values stored in IFR
970 BufferSize
= sizeof (DRIVER_SAMPLE_CONFIGURATION
);
971 Status
= IfrLibExtractDefault (Configuration
, &BufferSize
, 1, VfrMyIfrNVDataDefault0000
);
973 if (!EFI_ERROR (Status
)) {
977 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
,
978 sizeof (DRIVER_SAMPLE_CONFIGURATION
),
984 SavedStatus
= EFI_SUCCESS
;
987 // Default this driver is built into Flash device image,
988 // the following code doesn't run.
992 // Example of how to display only the item we sent to HII
993 // When this driver is not built into Flash device image,
994 // it need to call SendForm to show front page by itself.
996 if (DISPLAY_ONLY_MY_ITEM
<= 1) {
998 // Have the browser pull out our copy of the data, and only display our data
1000 Status
= FormBrowser2
->SendForm (
1002 &(HiiHandle
[DISPLAY_ONLY_MY_ITEM
]),
1009 SavedStatus
= Status
;
1011 Status
= HiiDatabase
->RemovePackageList (HiiDatabase
, HiiHandle
[0]);
1012 if (EFI_ERROR (Status
)) {
1016 Status
= HiiDatabase
->RemovePackageList (HiiDatabase
, HiiHandle
[1]);
1017 if (EFI_ERROR (Status
)) {
1026 Unloads the application and its installed protocol.
1028 @param[in] ImageHandle Handle that identifies the image to be unloaded.
1030 @retval EFI_SUCCESS The image has been unloaded.
1034 DriverSampleUnload (
1035 IN EFI_HANDLE ImageHandle
1038 if (DriverHandle
[0] != NULL
) {
1039 gBS
->UninstallMultipleProtocolInterfaces (
1041 &gEfiDevicePathProtocolGuid
,
1042 &mHiiVendorDevicePath0
,
1043 &gEfiHiiConfigAccessProtocolGuid
,
1044 &PrivateData
->ConfigAccess
,
1049 if (DriverHandle
[1] != NULL
) {
1050 gBS
->UninstallMultipleProtocolInterfaces (
1052 &gEfiDevicePathProtocolGuid
,
1053 &mHiiVendorDevicePath1
,
1058 if (PrivateData
!= NULL
) {
1059 FreePool (PrivateData
);