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 - 2013, 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
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 CHAR16 VariableName
[] = L
"MyIfrNVData";
22 CHAR16 MyEfiVar
[] = L
"MyEfiVar";
23 EFI_HANDLE DriverHandle
[2] = {NULL
, NULL
};
24 DRIVER_SAMPLE_PRIVATE_DATA
*PrivateData
= NULL
;
27 HII_VENDOR_DEVICE_PATH mHiiVendorDevicePath0
= {
33 (UINT8
) (sizeof (VENDOR_DEVICE_PATH
)),
34 (UINT8
) ((sizeof (VENDOR_DEVICE_PATH
)) >> 8)
37 DRIVER_SAMPLE_FORMSET_GUID
41 END_ENTIRE_DEVICE_PATH_SUBTYPE
,
43 (UINT8
) (END_DEVICE_PATH_LENGTH
),
44 (UINT8
) ((END_DEVICE_PATH_LENGTH
) >> 8)
49 HII_VENDOR_DEVICE_PATH mHiiVendorDevicePath1
= {
55 (UINT8
) (sizeof (VENDOR_DEVICE_PATH
)),
56 (UINT8
) ((sizeof (VENDOR_DEVICE_PATH
)) >> 8)
59 DRIVER_SAMPLE_INVENTORY_GUID
63 END_ENTIRE_DEVICE_PATH_SUBTYPE
,
65 (UINT8
) (END_DEVICE_PATH_LENGTH
),
66 (UINT8
) ((END_DEVICE_PATH_LENGTH
) >> 8)
72 Add empty function for event process function.
74 @param Event The Event need to be process
75 @param Context The context of the event.
80 DriverSampleInternalEmptyFunction (
88 Notification function for keystrokes.
90 @param[in] KeyData The key that was pressed.
92 @retval EFI_SUCCESS The operation was successful.
97 IN EFI_KEY_DATA
*KeyData
100 gBS
->SignalEvent (mEvent
);
106 Function to start monitoring for CTRL-C using SimpleTextInputEx.
108 @retval EFI_SUCCESS The feature is enabled.
109 @retval EFI_OUT_OF_RESOURCES There is not enough mnemory available.
113 InternalStartMonitor(
117 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
118 EFI_KEY_DATA KeyData
;
123 EFI_HANDLE NotifyHandle
;
125 Status
= gBS
->LocateHandleBuffer (
127 &gEfiSimpleTextInputExProtocolGuid
,
132 for (HandleIndex
= 0; HandleIndex
< HandleCount
; HandleIndex
++) {
133 Status
= gBS
->HandleProtocol (Handles
[HandleIndex
], &gEfiSimpleTextInputExProtocolGuid
, (VOID
**) &SimpleEx
);
134 ASSERT_EFI_ERROR (Status
);
136 KeyData
.KeyState
.KeyToggleState
= 0;
137 KeyData
.Key
.ScanCode
= 0;
138 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
139 KeyData
.Key
.UnicodeChar
= L
'c';
141 Status
= SimpleEx
->RegisterKeyNotify(
144 NotificationFunction
,
146 if (EFI_ERROR (Status
)) {
150 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
151 Status
= SimpleEx
->RegisterKeyNotify(
154 NotificationFunction
,
156 if (EFI_ERROR (Status
)) {
165 Function to stop monitoring for CTRL-C using SimpleTextInputEx.
167 @retval EFI_SUCCESS The feature is enabled.
168 @retval EFI_OUT_OF_RESOURCES There is not enough mnemory available.
176 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
179 EFI_KEY_DATA KeyData
;
182 EFI_HANDLE NotifyHandle
;
184 Status
= gBS
->LocateHandleBuffer (
186 &gEfiSimpleTextInputExProtocolGuid
,
191 for (HandleIndex
= 0; HandleIndex
< HandleCount
; HandleIndex
++) {
192 Status
= gBS
->HandleProtocol (Handles
[HandleIndex
], &gEfiSimpleTextInputExProtocolGuid
, (VOID
**) &SimpleEx
);
193 ASSERT_EFI_ERROR (Status
);
195 KeyData
.KeyState
.KeyToggleState
= 0;
196 KeyData
.Key
.ScanCode
= 0;
197 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
198 KeyData
.Key
.UnicodeChar
= L
'c';
200 Status
= SimpleEx
->RegisterKeyNotify(
203 NotificationFunction
,
205 if (!EFI_ERROR (Status
)) {
206 Status
= SimpleEx
->UnregisterKeyNotify (SimpleEx
, NotifyHandle
);
209 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
210 Status
= SimpleEx
->RegisterKeyNotify(
213 NotificationFunction
,
215 if (!EFI_ERROR (Status
)) {
216 Status
= SimpleEx
->UnregisterKeyNotify (SimpleEx
, NotifyHandle
);
224 Encode the password using a simple algorithm.
226 @param Password The string to be encoded.
227 @param MaxSize The size of the string.
241 Key
= L
"MAR10648567";
242 Buffer
= AllocateZeroPool (MaxSize
);
243 ASSERT (Buffer
!= NULL
);
245 for (Index
= 0; Key
[Index
] != 0; Index
++) {
246 for (Loop
= 0; Loop
< (UINT8
) (MaxSize
/ 2); Loop
++) {
247 Buffer
[Loop
] = (CHAR16
) (Password
[Loop
] ^ Key
[Index
]);
251 CopyMem (Password
, Buffer
, MaxSize
);
258 Validate the user's password.
260 @param PrivateData This driver's private context data.
261 @param StringId The user's input.
263 @retval EFI_SUCCESS The user's input matches the password.
264 @retval EFI_NOT_READY The user's input does not match the password.
268 IN DRIVER_SAMPLE_PRIVATE_DATA
*PrivateData
,
269 IN EFI_STRING_ID StringId
275 UINTN PasswordMaxSize
;
277 CHAR16
*EncodedPassword
;
281 // Get encoded password first
283 BufferSize
= sizeof (DRIVER_SAMPLE_CONFIGURATION
);
284 Status
= gRT
->GetVariable (
286 &gDriverSampleFormSetGuid
,
289 &PrivateData
->Configuration
291 if (EFI_ERROR (Status
)) {
293 // Old password not exist, prompt for new password
299 PasswordMaxSize
= sizeof (PrivateData
->Configuration
.WhatIsThePassword2
);
301 // Check whether we have any old password set
303 for (Index
= 0; Index
< PasswordMaxSize
/ sizeof (UINT16
); Index
++) {
304 if (PrivateData
->Configuration
.WhatIsThePassword2
[Index
] != 0) {
311 // Old password not exist, return EFI_SUCCESS to prompt for new password
317 // Get user input password
319 Password
= HiiGetString (PrivateData
->HiiHandle
[0], StringId
, NULL
);
320 if (Password
== NULL
) {
321 return EFI_NOT_READY
;
323 if (StrSize (Password
) > PasswordMaxSize
) {
325 return EFI_NOT_READY
;
329 // Validate old password
331 EncodedPassword
= AllocateZeroPool (PasswordMaxSize
);
332 ASSERT (EncodedPassword
!= NULL
);
333 StrnCpy (EncodedPassword
, Password
, StrLen (Password
));
334 EncodePassword (EncodedPassword
, StrLen (EncodedPassword
) * sizeof (CHAR16
));
335 if (CompareMem (EncodedPassword
, PrivateData
->Configuration
.WhatIsThePassword2
, PasswordMaxSize
) != 0) {
337 // Old password mismatch, return EFI_NOT_READY to prompt for error message
339 Status
= EFI_NOT_READY
;
341 Status
= EFI_SUCCESS
;
345 FreePool (EncodedPassword
);
351 Encode the password using a simple algorithm.
353 @param PrivateData This driver's private context data.
354 @param StringId The password from User.
356 @retval EFI_SUCESS The operation is successful.
357 @return Other value if gRT->SetVariable () fails.
362 IN DRIVER_SAMPLE_PRIVATE_DATA
*PrivateData
,
363 IN EFI_STRING_ID StringId
368 CHAR16
*TempPassword
;
370 DRIVER_SAMPLE_CONFIGURATION
*Configuration
;
374 // Get Buffer Storage data from EFI variable
376 BufferSize
= sizeof (DRIVER_SAMPLE_CONFIGURATION
);
377 Status
= gRT
->GetVariable (
379 &gDriverSampleFormSetGuid
,
382 &PrivateData
->Configuration
384 if (EFI_ERROR (Status
)) {
389 // Get user input password
391 Password
= &PrivateData
->Configuration
.WhatIsThePassword2
[0];
392 PasswordSize
= sizeof (PrivateData
->Configuration
.WhatIsThePassword2
);
393 ZeroMem (Password
, PasswordSize
);
395 TempPassword
= HiiGetString (PrivateData
->HiiHandle
[0], StringId
, NULL
);
396 if (TempPassword
== NULL
) {
397 return EFI_NOT_READY
;
399 if (StrSize (TempPassword
) > PasswordSize
) {
400 FreePool (TempPassword
);
401 return EFI_NOT_READY
;
403 StrnCpy (Password
, TempPassword
, StrLen (TempPassword
));
404 FreePool (TempPassword
);
407 // Retrive uncommitted data from Browser
409 Configuration
= AllocateZeroPool (sizeof (DRIVER_SAMPLE_CONFIGURATION
));
410 ASSERT (Configuration
!= NULL
);
411 if (HiiGetBrowserData (&gDriverSampleFormSetGuid
, VariableName
, sizeof (DRIVER_SAMPLE_CONFIGURATION
), (UINT8
*) Configuration
)) {
413 // Update password's clear text in the screen
415 CopyMem (Configuration
->PasswordClearText
, Password
, StrSize (Password
));
418 // Update uncommitted data of Browser
421 &gDriverSampleFormSetGuid
,
423 sizeof (DRIVER_SAMPLE_CONFIGURATION
),
424 (UINT8
*) Configuration
,
430 // Free Configuration Buffer
432 FreePool (Configuration
);
438 EncodePassword (Password
, StrLen (Password
) * 2);
439 Status
= gRT
->SetVariable(
441 &gDriverSampleFormSetGuid
,
442 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
,
443 sizeof (DRIVER_SAMPLE_CONFIGURATION
),
444 &PrivateData
->Configuration
450 Update names of Name/Value storage to current language.
452 @param PrivateData Points to the driver private data.
454 @retval EFI_SUCCESS All names are successfully updated.
455 @retval EFI_NOT_FOUND Failed to get Name from HII database.
460 IN DRIVER_SAMPLE_PRIVATE_DATA
*PrivateData
466 // Get Name/Value name string of current language
468 for (Index
= 0; Index
< NAME_VALUE_NAME_NUMBER
; Index
++) {
469 PrivateData
->NameValueName
[Index
] = HiiGetString (
470 PrivateData
->HiiHandle
[0],
471 PrivateData
->NameStringId
[Index
],
474 if (PrivateData
->NameValueName
[Index
] == NULL
) {
475 return EFI_NOT_FOUND
;
484 Get the value of <Number> in <BlockConfig> format, i.e. the value of OFFSET
486 <BlockConfig> ::= 'OFFSET='<Number>&'WIDTH='<Number>&'VALUE'=<Number>
488 This is a internal function.
490 @param StringPtr String in <BlockConfig> format and points to the
491 first character of <Number>.
492 @param Number The output value. Caller takes the responsibility
494 @param Len Length of the <Number>, in characters.
496 @retval EFI_OUT_OF_RESOURCES Insufficient resources to store neccessary
498 @retval EFI_SUCCESS Value of <Number> is outputted in Number
504 IN EFI_STRING StringPtr
,
518 if (StringPtr
== NULL
|| *StringPtr
== L
'\0' || Number
== NULL
|| Len
== NULL
) {
519 return EFI_INVALID_PARAMETER
;
525 while (*StringPtr
!= L
'\0' && *StringPtr
!= L
'&') {
528 *Len
= StringPtr
- TmpPtr
;
531 Str
= (EFI_STRING
) AllocateZeroPool (Length
* sizeof (CHAR16
));
533 Status
= EFI_OUT_OF_RESOURCES
;
536 CopyMem (Str
, TmpPtr
, *Len
* sizeof (CHAR16
));
537 *(Str
+ *Len
) = L
'\0';
539 Length
= (Length
+ 1) / 2;
540 Buf
= (UINT8
*) AllocateZeroPool (Length
);
542 Status
= EFI_OUT_OF_RESOURCES
;
547 ZeroMem (TemStr
, sizeof (TemStr
));
548 for (Index
= 0; Index
< Length
; Index
++) {
549 TemStr
[0] = Str
[Length
- Index
- 1];
550 DigitUint8
= (UINT8
) StrHexToUint64 (TemStr
);
551 if ((Index
& 1) == 0) {
552 Buf
[Index
/2] = DigitUint8
;
554 Buf
[Index
/2] = (UINT8
) ((DigitUint8
<< 4) + Buf
[Index
/2]);
559 Status
= EFI_SUCCESS
;
570 Create altcfg string.
572 @param Result The request result string.
573 @param ConfigHdr The request head info. <ConfigHdr> format.
574 @param Offset The offset of the parameter int he structure.
575 @param Width The width of the parameter.
578 @retval The string with altcfg info append at the end.
582 IN EFI_STRING Result
,
583 IN EFI_STRING ConfigHdr
,
588 EFI_STRING StringPtr
;
592 NewLen
= StrLen (Result
);
594 // String Len = ConfigResp + AltConfig + AltConfig + 1("\0")
596 NewLen
= (NewLen
+ ((1 + StrLen (ConfigHdr
) + 8 + 4) + (8 + 4 + 7 + 4 + 7 + 4)) * 2 + 1) * sizeof (CHAR16
);
597 StringPtr
= AllocateZeroPool (NewLen
);
598 if (StringPtr
== NULL
) {
603 if (Result
!= NULL
) {
604 StrCpy (StringPtr
, Result
);
605 StringPtr
+= StrLen (Result
);
611 (1 + StrLen (ConfigHdr
) + 8 + 4 + 1) * sizeof (CHAR16
),
614 EFI_HII_DEFAULT_CLASS_STANDARD
616 StringPtr
+= StrLen (StringPtr
);
620 (8 + 4 + 7 + 4 + 7 + 4 + 1) * sizeof (CHAR16
),
621 L
"&OFFSET=%04x&WIDTH=%04x&VALUE=%04x",
624 DEFAULT_CLASS_STANDARD_VALUE
626 StringPtr
+= StrLen (StringPtr
);
630 (1 + StrLen (ConfigHdr
) + 8 + 4 + 1) * sizeof (CHAR16
),
633 EFI_HII_DEFAULT_CLASS_MANUFACTURING
635 StringPtr
+= StrLen (StringPtr
);
639 (8 + 4 + 7 + 4 + 7 + 4 + 1) * sizeof (CHAR16
),
640 L
"&OFFSET=%04x&WIDTH=%04x&VALUE=%04x",
643 DEFAULT_CLASS_MANUFACTURING_VALUE
645 StringPtr
+= StrLen (StringPtr
);
651 Check whether need to add the altcfg string. if need to add, add the altcfg
654 @param RequestResult The request result string.
655 @param ConfigRequestHdr The request head info. <ConfigHdr> format.
660 IN OUT EFI_STRING
*RequestResult
,
661 IN EFI_STRING ConfigRequestHdr
664 EFI_STRING StringPtr
;
674 StringPtr
= *RequestResult
;
675 StringPtr
= StrStr (StringPtr
, L
"OFFSET");
676 BlockSize
= sizeof (DRIVER_SAMPLE_CONFIGURATION
);
677 ValueOffset
= OFFSET_OF (DRIVER_SAMPLE_CONFIGURATION
, GetDefaultValueFromAccess
);
678 ValueWidth
= sizeof (((DRIVER_SAMPLE_CONFIGURATION
*)0)->GetDefaultValueFromAccess
);
680 if (StringPtr
== NULL
) {
684 while (*StringPtr
!= 0 && StrnCmp (StringPtr
, L
"OFFSET=", StrLen (L
"OFFSET=")) == 0) {
685 StringPtr
+= StrLen (L
"OFFSET=");
689 Status
= GetValueOfNumber (StringPtr
, &TmpBuffer
, &Length
);
690 if (EFI_ERROR (Status
)) {
697 (((Length
+ 1) / 2) < sizeof (UINTN
)) ? ((Length
+ 1) / 2) : sizeof (UINTN
)
699 FreePool (TmpBuffer
);
702 if (StrnCmp (StringPtr
, L
"&WIDTH=", StrLen (L
"&WIDTH=")) != 0) {
705 StringPtr
+= StrLen (L
"&WIDTH=");
710 Status
= GetValueOfNumber (StringPtr
, &TmpBuffer
, &Length
);
711 if (EFI_ERROR (Status
)) {
718 (((Length
+ 1) / 2) < sizeof (UINTN
)) ? ((Length
+ 1) / 2) : sizeof (UINTN
)
720 FreePool (TmpBuffer
);
723 if (StrnCmp (StringPtr
, L
"&VALUE=", StrLen (L
"&VALUE=")) != 0) {
726 StringPtr
+= StrLen (L
"&VALUE=");
731 Status
= GetValueOfNumber (StringPtr
, &TmpBuffer
, &Length
);
732 if (EFI_ERROR (Status
)) {
738 // Calculate Value and convert it to hex string.
740 if (Offset
+ Width
> BlockSize
) {
744 if (Offset
<= ValueOffset
&& Offset
+ Width
>= ValueOffset
+ ValueWidth
) {
745 *RequestResult
= CreateAltCfgString(*RequestResult
, ConfigRequestHdr
, ValueOffset
, ValueWidth
);
752 This function allows a caller to extract the current configuration for one
753 or more named elements from the target driver.
755 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
756 @param Request A null-terminated Unicode string in
757 <ConfigRequest> format.
758 @param Progress On return, points to a character in the Request
759 string. Points to the string's null terminator if
760 request was successful. Points to the most recent
761 '&' before the first failing name/value pair (or
762 the beginning of the string if the failure is in
763 the first name/value pair) if the request was not
765 @param Results A null-terminated Unicode string in
766 <ConfigAltResp> format which has all values filled
767 in for the names in the Request string. String to
768 be allocated by the called function.
770 @retval EFI_SUCCESS The Results is filled with the requested values.
771 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.
772 @retval EFI_INVALID_PARAMETER Request is illegal syntax, or unknown name.
773 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this
780 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
781 IN CONST EFI_STRING Request
,
782 OUT EFI_STRING
*Progress
,
783 OUT EFI_STRING
*Results
788 DRIVER_SAMPLE_PRIVATE_DATA
*PrivateData
;
789 EFI_HII_CONFIG_ROUTING_PROTOCOL
*HiiConfigRouting
;
790 EFI_STRING ConfigRequest
;
791 EFI_STRING ConfigRequestHdr
;
797 BOOLEAN AllocatedRequest
;
799 if (Progress
== NULL
|| Results
== NULL
) {
800 return EFI_INVALID_PARAMETER
;
803 // Initialize the local variables.
805 ConfigRequestHdr
= NULL
;
806 ConfigRequest
= NULL
;
809 AllocatedRequest
= FALSE
;
811 PrivateData
= DRIVER_SAMPLE_PRIVATE_FROM_THIS (This
);
812 HiiConfigRouting
= PrivateData
->HiiConfigRouting
;
815 // Get Buffer Storage data from EFI variable.
816 // Try to get the current setting from variable.
818 BufferSize
= sizeof (DRIVER_SAMPLE_CONFIGURATION
);
819 Status
= gRT
->GetVariable (
821 &gDriverSampleFormSetGuid
,
824 &PrivateData
->Configuration
826 if (EFI_ERROR (Status
)) {
827 return EFI_NOT_FOUND
;
830 if (Request
== NULL
) {
832 // Request is set to NULL, construct full request string.
836 // Allocate and fill a buffer large enough to hold the <ConfigHdr> template
837 // followed by "&OFFSET=0&WIDTH=WWWWWWWWWWWWWWWW" followed by a Null-terminator
839 ConfigRequestHdr
= HiiConstructConfigHdr (&gDriverSampleFormSetGuid
, VariableName
, PrivateData
->DriverHandle
[0]);
840 Size
= (StrLen (ConfigRequestHdr
) + 32 + 1) * sizeof (CHAR16
);
841 ConfigRequest
= AllocateZeroPool (Size
);
842 ASSERT (ConfigRequest
!= NULL
);
843 AllocatedRequest
= TRUE
;
844 UnicodeSPrint (ConfigRequest
, Size
, L
"%s&OFFSET=0&WIDTH=%016LX", ConfigRequestHdr
, (UINT64
)BufferSize
);
845 FreePool (ConfigRequestHdr
);
846 ConfigRequestHdr
= NULL
;
849 // Check routing data in <ConfigHdr>.
850 // Note: if only one Storage is used, then this checking could be skipped.
852 if (!HiiIsConfigHdrMatch (Request
, &gDriverSampleFormSetGuid
, NULL
)) {
853 return EFI_NOT_FOUND
;
856 // Check whether request for EFI Varstore. EFI varstore get data
857 // through hii database, not support in this path.
859 if (HiiIsConfigHdrMatch(Request
, &gDriverSampleFormSetGuid
, MyEfiVar
)) {
860 return EFI_UNSUPPORTED
;
863 // Set Request to the unified request string.
865 ConfigRequest
= Request
;
867 // Check whether Request includes Request Element.
869 if (StrStr (Request
, L
"OFFSET") == NULL
) {
871 // Check Request Element does exist in Reques String
873 StrPointer
= StrStr (Request
, L
"PATH");
874 if (StrPointer
== NULL
) {
875 return EFI_INVALID_PARAMETER
;
877 if (StrStr (StrPointer
, L
"&") == NULL
) {
878 Size
= (StrLen (Request
) + 32 + 1) * sizeof (CHAR16
);
879 ConfigRequest
= AllocateZeroPool (Size
);
880 ASSERT (ConfigRequest
!= NULL
);
881 AllocatedRequest
= TRUE
;
882 UnicodeSPrint (ConfigRequest
, Size
, L
"%s&OFFSET=0&WIDTH=%016LX", Request
, (UINT64
)BufferSize
);
888 // Check if requesting Name/Value storage
890 if (StrStr (ConfigRequest
, L
"OFFSET") == NULL
) {
892 // Update Name/Value storage Names
894 Status
= LoadNameValueNames (PrivateData
);
895 if (EFI_ERROR (Status
)) {
900 // Allocate memory for <ConfigResp>, e.g. Name0=0x11, Name1=0x1234, Name2="ABCD"
901 // <Request> ::=<ConfigHdr>&Name0&Name1&Name2
902 // <ConfigResp>::=<ConfigHdr>&Name0=11&Name1=1234&Name2=0041004200430044
904 BufferSize
= (StrLen (ConfigRequest
) +
905 1 + sizeof (PrivateData
->Configuration
.NameValueVar0
) * 2 +
906 1 + sizeof (PrivateData
->Configuration
.NameValueVar1
) * 2 +
907 1 + sizeof (PrivateData
->Configuration
.NameValueVar2
) * 2 + 1) * sizeof (CHAR16
);
908 *Results
= AllocateZeroPool (BufferSize
);
909 ASSERT (*Results
!= NULL
);
910 StrCpy (*Results
, ConfigRequest
);
914 // Append value of NameValueVar0, type is UINT8
916 if ((Value
= StrStr (*Results
, PrivateData
->NameValueName
[0])) != NULL
) {
917 Value
+= StrLen (PrivateData
->NameValueName
[0]);
918 ValueStrLen
= ((sizeof (PrivateData
->Configuration
.NameValueVar0
) * 2) + 1);
919 CopyMem (Value
+ ValueStrLen
, Value
, StrSize (Value
));
921 BackupChar
= Value
[ValueStrLen
];
923 Value
+= UnicodeValueToString (
925 PREFIX_ZERO
| RADIX_HEX
,
926 PrivateData
->Configuration
.NameValueVar0
,
927 sizeof (PrivateData
->Configuration
.NameValueVar0
) * 2
933 // Append value of NameValueVar1, type is UINT16
935 if ((Value
= StrStr (*Results
, PrivateData
->NameValueName
[1])) != NULL
) {
936 Value
+= StrLen (PrivateData
->NameValueName
[1]);
937 ValueStrLen
= ((sizeof (PrivateData
->Configuration
.NameValueVar1
) * 2) + 1);
938 CopyMem (Value
+ ValueStrLen
, Value
, StrSize (Value
));
940 BackupChar
= Value
[ValueStrLen
];
942 Value
+= UnicodeValueToString (
944 PREFIX_ZERO
| RADIX_HEX
,
945 PrivateData
->Configuration
.NameValueVar1
,
946 sizeof (PrivateData
->Configuration
.NameValueVar1
) * 2
952 // Append value of NameValueVar2, type is CHAR16 *
954 if ((Value
= StrStr (*Results
, PrivateData
->NameValueName
[2])) != NULL
) {
955 Value
+= StrLen (PrivateData
->NameValueName
[2]);
956 ValueStrLen
= StrLen (PrivateData
->Configuration
.NameValueVar2
) * 4 + 1;
957 CopyMem (Value
+ ValueStrLen
, Value
, StrSize (Value
));
961 // Convert Unicode String to Config String, e.g. "ABCD" => "0041004200430044"
963 StrPointer
= (CHAR16
*) PrivateData
->Configuration
.NameValueVar2
;
964 for (; *StrPointer
!= L
'\0'; StrPointer
++) {
965 Value
+= UnicodeValueToString (Value
, PREFIX_ZERO
| RADIX_HEX
, *StrPointer
, 4);
969 Status
= EFI_SUCCESS
;
972 // Convert buffer data to <ConfigResp> by helper function BlockToConfig()
974 Status
= HiiConfigRouting
->BlockToConfig (
977 (UINT8
*) &PrivateData
->Configuration
,
982 if (!EFI_ERROR (Status
)) {
983 ConfigRequestHdr
= HiiConstructConfigHdr (&gDriverSampleFormSetGuid
, VariableName
, PrivateData
->DriverHandle
[0]);
984 AppendAltCfgString(Results
, ConfigRequestHdr
);
989 // Free the allocated config request string.
991 if (AllocatedRequest
) {
992 FreePool (ConfigRequest
);
995 if (ConfigRequestHdr
!= NULL
) {
996 FreePool (ConfigRequestHdr
);
999 // Set Progress string to the original request string.
1001 if (Request
== NULL
) {
1003 } else if (StrStr (Request
, L
"OFFSET") == NULL
) {
1004 *Progress
= Request
+ StrLen (Request
);
1012 This function processes the results of changes in configuration.
1014 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
1015 @param Configuration A null-terminated Unicode string in <ConfigResp>
1017 @param Progress A pointer to a string filled in with the offset of
1018 the most recent '&' before the first failing
1019 name/value pair (or the beginning of the string if
1020 the failure is in the first name/value pair) or
1021 the terminating NULL if all was successful.
1023 @retval EFI_SUCCESS The Results is processed successfully.
1024 @retval EFI_INVALID_PARAMETER Configuration is NULL.
1025 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this
1032 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
1033 IN CONST EFI_STRING Configuration
,
1034 OUT EFI_STRING
*Progress
1039 DRIVER_SAMPLE_PRIVATE_DATA
*PrivateData
;
1040 EFI_HII_CONFIG_ROUTING_PROTOCOL
*HiiConfigRouting
;
1049 if (Configuration
== NULL
|| Progress
== NULL
) {
1050 return EFI_INVALID_PARAMETER
;
1053 PrivateData
= DRIVER_SAMPLE_PRIVATE_FROM_THIS (This
);
1054 HiiConfigRouting
= PrivateData
->HiiConfigRouting
;
1055 *Progress
= Configuration
;
1058 // Check routing data in <ConfigHdr>.
1059 // Note: if only one Storage is used, then this checking could be skipped.
1061 if (!HiiIsConfigHdrMatch (Configuration
, &gDriverSampleFormSetGuid
, NULL
)) {
1062 return EFI_NOT_FOUND
;
1066 // Check whether request for EFI Varstore. EFI varstore get data
1067 // through hii database, not support in this path.
1069 if (HiiIsConfigHdrMatch(Configuration
, &gDriverSampleFormSetGuid
, MyEfiVar
)) {
1070 return EFI_UNSUPPORTED
;
1074 // Get Buffer Storage data from EFI variable
1076 BufferSize
= sizeof (DRIVER_SAMPLE_CONFIGURATION
);
1077 Status
= gRT
->GetVariable (
1079 &gDriverSampleFormSetGuid
,
1082 &PrivateData
->Configuration
1084 if (EFI_ERROR (Status
)) {
1089 // Check if configuring Name/Value storage
1091 if (StrStr (Configuration
, L
"OFFSET") == NULL
) {
1093 // Update Name/Value storage Names
1095 Status
= LoadNameValueNames (PrivateData
);
1096 if (EFI_ERROR (Status
)) {
1101 // Convert value for NameValueVar0
1103 if ((Value
= StrStr (Configuration
, PrivateData
->NameValueName
[0])) != NULL
) {
1107 Value
+= StrLen (PrivateData
->NameValueName
[0]);
1112 StrPtr
= StrStr (Value
, L
"&");
1113 if (StrPtr
== NULL
) {
1114 StrPtr
= Value
+ StrLen (Value
);
1117 // Convert Value to Buffer data
1119 DataBuffer
= (UINT8
*) &PrivateData
->Configuration
.NameValueVar0
;
1120 ZeroMem (TemStr
, sizeof (TemStr
));
1121 for (Index
= 0, StrPtr
--; StrPtr
>= Value
; StrPtr
--, Index
++) {
1122 TemStr
[0] = *StrPtr
;
1123 DigitUint8
= (UINT8
) StrHexToUint64 (TemStr
);
1124 if ((Index
& 1) == 0) {
1125 DataBuffer
[Index
/2] = DigitUint8
;
1127 DataBuffer
[Index
/2] = (UINT8
) ((UINT8
) (DigitUint8
<< 4) + DataBuffer
[Index
/2]);
1133 // Convert value for NameValueVar1
1135 if ((Value
= StrStr (Configuration
, PrivateData
->NameValueName
[1])) != NULL
) {
1139 Value
+= StrLen (PrivateData
->NameValueName
[1]);
1144 StrPtr
= StrStr (Value
, L
"&");
1145 if (StrPtr
== NULL
) {
1146 StrPtr
= Value
+ StrLen (Value
);
1149 // Convert Value to Buffer data
1151 DataBuffer
= (UINT8
*) &PrivateData
->Configuration
.NameValueVar1
;
1152 ZeroMem (TemStr
, sizeof (TemStr
));
1153 for (Index
= 0, StrPtr
--; StrPtr
>= Value
; StrPtr
--, Index
++) {
1154 TemStr
[0] = *StrPtr
;
1155 DigitUint8
= (UINT8
) StrHexToUint64 (TemStr
);
1156 if ((Index
& 1) == 0) {
1157 DataBuffer
[Index
/2] = DigitUint8
;
1159 DataBuffer
[Index
/2] = (UINT8
) ((UINT8
) (DigitUint8
<< 4) + DataBuffer
[Index
/2]);
1165 // Convert value for NameValueVar2
1167 if ((Value
= StrStr (Configuration
, PrivateData
->NameValueName
[2])) != NULL
) {
1171 Value
+= StrLen (PrivateData
->NameValueName
[2]);
1176 StrPtr
= StrStr (Value
, L
"&");
1177 if (StrPtr
== NULL
) {
1178 StrPtr
= Value
+ StrLen (Value
);
1181 // Convert Config String to Unicode String, e.g "0041004200430044" => "ABCD"
1183 StrBuffer
= (CHAR16
*) PrivateData
->Configuration
.NameValueVar2
;
1184 ZeroMem (TemStr
, sizeof (TemStr
));
1185 while (Value
< StrPtr
) {
1186 StrnCpy (TemStr
, Value
, 4);
1187 *(StrBuffer
++) = (CHAR16
) StrHexToUint64 (TemStr
);
1194 // Store Buffer Storage back to EFI variable
1196 Status
= gRT
->SetVariable(
1198 &gDriverSampleFormSetGuid
,
1199 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
,
1200 sizeof (DRIVER_SAMPLE_CONFIGURATION
),
1201 &PrivateData
->Configuration
1208 // Convert <ConfigResp> to buffer data by helper function ConfigToBlock()
1210 BufferSize
= sizeof (DRIVER_SAMPLE_CONFIGURATION
);
1211 Status
= HiiConfigRouting
->ConfigToBlock (
1214 (UINT8
*) &PrivateData
->Configuration
,
1218 if (EFI_ERROR (Status
)) {
1223 // Store Buffer Storage back to EFI variable
1225 Status
= gRT
->SetVariable(
1227 &gDriverSampleFormSetGuid
,
1228 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
,
1229 sizeof (DRIVER_SAMPLE_CONFIGURATION
),
1230 &PrivateData
->Configuration
1238 This function processes the results of changes in configuration.
1240 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
1241 @param Action Specifies the type of action taken by the browser.
1242 @param QuestionId A unique value which is sent to the original
1243 exporting driver so that it can identify the type
1245 @param Type The type of value for the question.
1246 @param Value A pointer to the data being sent to the original
1248 @param ActionRequest On return, points to the action requested by the
1251 @retval EFI_SUCCESS The callback successfully handled the action.
1252 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the
1253 variable and its data.
1254 @retval EFI_DEVICE_ERROR The variable could not be saved.
1255 @retval EFI_UNSUPPORTED The specified Action is not supported by the
1262 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
1263 IN EFI_BROWSER_ACTION Action
,
1264 IN EFI_QUESTION_ID QuestionId
,
1266 IN EFI_IFR_TYPE_VALUE
*Value
,
1267 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest
1270 DRIVER_SAMPLE_PRIVATE_DATA
*PrivateData
;
1272 VOID
*StartOpCodeHandle
;
1273 VOID
*OptionsOpCodeHandle
;
1274 EFI_IFR_GUID_LABEL
*StartLabel
;
1275 VOID
*EndOpCodeHandle
;
1276 EFI_IFR_GUID_LABEL
*EndLabel
;
1278 DRIVER_SAMPLE_CONFIGURATION
*Configuration
;
1279 MY_EFI_VARSTORE_DATA
*EfiData
;
1282 if (((Value
== NULL
) && (Action
!= EFI_BROWSER_ACTION_FORM_OPEN
) && (Action
!= EFI_BROWSER_ACTION_FORM_CLOSE
))||
1283 (ActionRequest
== NULL
)) {
1284 return EFI_INVALID_PARAMETER
;
1289 Status
= EFI_SUCCESS
;
1290 PrivateData
= DRIVER_SAMPLE_PRIVATE_FROM_THIS (This
);
1293 case EFI_BROWSER_ACTION_FORM_OPEN
:
1295 if (QuestionId
== 0x1234) {
1297 // Sample CallBack for UEFI FORM_OPEN action:
1298 // Add Save action into Form 3 when Form 1 is opened.
1299 // This will be done only in FORM_OPEN CallBack of question with ID 0x1234 from Form 1.
1301 PrivateData
= DRIVER_SAMPLE_PRIVATE_FROM_THIS (This
);
1304 // Initialize the container for dynamic opcodes
1306 StartOpCodeHandle
= HiiAllocateOpCodeHandle ();
1307 ASSERT (StartOpCodeHandle
!= NULL
);
1310 // Create Hii Extend Label OpCode as the start opcode
1312 StartLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (StartOpCodeHandle
, &gEfiIfrTianoGuid
, NULL
, sizeof (EFI_IFR_GUID_LABEL
));
1313 StartLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
1314 StartLabel
->Number
= LABEL_UPDATE2
;
1316 HiiCreateActionOpCode (
1317 StartOpCodeHandle
, // Container for dynamic created opcodes
1318 0x1238, // Question ID
1319 STRING_TOKEN(STR_SAVE_TEXT
), // Prompt text
1320 STRING_TOKEN(STR_SAVE_TEXT
), // Help text
1321 EFI_IFR_FLAG_CALLBACK
, // Question flag
1322 0 // Action String ID
1326 PrivateData
->HiiHandle
[0], // HII handle
1327 &gDriverSampleFormSetGuid
, // Formset GUID
1329 StartOpCodeHandle
, // Label for where to insert opcodes
1333 HiiFreeOpCodeHandle (StartOpCodeHandle
);
1336 if (QuestionId
== 0x1247) {
1337 Status
= InternalStartMonitor ();
1338 ASSERT_EFI_ERROR (Status
);
1343 case EFI_BROWSER_ACTION_FORM_CLOSE
:
1345 if (QuestionId
== 0x5678) {
1347 // Sample CallBack for UEFI FORM_CLOSE action:
1348 // Show up a pop-up to specify Form 3 will be closed when exit Form 3.
1352 EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
,
1355 L
"You are going to leave third Form!",
1356 L
"Press ESC or ENTER to continue ...",
1360 } while ((Key
.ScanCode
!= SCAN_ESC
) && (Key
.UnicodeChar
!= CHAR_CARRIAGE_RETURN
));
1363 if (QuestionId
== 0x1247) {
1364 Status
= InternalStopMonitor ();
1365 ASSERT_EFI_ERROR (Status
);
1370 case EFI_BROWSER_ACTION_RETRIEVE
:
1372 if (QuestionId
== 0x1248) {
1374 if (Type
!= EFI_IFR_TYPE_REF
) {
1375 return EFI_INVALID_PARAMETER
;
1378 Value
->ref
.FormId
= 0x3;
1384 case EFI_BROWSER_ACTION_DEFAULT_STANDARD
:
1386 switch (QuestionId
) {
1388 Value
->u8
= DEFAULT_CLASS_STANDARD_VALUE
;
1392 Status
= EFI_UNSUPPORTED
;
1398 case EFI_BROWSER_ACTION_DEFAULT_MANUFACTURING
:
1400 switch (QuestionId
) {
1402 Value
->u8
= DEFAULT_CLASS_MANUFACTURING_VALUE
;
1406 Status
= EFI_UNSUPPORTED
;
1412 case EFI_BROWSER_ACTION_CHANGING
:
1414 switch (QuestionId
) {
1417 if (Type
!= EFI_IFR_TYPE_REF
) {
1418 return EFI_INVALID_PARAMETER
;
1421 Value
->ref
.FormId
= 0x1234;
1426 // Initialize the container for dynamic opcodes
1428 StartOpCodeHandle
= HiiAllocateOpCodeHandle ();
1429 ASSERT (StartOpCodeHandle
!= NULL
);
1431 EndOpCodeHandle
= HiiAllocateOpCodeHandle ();
1432 ASSERT (EndOpCodeHandle
!= NULL
);
1435 // Create Hii Extend Label OpCode as the start opcode
1437 StartLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (StartOpCodeHandle
, &gEfiIfrTianoGuid
, NULL
, sizeof (EFI_IFR_GUID_LABEL
));
1438 StartLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
1439 StartLabel
->Number
= LABEL_UPDATE1
;
1442 // Create Hii Extend Label OpCode as the end opcode
1444 EndLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (EndOpCodeHandle
, &gEfiIfrTianoGuid
, NULL
, sizeof (EFI_IFR_GUID_LABEL
));
1445 EndLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
1446 EndLabel
->Number
= LABEL_END
;
1448 HiiCreateActionOpCode (
1449 StartOpCodeHandle
, // Container for dynamic created opcodes
1450 0x1237, // Question ID
1451 STRING_TOKEN(STR_EXIT_TEXT
), // Prompt text
1452 STRING_TOKEN(STR_EXIT_TEXT
), // Help text
1453 EFI_IFR_FLAG_CALLBACK
, // Question flag
1454 0 // Action String ID
1458 // Create Option OpCode
1460 OptionsOpCodeHandle
= HiiAllocateOpCodeHandle ();
1461 ASSERT (OptionsOpCodeHandle
!= NULL
);
1463 HiiCreateOneOfOptionOpCode (
1464 OptionsOpCodeHandle
,
1465 STRING_TOKEN (STR_BOOT_OPTION1
),
1467 EFI_IFR_NUMERIC_SIZE_1
,
1471 HiiCreateOneOfOptionOpCode (
1472 OptionsOpCodeHandle
,
1473 STRING_TOKEN (STR_BOOT_OPTION2
),
1475 EFI_IFR_NUMERIC_SIZE_1
,
1480 // Prepare initial value for the dynamic created oneof Question
1482 PrivateData
->Configuration
.DynamicOneof
= 2;
1483 Status
= gRT
->SetVariable(
1485 &gDriverSampleFormSetGuid
,
1486 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
,
1487 sizeof (DRIVER_SAMPLE_CONFIGURATION
),
1488 &PrivateData
->Configuration
1492 // Set initial vlaue of dynamic created oneof Question in Form Browser
1494 Configuration
= AllocateZeroPool (sizeof (DRIVER_SAMPLE_CONFIGURATION
));
1495 ASSERT (Configuration
!= NULL
);
1496 if (HiiGetBrowserData (&gDriverSampleFormSetGuid
, VariableName
, sizeof (DRIVER_SAMPLE_CONFIGURATION
), (UINT8
*) Configuration
)) {
1497 Configuration
->DynamicOneof
= 2;
1500 // Update uncommitted data of Browser
1503 &gDriverSampleFormSetGuid
,
1505 sizeof (DRIVER_SAMPLE_CONFIGURATION
),
1506 (UINT8
*) Configuration
,
1510 FreePool (Configuration
);
1512 HiiCreateOneOfOpCode (
1513 StartOpCodeHandle
, // Container for dynamic created opcodes
1514 0x8001, // Question ID (or call it "key")
1515 CONFIGURATION_VARSTORE_ID
, // VarStore ID
1516 (UINT16
) DYNAMIC_ONE_OF_VAR_OFFSET
, // Offset in Buffer Storage
1517 STRING_TOKEN (STR_ONE_OF_PROMPT
), // Question prompt text
1518 STRING_TOKEN (STR_ONE_OF_HELP
), // Question help text
1519 EFI_IFR_FLAG_CALLBACK
, // Question flag
1520 EFI_IFR_NUMERIC_SIZE_1
, // Data type of Question Value
1521 OptionsOpCodeHandle
, // Option Opcode list
1522 NULL
// Default Opcode is NULl
1525 HiiCreateOrderedListOpCode (
1526 StartOpCodeHandle
, // Container for dynamic created opcodes
1527 0x8002, // Question ID
1528 CONFIGURATION_VARSTORE_ID
, // VarStore ID
1529 (UINT16
) DYNAMIC_ORDERED_LIST_VAR_OFFSET
, // Offset in Buffer Storage
1530 STRING_TOKEN (STR_BOOT_OPTIONS
), // Question prompt text
1531 STRING_TOKEN (STR_BOOT_OPTIONS
), // Question help text
1532 EFI_IFR_FLAG_RESET_REQUIRED
, // Question flag
1533 0, // Ordered list flag, e.g. EFI_IFR_UNIQUE_SET
1534 EFI_IFR_NUMERIC_SIZE_1
, // Data type of Question value
1535 5, // Maximum container
1536 OptionsOpCodeHandle
, // Option Opcode list
1537 NULL
// Default Opcode is NULl
1540 HiiCreateTextOpCode (
1542 STRING_TOKEN(STR_TEXT_SAMPLE_HELP
),
1543 STRING_TOKEN(STR_TEXT_SAMPLE_HELP
),
1544 STRING_TOKEN(STR_TEXT_SAMPLE_STRING
)
1547 HiiCreateDateOpCode (
1552 STRING_TOKEN(STR_DATE_SAMPLE_HELP
),
1553 STRING_TOKEN(STR_DATE_SAMPLE_HELP
),
1555 QF_DATE_STORAGE_TIME
,
1559 HiiCreateTimeOpCode (
1564 STRING_TOKEN(STR_TIME_SAMPLE_HELP
),
1565 STRING_TOKEN(STR_TIME_SAMPLE_HELP
),
1567 QF_TIME_STORAGE_TIME
,
1571 HiiCreateGotoOpCode (
1572 StartOpCodeHandle
, // Container for dynamic created opcodes
1573 1, // Target Form ID
1574 STRING_TOKEN (STR_GOTO_FORM1
), // Prompt text
1575 STRING_TOKEN (STR_GOTO_HELP
), // Help text
1577 0x8003 // Question ID
1581 PrivateData
->HiiHandle
[0], // HII handle
1582 &gDriverSampleFormSetGuid
, // Formset GUID
1584 StartOpCodeHandle
, // Label for where to insert opcodes
1585 EndOpCodeHandle
// Replace data
1588 HiiFreeOpCodeHandle (StartOpCodeHandle
);
1589 HiiFreeOpCodeHandle (OptionsOpCodeHandle
);
1590 HiiFreeOpCodeHandle (EndOpCodeHandle
);
1596 // We will reach here once the Question is refreshed
1600 // Initialize the container for dynamic opcodes
1602 StartOpCodeHandle
= HiiAllocateOpCodeHandle ();
1603 ASSERT (StartOpCodeHandle
!= NULL
);
1606 // Create Hii Extend Label OpCode as the start opcode
1608 StartLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (StartOpCodeHandle
, &gEfiIfrTianoGuid
, NULL
, sizeof (EFI_IFR_GUID_LABEL
));
1609 StartLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
1610 if (QuestionId
== 0x5678) {
1611 StartLabel
->Number
= LABEL_UPDATE2
;
1613 PrivateData
->Configuration
.DynamicRefresh
++;
1614 } else if (QuestionId
== 0x1247 ) {
1615 StartLabel
->Number
= LABEL_UPDATE3
;
1617 PrivateData
->Configuration
.RefreshGuidCount
++;
1620 HiiCreateActionOpCode (
1621 StartOpCodeHandle
, // Container for dynamic created opcodes
1622 0x1237, // Question ID
1623 STRING_TOKEN(STR_EXIT_TEXT
), // Prompt text
1624 STRING_TOKEN(STR_EXIT_TEXT
), // Help text
1625 EFI_IFR_FLAG_CALLBACK
, // Question flag
1626 0 // Action String ID
1630 PrivateData
->HiiHandle
[0], // HII handle
1631 &gDriverSampleFormSetGuid
, // Formset GUID
1633 StartOpCodeHandle
, // Label for where to insert opcodes
1637 HiiFreeOpCodeHandle (StartOpCodeHandle
);
1640 // Refresh the Question value
1642 Status
= gRT
->SetVariable(
1644 &gDriverSampleFormSetGuid
,
1645 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
,
1646 sizeof (DRIVER_SAMPLE_CONFIGURATION
),
1647 &PrivateData
->Configuration
1650 if (QuestionId
== 0x5678) {
1652 // Update uncommitted data of Browser
1654 EfiData
= AllocateZeroPool (sizeof (MY_EFI_VARSTORE_DATA
));
1655 ASSERT (EfiData
!= NULL
);
1656 if (HiiGetBrowserData (&gDriverSampleFormSetGuid
, MyEfiVar
, sizeof (MY_EFI_VARSTORE_DATA
), (UINT8
*) EfiData
)) {
1657 EfiData
->Field8
= 111;
1659 &gDriverSampleFormSetGuid
,
1661 sizeof (MY_EFI_VARSTORE_DATA
),
1672 // Only used to update the state.
1674 if ((Type
== EFI_IFR_TYPE_STRING
) && (Value
->string
== 0) &&
1675 (PrivateData
->PasswordState
== BROWSER_STATE_SET_PASSWORD
)) {
1676 PrivateData
->PasswordState
= BROWSER_STATE_VALIDATE_PASSWORD
;
1677 return EFI_INVALID_PARAMETER
;
1681 // When try to set a new password, user will be chanlleged with old password.
1682 // The Callback is responsible for validating old password input by user,
1683 // If Callback return EFI_SUCCESS, it indicates validation pass.
1685 switch (PrivateData
->PasswordState
) {
1686 case BROWSER_STATE_VALIDATE_PASSWORD
:
1687 Status
= ValidatePassword (PrivateData
, Value
->string
);
1688 if (Status
== EFI_SUCCESS
) {
1689 PrivateData
->PasswordState
= BROWSER_STATE_SET_PASSWORD
;
1693 case BROWSER_STATE_SET_PASSWORD
:
1694 Status
= SetPassword (PrivateData
, Value
->string
);
1695 PrivateData
->PasswordState
= BROWSER_STATE_VALIDATE_PASSWORD
;
1710 case EFI_BROWSER_ACTION_CHANGED
:
1711 switch (QuestionId
) {
1714 // User press "Exit now", request Browser to exit
1716 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_EXIT
;
1721 // User press "Save now", request Browser to save the uncommitted data.
1723 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_SUBMIT
;
1729 // User press "Submit current form and Exit now", request Browser to submit current form and exit
1731 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_FORM_SUBMIT_EXIT
;
1736 // User press "Discard current form now", request Browser to discard the uncommitted data.
1738 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD
;
1743 // User press "Submit current form now", request Browser to save the uncommitted data.
1745 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_FORM_APPLY
;
1751 // User press "Discard current form and Exit now", request Browser to discard the uncommitted data and exit.
1753 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD_EXIT
;
1762 Status
= EFI_UNSUPPORTED
;
1770 Main entry for this driver.
1772 @param ImageHandle Image handle this driver.
1773 @param SystemTable Pointer to SystemTable.
1775 @retval EFI_SUCESS This function always complete successfully.
1781 IN EFI_HANDLE ImageHandle
,
1782 IN EFI_SYSTEM_TABLE
*SystemTable
1786 EFI_HII_HANDLE HiiHandle
[2];
1787 EFI_SCREEN_DESCRIPTOR Screen
;
1788 EFI_HII_DATABASE_PROTOCOL
*HiiDatabase
;
1789 EFI_HII_STRING_PROTOCOL
*HiiString
;
1790 EFI_FORM_BROWSER2_PROTOCOL
*FormBrowser2
;
1791 EFI_HII_CONFIG_ROUTING_PROTOCOL
*HiiConfigRouting
;
1794 DRIVER_SAMPLE_CONFIGURATION
*Configuration
;
1796 EFI_STRING ConfigRequestHdr
;
1797 EFI_STRING NameRequestHdr
;
1798 MY_EFI_VARSTORE_DATA
*VarStoreConfig
;
1799 EFI_INPUT_KEY HotKey
;
1800 EFI_FORM_BROWSER_EXTENSION_PROTOCOL
*FormBrowserEx
;
1803 // Initialize the local variables.
1805 ConfigRequestHdr
= NULL
;
1809 // Initialize screen dimensions for SendForm().
1810 // Remove 3 characters from top and bottom
1812 ZeroMem (&Screen
, sizeof (EFI_SCREEN_DESCRIPTOR
));
1813 gST
->ConOut
->QueryMode (gST
->ConOut
, gST
->ConOut
->Mode
->Mode
, &Screen
.RightColumn
, &Screen
.BottomRow
);
1816 Screen
.BottomRow
= Screen
.BottomRow
- 3;
1819 // Initialize driver private data
1821 PrivateData
= AllocateZeroPool (sizeof (DRIVER_SAMPLE_PRIVATE_DATA
));
1822 if (PrivateData
== NULL
) {
1823 return EFI_OUT_OF_RESOURCES
;
1826 PrivateData
->Signature
= DRIVER_SAMPLE_PRIVATE_SIGNATURE
;
1828 PrivateData
->ConfigAccess
.ExtractConfig
= ExtractConfig
;
1829 PrivateData
->ConfigAccess
.RouteConfig
= RouteConfig
;
1830 PrivateData
->ConfigAccess
.Callback
= DriverCallback
;
1831 PrivateData
->PasswordState
= BROWSER_STATE_VALIDATE_PASSWORD
;
1834 // Locate Hii Database protocol
1836 Status
= gBS
->LocateProtocol (&gEfiHiiDatabaseProtocolGuid
, NULL
, (VOID
**) &HiiDatabase
);
1837 if (EFI_ERROR (Status
)) {
1840 PrivateData
->HiiDatabase
= HiiDatabase
;
1843 // Locate HiiString protocol
1845 Status
= gBS
->LocateProtocol (&gEfiHiiStringProtocolGuid
, NULL
, (VOID
**) &HiiString
);
1846 if (EFI_ERROR (Status
)) {
1849 PrivateData
->HiiString
= HiiString
;
1852 // Locate Formbrowser2 protocol
1854 Status
= gBS
->LocateProtocol (&gEfiFormBrowser2ProtocolGuid
, NULL
, (VOID
**) &FormBrowser2
);
1855 if (EFI_ERROR (Status
)) {
1858 PrivateData
->FormBrowser2
= FormBrowser2
;
1861 // Locate ConfigRouting protocol
1863 Status
= gBS
->LocateProtocol (&gEfiHiiConfigRoutingProtocolGuid
, NULL
, (VOID
**) &HiiConfigRouting
);
1864 if (EFI_ERROR (Status
)) {
1867 PrivateData
->HiiConfigRouting
= HiiConfigRouting
;
1869 Status
= gBS
->InstallMultipleProtocolInterfaces (
1871 &gEfiDevicePathProtocolGuid
,
1872 &mHiiVendorDevicePath0
,
1873 &gEfiHiiConfigAccessProtocolGuid
,
1874 &PrivateData
->ConfigAccess
,
1877 ASSERT_EFI_ERROR (Status
);
1879 PrivateData
->DriverHandle
[0] = DriverHandle
[0];
1882 // Publish our HII data
1884 HiiHandle
[0] = HiiAddPackages (
1885 &gDriverSampleFormSetGuid
,
1887 DriverSampleStrings
,
1891 if (HiiHandle
[0] == NULL
) {
1892 return EFI_OUT_OF_RESOURCES
;
1895 PrivateData
->HiiHandle
[0] = HiiHandle
[0];
1898 // Publish another Fromset
1900 Status
= gBS
->InstallMultipleProtocolInterfaces (
1902 &gEfiDevicePathProtocolGuid
,
1903 &mHiiVendorDevicePath1
,
1906 ASSERT_EFI_ERROR (Status
);
1908 PrivateData
->DriverHandle
[1] = DriverHandle
[1];
1910 HiiHandle
[1] = HiiAddPackages (
1911 &gDriverSampleInventoryGuid
,
1913 DriverSampleStrings
,
1917 if (HiiHandle
[1] == NULL
) {
1918 DriverSampleUnload (ImageHandle
);
1919 return EFI_OUT_OF_RESOURCES
;
1922 PrivateData
->HiiHandle
[1] = HiiHandle
[1];
1925 // Update the device path string.
1927 NewString
= ConvertDevicePathToText((EFI_DEVICE_PATH_PROTOCOL
*)&mHiiVendorDevicePath0
, FALSE
, FALSE
);
1928 if (HiiSetString (HiiHandle
[0], STRING_TOKEN (STR_DEVICE_PATH
), NewString
, NULL
) == 0) {
1929 DriverSampleUnload (ImageHandle
);
1930 return EFI_OUT_OF_RESOURCES
;
1932 if (NewString
!= NULL
) {
1933 FreePool (NewString
);
1937 // Very simple example of how one would update a string that is already
1938 // in the HII database
1940 NewString
= L
"700 Mhz";
1942 if (HiiSetString (HiiHandle
[0], STRING_TOKEN (STR_CPU_STRING2
), NewString
, NULL
) == 0) {
1943 DriverSampleUnload (ImageHandle
);
1944 return EFI_OUT_OF_RESOURCES
;
1947 HiiSetString (HiiHandle
[0], 0, NewString
, NULL
);
1950 // Initialize Name/Value name String ID
1952 PrivateData
->NameStringId
[0] = STR_NAME_VALUE_VAR_NAME0
;
1953 PrivateData
->NameStringId
[1] = STR_NAME_VALUE_VAR_NAME1
;
1954 PrivateData
->NameStringId
[2] = STR_NAME_VALUE_VAR_NAME2
;
1957 // Initialize configuration data
1959 Configuration
= &PrivateData
->Configuration
;
1960 ZeroMem (Configuration
, sizeof (DRIVER_SAMPLE_CONFIGURATION
));
1963 // Try to read NV config EFI variable first
1965 ConfigRequestHdr
= HiiConstructConfigHdr (&gDriverSampleFormSetGuid
, VariableName
, DriverHandle
[0]);
1966 ASSERT (ConfigRequestHdr
!= NULL
);
1968 NameRequestHdr
= HiiConstructConfigHdr (&gDriverSampleFormSetGuid
, NULL
, DriverHandle
[0]);
1969 ASSERT (NameRequestHdr
!= NULL
);
1971 BufferSize
= sizeof (DRIVER_SAMPLE_CONFIGURATION
);
1972 Status
= gRT
->GetVariable (VariableName
, &gDriverSampleFormSetGuid
, NULL
, &BufferSize
, Configuration
);
1973 if (EFI_ERROR (Status
)) {
1975 // Store zero data Buffer Storage to EFI variable
1977 Status
= gRT
->SetVariable(
1979 &gDriverSampleFormSetGuid
,
1980 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
,
1981 sizeof (DRIVER_SAMPLE_CONFIGURATION
),
1984 ASSERT (Status
== EFI_SUCCESS
);
1986 // EFI variable for NV config doesn't exit, we should build this variable
1987 // based on default values stored in IFR
1989 ActionFlag
= HiiSetToDefaults (NameRequestHdr
, EFI_HII_DEFAULT_CLASS_STANDARD
);
1990 ASSERT (ActionFlag
);
1992 ActionFlag
= HiiSetToDefaults (ConfigRequestHdr
, EFI_HII_DEFAULT_CLASS_STANDARD
);
1993 ASSERT (ActionFlag
);
1996 // EFI variable does exist and Validate Current Setting
1998 ActionFlag
= HiiValidateSettings (NameRequestHdr
);
1999 ASSERT (ActionFlag
);
2001 ActionFlag
= HiiValidateSettings (ConfigRequestHdr
);
2002 ASSERT (ActionFlag
);
2004 FreePool (ConfigRequestHdr
);
2007 // Initialize efi varstore configuration data
2009 VarStoreConfig
= &PrivateData
->VarStoreConfig
;
2010 ZeroMem (VarStoreConfig
, sizeof (MY_EFI_VARSTORE_DATA
));
2012 ConfigRequestHdr
= HiiConstructConfigHdr (&gDriverSampleFormSetGuid
, MyEfiVar
, DriverHandle
[0]);
2013 ASSERT (ConfigRequestHdr
!= NULL
);
2015 BufferSize
= sizeof (MY_EFI_VARSTORE_DATA
);
2016 Status
= gRT
->GetVariable (MyEfiVar
, &gDriverSampleFormSetGuid
, NULL
, &BufferSize
, VarStoreConfig
);
2017 if (EFI_ERROR (Status
)) {
2019 // Store zero data to EFI variable Storage.
2021 Status
= gRT
->SetVariable(
2023 &gDriverSampleFormSetGuid
,
2024 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
,
2025 sizeof (MY_EFI_VARSTORE_DATA
),
2028 ASSERT (Status
== EFI_SUCCESS
);
2030 // EFI variable for NV config doesn't exit, we should build this variable
2031 // based on default values stored in IFR
2033 ActionFlag
= HiiSetToDefaults (ConfigRequestHdr
, EFI_HII_DEFAULT_CLASS_STANDARD
);
2034 ASSERT (ActionFlag
);
2037 // EFI variable does exist and Validate Current Setting
2039 ActionFlag
= HiiValidateSettings (ConfigRequestHdr
);
2040 ASSERT (ActionFlag
);
2042 FreePool (ConfigRequestHdr
);
2044 Status
= gBS
->CreateEventEx (
2047 DriverSampleInternalEmptyFunction
,
2049 &gEfiIfrRefreshIdOpGuid
,
2052 ASSERT_EFI_ERROR (Status
);
2055 // Example of how to use BrowserEx protocol to register HotKey.
2057 Status
= gBS
->LocateProtocol (&gEfiFormBrowserExProtocolGuid
, NULL
, (VOID
**) &FormBrowserEx
);
2058 if (!EFI_ERROR (Status
)) {
2060 // First unregister the default hot key F9 and F10.
2062 HotKey
.UnicodeChar
= CHAR_NULL
;
2063 HotKey
.ScanCode
= SCAN_F9
;
2064 FormBrowserEx
->RegisterHotKey (&HotKey
, 0, 0, NULL
);
2065 HotKey
.ScanCode
= SCAN_F10
;
2066 FormBrowserEx
->RegisterHotKey (&HotKey
, 0, 0, NULL
);
2069 // Register the default HotKey F9 and F10 again.
2071 HotKey
.ScanCode
= SCAN_F10
;
2072 NewString
= HiiGetString (PrivateData
->HiiHandle
[0], STRING_TOKEN (FUNCTION_TEN_STRING
), NULL
);
2073 ASSERT (NewString
!= NULL
);
2074 FormBrowserEx
->RegisterHotKey (&HotKey
, BROWSER_ACTION_SUBMIT
, 0, NewString
);
2075 HotKey
.ScanCode
= SCAN_F9
;
2076 NewString
= HiiGetString (PrivateData
->HiiHandle
[0], STRING_TOKEN (FUNCTION_NINE_STRING
), NULL
);
2077 ASSERT (NewString
!= NULL
);
2078 FormBrowserEx
->RegisterHotKey (&HotKey
, BROWSER_ACTION_DEFAULT
, EFI_HII_DEFAULT_CLASS_STANDARD
, NewString
);
2082 // In default, this driver is built into Flash device image,
2083 // the following code doesn't run.
2087 // Example of how to display only the item we sent to HII
2088 // When this driver is not built into Flash device image,
2089 // it need to call SendForm to show front page by itself.
2091 if (DISPLAY_ONLY_MY_ITEM
<= 1) {
2093 // Have the browser pull out our copy of the data, and only display our data
2095 Status
= FormBrowser2
->SendForm (
2097 &(HiiHandle
[DISPLAY_ONLY_MY_ITEM
]),
2105 HiiRemovePackages (HiiHandle
[0]);
2107 HiiRemovePackages (HiiHandle
[1]);
2114 Unloads the application and its installed protocol.
2116 @param[in] ImageHandle Handle that identifies the image to be unloaded.
2118 @retval EFI_SUCCESS The image has been unloaded.
2122 DriverSampleUnload (
2123 IN EFI_HANDLE ImageHandle
2128 ASSERT (PrivateData
!= NULL
);
2130 if (DriverHandle
[0] != NULL
) {
2131 gBS
->UninstallMultipleProtocolInterfaces (
2133 &gEfiDevicePathProtocolGuid
,
2134 &mHiiVendorDevicePath0
,
2135 &gEfiHiiConfigAccessProtocolGuid
,
2136 &PrivateData
->ConfigAccess
,
2139 DriverHandle
[0] = NULL
;
2142 if (DriverHandle
[1] != NULL
) {
2143 gBS
->UninstallMultipleProtocolInterfaces (
2145 &gEfiDevicePathProtocolGuid
,
2146 &mHiiVendorDevicePath1
,
2149 DriverHandle
[1] = NULL
;
2152 if (PrivateData
->HiiHandle
[0] != NULL
) {
2153 HiiRemovePackages (PrivateData
->HiiHandle
[0]);
2156 if (PrivateData
->HiiHandle
[1] != NULL
) {
2157 HiiRemovePackages (PrivateData
->HiiHandle
[1]);
2160 for (Index
= 0; Index
< NAME_VALUE_NAME_NUMBER
; Index
++) {
2161 if (PrivateData
->NameValueName
[Index
] != NULL
) {
2162 FreePool (PrivateData
->NameValueName
[Index
]);
2165 FreePool (PrivateData
);
2168 gBS
->CloseEvent (mEvent
);