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
);
370 &PrivateData
->Configuration
373 if (Request
== NULL
) {
375 // Request is set to NULL, construct full request string.
379 // First Set ConfigRequestHdr string.
381 ConfigRequestHdr
= HiiConstructConfigHdr (&mFormSetGuid
, VariableName
, PrivateData
->DriverHandle
[0]);
382 ASSERT (ConfigRequestHdr
!= NULL
);
385 // Allocate and fill a buffer large enough to hold the <ConfigHdr> template
386 // followed by "&OFFSET=0&WIDTH=WWWWWWWWWWWWWWWW" followed by a Null-terminator
388 Size
= (StrLen (ConfigRequestHdr
) + 32 + 1) * sizeof (CHAR16
);
389 ConfigRequest
= AllocateZeroPool (Size
);
390 UnicodeSPrint (ConfigRequest
, Size
, L
"%s&OFFSET=0&WIDTH=%016LX", ConfigRequestHdr
, (UINT64
)BufferSize
);
391 FreePool (ConfigRequestHdr
);
393 ConfigRequest
= Request
;
397 // Check routing data in <ConfigHdr>.
398 // Note: if only one Storage is used, then this checking could be skipped.
400 if (!HiiIsConfigHdrMatch (ConfigRequest
, &mFormSetGuid
, VariableName
)) {
401 if (Request
== NULL
) {
402 FreePool (ConfigRequest
);
404 return EFI_NOT_FOUND
;
408 // Convert buffer data to <ConfigResp> by helper function BlockToConfig()
410 Status
= HiiConfigRouting
->BlockToConfig (
413 (UINT8
*) &PrivateData
->Configuration
,
419 if (Request
== NULL
) {
420 FreePool (ConfigRequest
);
428 This function processes the results of changes in configuration.
430 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
431 @param Configuration A null-terminated Unicode string in <ConfigResp>
433 @param Progress A pointer to a string filled in with the offset of
434 the most recent '&' before the first failing
435 name/value pair (or the beginning of the string if
436 the failure is in the first name/value pair) or
437 the terminating NULL if all was successful.
439 @retval EFI_SUCCESS The Results is processed successfully.
440 @retval EFI_INVALID_PARAMETER Configuration is NULL.
441 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this
448 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
449 IN CONST EFI_STRING Configuration
,
450 OUT EFI_STRING
*Progress
455 DRIVER_SAMPLE_PRIVATE_DATA
*PrivateData
;
456 EFI_HII_CONFIG_ROUTING_PROTOCOL
*HiiConfigRouting
;
458 if (Configuration
== NULL
) {
459 return EFI_INVALID_PARAMETER
;
462 PrivateData
= DRIVER_SAMPLE_PRIVATE_FROM_THIS (This
);
463 HiiConfigRouting
= PrivateData
->HiiConfigRouting
;
466 // Check routing data in <ConfigHdr>.
467 // Note: if only one Storage is used, then this checking could be skipped.
469 if (!HiiIsConfigHdrMatch (Configuration
, &mFormSetGuid
, VariableName
)) {
470 *Progress
= Configuration
;
471 return EFI_NOT_FOUND
;
475 // Get Buffer Storage data from EFI variable
477 BufferSize
= sizeof (DRIVER_SAMPLE_CONFIGURATION
);
483 &PrivateData
->Configuration
487 // Convert <ConfigResp> to buffer data by helper function ConfigToBlock()
489 BufferSize
= sizeof (DRIVER_SAMPLE_CONFIGURATION
);
490 Status
= HiiConfigRouting
->ConfigToBlock (
493 (UINT8
*) &PrivateData
->Configuration
,
497 if (EFI_ERROR (Status
)) {
502 // Store Buffer Storage back to EFI variable
504 Status
= gRT
->SetVariable(
507 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
,
508 sizeof (DRIVER_SAMPLE_CONFIGURATION
),
509 &PrivateData
->Configuration
517 This function processes the results of changes in configuration.
519 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
520 @param Action Specifies the type of action taken by the browser.
521 @param QuestionId A unique value which is sent to the original
522 exporting driver so that it can identify the type
524 @param Type The type of value for the question.
525 @param Value A pointer to the data being sent to the original
527 @param ActionRequest On return, points to the action requested by the
530 @retval EFI_SUCCESS The callback successfully handled the action.
531 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the
532 variable and its data.
533 @retval EFI_DEVICE_ERROR The variable could not be saved.
534 @retval EFI_UNSUPPORTED The specified Action is not supported by the
541 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
542 IN EFI_BROWSER_ACTION Action
,
543 IN EFI_QUESTION_ID QuestionId
,
545 IN EFI_IFR_TYPE_VALUE
*Value
,
546 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest
549 DRIVER_SAMPLE_PRIVATE_DATA
*PrivateData
;
552 VOID
*StartOpCodeHandle
;
553 VOID
*OptionsOpCodeHandle
;
554 EFI_IFR_GUID_LABEL
*StartLabel
;
555 VOID
*EndOpCodeHandle
;
556 EFI_IFR_GUID_LABEL
*EndLabel
;
558 if ((Value
== NULL
) || (ActionRequest
== NULL
)) {
559 return EFI_INVALID_PARAMETER
;
562 if ((Type
== EFI_IFR_TYPE_STRING
) && (Value
->string
== 0)) {
563 return EFI_INVALID_PARAMETER
;
567 Status
= EFI_SUCCESS
;
568 PrivateData
= DRIVER_SAMPLE_PRIVATE_FROM_THIS (This
);
570 switch (QuestionId
) {
573 // Initialize the container for dynamic opcodes
575 StartOpCodeHandle
= HiiAllocateOpCodeHandle ();
576 ASSERT (StartOpCodeHandle
!= NULL
);
578 EndOpCodeHandle
= HiiAllocateOpCodeHandle ();
579 ASSERT (EndOpCodeHandle
!= NULL
);
582 // Create Hii Extend Label OpCode as the start opcode
584 StartLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (StartOpCodeHandle
, &gEfiIfrTianoGuid
, NULL
, sizeof (EFI_IFR_GUID_LABEL
));
585 StartLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
586 StartLabel
->Number
= LABEL_UPDATE1
;
589 // Create Hii Extend Label OpCode as the end opcode
591 EndLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (EndOpCodeHandle
, &gEfiIfrTianoGuid
, NULL
, sizeof (EFI_IFR_GUID_LABEL
));
592 EndLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
593 EndLabel
->Number
= LABEL_END
;
595 HiiCreateActionOpCode (
596 StartOpCodeHandle
, // Container for dynamic created opcodes
597 0x1237, // Question ID
598 STRING_TOKEN(STR_EXIT_TEXT
), // Prompt text
599 STRING_TOKEN(STR_EXIT_TEXT
), // Help text
600 EFI_IFR_FLAG_CALLBACK
, // Question flag
601 0 // Action String ID
605 // Create Option OpCode
607 OptionsOpCodeHandle
= HiiAllocateOpCodeHandle ();
608 ASSERT (OptionsOpCodeHandle
!= NULL
);
610 HiiCreateOneOfOptionOpCode (
612 STRING_TOKEN (STR_BOOT_OPTION1
),
614 EFI_IFR_NUMERIC_SIZE_1
,
618 HiiCreateOneOfOptionOpCode (
620 STRING_TOKEN (STR_BOOT_OPTION2
),
622 EFI_IFR_NUMERIC_SIZE_1
,
627 // Prepare initial value for the dynamic created oneof Question
629 PrivateData
->Configuration
.DynamicOneof
= 2;
630 Status
= gRT
->SetVariable(
633 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
,
634 sizeof (DRIVER_SAMPLE_CONFIGURATION
),
635 &PrivateData
->Configuration
638 HiiCreateOneOfOpCode (
639 StartOpCodeHandle
, // Container for dynamic created opcodes
640 0x8001, // Question ID (or call it "key")
641 CONFIGURATION_VARSTORE_ID
, // VarStore ID
642 (UINT16
) DYNAMIC_ONE_OF_VAR_OFFSET
, // Offset in Buffer Storage
643 STRING_TOKEN (STR_ONE_OF_PROMPT
), // Question prompt text
644 STRING_TOKEN (STR_ONE_OF_HELP
), // Question help text
645 EFI_IFR_FLAG_CALLBACK
, // Question flag
646 EFI_IFR_NUMERIC_SIZE_1
, // Data type of Question Value
647 OptionsOpCodeHandle
, // Option Opcode list
648 NULL
// Default Opcode is NULl
651 HiiCreateOrderedListOpCode (
652 StartOpCodeHandle
, // Container for dynamic created opcodes
653 0x8002, // Question ID
654 CONFIGURATION_VARSTORE_ID
, // VarStore ID
655 (UINT16
) DYNAMIC_ORDERED_LIST_VAR_OFFSET
, // Offset in Buffer Storage
656 STRING_TOKEN (STR_BOOT_OPTIONS
), // Question prompt text
657 STRING_TOKEN (STR_BOOT_OPTIONS
), // Question help text
658 EFI_IFR_FLAG_RESET_REQUIRED
, // Question flag
659 0, // Ordered list flag, e.g. EFI_IFR_UNIQUE_SET
660 EFI_IFR_NUMERIC_SIZE_1
, // Data type of Question value
661 5, // Maximum container
662 OptionsOpCodeHandle
, // Option Opcode list
663 NULL
// Default Opcode is NULl
666 HiiCreateGotoOpCode (
667 StartOpCodeHandle
, // Container for dynamic created opcodes
669 STRING_TOKEN (STR_GOTO_FORM1
), // Prompt text
670 STRING_TOKEN (STR_GOTO_HELP
), // Help text
672 0x8003 // Question ID
676 PrivateData
->HiiHandle
[0], // HII handle
677 &mFormSetGuid
, // Formset GUID
679 StartOpCodeHandle
, // Label for where to insert opcodes
680 EndOpCodeHandle
// Replace data
683 HiiFreeOpCodeHandle (StartOpCodeHandle
);
684 HiiFreeOpCodeHandle (OptionsOpCodeHandle
);
689 // We will reach here once the Question is refreshed
693 // Initialize the container for dynamic opcodes
695 StartOpCodeHandle
= HiiAllocateOpCodeHandle ();
696 ASSERT (StartOpCodeHandle
!= NULL
);
699 // Create Hii Extend Label OpCode as the start opcode
701 StartLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (StartOpCodeHandle
, &gEfiIfrTianoGuid
, NULL
, sizeof (EFI_IFR_GUID_LABEL
));
702 StartLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
703 StartLabel
->Number
= LABEL_UPDATE2
;
705 HiiCreateActionOpCode (
706 StartOpCodeHandle
, // Container for dynamic created opcodes
707 0x1237, // Question ID
708 STRING_TOKEN(STR_EXIT_TEXT
), // Prompt text
709 STRING_TOKEN(STR_EXIT_TEXT
), // Help text
710 EFI_IFR_FLAG_CALLBACK
, // Question flag
711 0 // Action String ID
715 PrivateData
->HiiHandle
[0], // HII handle
716 &mFormSetGuid
, // Formset GUID
718 StartOpCodeHandle
, // Label for where to insert opcodes
722 HiiFreeOpCodeHandle (StartOpCodeHandle
);
725 // Refresh the Question value
727 PrivateData
->Configuration
.DynamicRefresh
++;
728 Status
= gRT
->SetVariable(
731 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
,
732 sizeof (DRIVER_SAMPLE_CONFIGURATION
),
733 &PrivateData
->Configuration
737 // Change an EFI Variable storage (MyEfiVar) asynchronous, this will cause
738 // the first statement in Form 3 be suppressed
741 Status
= gRT
->SetVariable(
744 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
,
752 // User press "Exit now", request Browser to exit
754 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_EXIT
;
759 // User press "Save now", request Browser to save the uncommitted data.
761 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_SUBMIT
;
766 // When try to set a new password, user will be chanlleged with old password.
767 // The Callback is responsible for validating old password input by user,
768 // If Callback return EFI_SUCCESS, it indicates validation pass.
770 switch (PrivateData
->PasswordState
) {
771 case BROWSER_STATE_VALIDATE_PASSWORD
:
772 Status
= ValidatePassword (PrivateData
, Value
->string
);
773 if (Status
== EFI_SUCCESS
) {
774 PrivateData
->PasswordState
= BROWSER_STATE_SET_PASSWORD
;
778 case BROWSER_STATE_SET_PASSWORD
:
779 Status
= SetPassword (PrivateData
, Value
->string
);
780 PrivateData
->PasswordState
= BROWSER_STATE_VALIDATE_PASSWORD
;
797 Main entry for this driver.
799 @param ImageHandle Image handle this driver.
800 @param SystemTable Pointer to SystemTable.
802 @retval EFI_SUCESS This function always complete successfully.
808 IN EFI_HANDLE ImageHandle
,
809 IN EFI_SYSTEM_TABLE
*SystemTable
813 EFI_HII_HANDLE HiiHandle
[2];
814 EFI_SCREEN_DESCRIPTOR Screen
;
815 EFI_HII_DATABASE_PROTOCOL
*HiiDatabase
;
816 EFI_HII_STRING_PROTOCOL
*HiiString
;
817 EFI_FORM_BROWSER2_PROTOCOL
*FormBrowser2
;
818 EFI_HII_CONFIG_ROUTING_PROTOCOL
*HiiConfigRouting
;
821 DRIVER_SAMPLE_CONFIGURATION
*Configuration
;
823 EFI_STRING ConfigRequestHdr
;
826 // Initialize the local variables.
828 ConfigRequestHdr
= NULL
;
831 // Initialize screen dimensions for SendForm().
832 // Remove 3 characters from top and bottom
834 ZeroMem (&Screen
, sizeof (EFI_SCREEN_DESCRIPTOR
));
835 gST
->ConOut
->QueryMode (gST
->ConOut
, gST
->ConOut
->Mode
->Mode
, &Screen
.RightColumn
, &Screen
.BottomRow
);
838 Screen
.BottomRow
= Screen
.BottomRow
- 3;
841 // Initialize driver private data
843 PrivateData
= AllocatePool (sizeof (DRIVER_SAMPLE_PRIVATE_DATA
));
844 if (PrivateData
== NULL
) {
845 return EFI_OUT_OF_RESOURCES
;
848 PrivateData
->Signature
= DRIVER_SAMPLE_PRIVATE_SIGNATURE
;
850 PrivateData
->ConfigAccess
.ExtractConfig
= ExtractConfig
;
851 PrivateData
->ConfigAccess
.RouteConfig
= RouteConfig
;
852 PrivateData
->ConfigAccess
.Callback
= DriverCallback
;
853 PrivateData
->PasswordState
= BROWSER_STATE_VALIDATE_PASSWORD
;
856 // Locate Hii Database protocol
858 Status
= gBS
->LocateProtocol (&gEfiHiiDatabaseProtocolGuid
, NULL
, (VOID
**) &HiiDatabase
);
859 if (EFI_ERROR (Status
)) {
862 PrivateData
->HiiDatabase
= HiiDatabase
;
865 // Locate HiiString protocol
867 Status
= gBS
->LocateProtocol (&gEfiHiiStringProtocolGuid
, NULL
, (VOID
**) &HiiString
);
868 if (EFI_ERROR (Status
)) {
871 PrivateData
->HiiString
= HiiString
;
874 // Locate Formbrowser2 protocol
876 Status
= gBS
->LocateProtocol (&gEfiFormBrowser2ProtocolGuid
, NULL
, (VOID
**) &FormBrowser2
);
877 if (EFI_ERROR (Status
)) {
880 PrivateData
->FormBrowser2
= FormBrowser2
;
883 // Locate ConfigRouting protocol
885 Status
= gBS
->LocateProtocol (&gEfiHiiConfigRoutingProtocolGuid
, NULL
, (VOID
**) &HiiConfigRouting
);
886 if (EFI_ERROR (Status
)) {
889 PrivateData
->HiiConfigRouting
= HiiConfigRouting
;
891 Status
= gBS
->InstallMultipleProtocolInterfaces (
893 &gEfiDevicePathProtocolGuid
,
894 &mHiiVendorDevicePath0
,
895 &gEfiHiiConfigAccessProtocolGuid
,
896 &PrivateData
->ConfigAccess
,
899 ASSERT_EFI_ERROR (Status
);
901 PrivateData
->DriverHandle
[0] = DriverHandle
[0];
904 // Publish our HII data
906 HiiHandle
[0] = HiiAddPackages (
913 if (HiiHandle
[0] == NULL
) {
914 return EFI_OUT_OF_RESOURCES
;
917 PrivateData
->HiiHandle
[0] = HiiHandle
[0];
920 // Publish another Fromset
922 Status
= gBS
->InstallMultipleProtocolInterfaces (
924 &gEfiDevicePathProtocolGuid
,
925 &mHiiVendorDevicePath1
,
928 ASSERT_EFI_ERROR (Status
);
930 PrivateData
->DriverHandle
[1] = DriverHandle
[1];
932 HiiHandle
[1] = HiiAddPackages (
939 if (HiiHandle
[1] == NULL
) {
940 return EFI_OUT_OF_RESOURCES
;
943 PrivateData
->HiiHandle
[1] = HiiHandle
[1];
946 // Very simple example of how one would update a string that is already
947 // in the HII database
949 NewString
= L
"700 Mhz";
951 if (HiiSetString (HiiHandle
[0], STRING_TOKEN (STR_CPU_STRING2
), NewString
, NULL
) == 0) {
952 return EFI_OUT_OF_RESOURCES
;
956 // Initialize configuration data
958 Configuration
= &PrivateData
->Configuration
;
959 ZeroMem (Configuration
, sizeof (DRIVER_SAMPLE_CONFIGURATION
));
962 // Try to read NV config EFI variable first
964 ConfigRequestHdr
= HiiConstructConfigHdr (&mFormSetGuid
, VariableName
, DriverHandle
[0]);
965 ASSERT (ConfigRequestHdr
!= NULL
);
967 BufferSize
= sizeof (DRIVER_SAMPLE_CONFIGURATION
);
968 Status
= gRT
->GetVariable (VariableName
, &mFormSetGuid
, NULL
, &BufferSize
, Configuration
);
969 if (EFI_ERROR (Status
)) {
971 // EFI variable for NV config doesn't exit, we should build this variable
972 // based on default values stored in IFR
974 ActionFlag
= HiiSetToDefaults (ConfigRequestHdr
, EFI_HII_DEFAULT_CLASS_STANDARD
);
978 // EFI variable does exist and Validate Current Setting
980 ActionFlag
= HiiValidateSettings (ConfigRequestHdr
);
984 FreePool (ConfigRequestHdr
);
988 // In default, this driver is built into Flash device image,
989 // the following code doesn't run.
993 // Example of how to display only the item we sent to HII
994 // When this driver is not built into Flash device image,
995 // it need to call SendForm to show front page by itself.
997 if (DISPLAY_ONLY_MY_ITEM
<= 1) {
999 // Have the browser pull out our copy of the data, and only display our data
1001 Status
= FormBrowser2
->SendForm (
1003 &(HiiHandle
[DISPLAY_ONLY_MY_ITEM
]),
1011 HiiRemovePackages (HiiHandle
[0]);
1013 HiiRemovePackages (HiiHandle
[1]);
1020 Unloads the application and its installed protocol.
1022 @param[in] ImageHandle Handle that identifies the image to be unloaded.
1024 @retval EFI_SUCCESS The image has been unloaded.
1028 DriverSampleUnload (
1029 IN EFI_HANDLE ImageHandle
1032 if (DriverHandle
[0] != NULL
) {
1033 gBS
->UninstallMultipleProtocolInterfaces (
1035 &gEfiDevicePathProtocolGuid
,
1036 &mHiiVendorDevicePath0
,
1037 &gEfiHiiConfigAccessProtocolGuid
,
1038 &PrivateData
->ConfigAccess
,
1043 if (DriverHandle
[1] != NULL
) {
1044 gBS
->UninstallMultipleProtocolInterfaces (
1046 &gEfiDevicePathProtocolGuid
,
1047 &mHiiVendorDevicePath1
,
1052 if (PrivateData
->HiiHandle
[0] != NULL
) {
1053 HiiRemovePackages (PrivateData
->HiiHandle
[0]);
1056 if (PrivateData
->HiiHandle
[1] != NULL
) {
1057 HiiRemovePackages (PrivateData
->HiiHandle
[1]);
1060 if (PrivateData
!= NULL
) {
1061 FreePool (PrivateData
);