2 Implementation of interfaces function for EFI_CONFIG_KEYWORD_HANDLER_PROTOCOL.
4 Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #include "HiiDatabase.h"
18 extern HII_DATABASE_PRIVATE_DATA mPrivate
;
21 Convert the hex UNICODE %02x encoding of a UEFI device path to binary
22 from <PathHdr> of <MultiKeywordRequest>.
24 This is a internal function.
26 @param String MultiKeywordRequest string.
27 @param DevicePathData Binary of a UEFI device path.
28 @param NextString string follow the possible PathHdr string.
30 @retval EFI_INVALID_PARAMETER The device path is not valid or the incoming parameter is invalid.
31 @retval EFI_OUT_OF_RESOURCES Lake of resources to store neccesary structures.
32 @retval EFI_SUCCESS The device path is retrieved and translated to binary format.
33 The Input string not include PathHdr section.
39 OUT UINT8
**DevicePathData
,
40 OUT EFI_STRING
*NextString
45 UINT8
*DevicePathBuffer
;
49 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
51 ASSERT (NextString
!= NULL
&& DevicePathData
!= NULL
);
54 // KeywordRequest == NULL case.
57 *DevicePathData
= NULL
;
65 if (*String
== L
'&') {
70 // Find the 'PATH=' of <PathHdr>.
72 if (StrnCmp (String
, L
"PATH=", StrLen (L
"PATH=")) != 0) {
73 if (StrnCmp (String
, L
"KEYWORD=", StrLen (L
"KEYWORD=")) != 0) {
74 return EFI_INVALID_PARAMETER
;
77 // Not include PathHdr, return success and DevicePath = NULL.
79 *DevicePathData
= NULL
;
86 // Check whether path data does exist.
88 String
+= StrLen (L
"PATH=");
90 return EFI_INVALID_PARAMETER
;
95 // The content between 'PATH=' of <ConfigHdr> and '&' of next element
96 // or '\0' (end of configuration string) is the UNICODE %02x bytes encoding
97 // of UEFI device path.
99 for (Length
= 0; *String
!= 0 && *String
!= L
'&'; String
++, Length
++);
102 // Save the return next keyword string value.
104 *NextString
= String
;
107 // Check DevicePath Length
109 if (((Length
+ 1) / 2) < sizeof (EFI_DEVICE_PATH_PROTOCOL
)) {
110 return EFI_INVALID_PARAMETER
;
114 // The data in <PathHdr> is encoded as hex UNICODE %02x bytes in the same order
115 // as the device path resides in RAM memory.
116 // Translate the data into binary.
118 DevicePathBuffer
= (UINT8
*) AllocateZeroPool ((Length
+ 1) / 2);
119 if (DevicePathBuffer
== NULL
) {
120 return EFI_OUT_OF_RESOURCES
;
124 // Convert DevicePath
126 ZeroMem (TemStr
, sizeof (TemStr
));
127 for (Index
= 0; Index
< Length
; Index
++) {
128 TemStr
[0] = PathHdr
[Index
];
129 DigitUint8
= (UINT8
) StrHexToUint64 (TemStr
);
130 if ((Index
& 1) == 0) {
131 DevicePathBuffer
[Index
/2] = DigitUint8
;
133 DevicePathBuffer
[Index
/2] = (UINT8
) ((DevicePathBuffer
[Index
/2] << 4) + DigitUint8
);
138 // Validate DevicePath
140 DevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) DevicePathBuffer
;
141 while (!IsDevicePathEnd (DevicePath
)) {
142 if ((DevicePath
->Type
== 0) || (DevicePath
->SubType
== 0) || (DevicePathNodeLength (DevicePath
) < sizeof (EFI_DEVICE_PATH_PROTOCOL
))) {
144 // Invalid device path
146 FreePool (DevicePathBuffer
);
147 return EFI_INVALID_PARAMETER
;
149 DevicePath
= NextDevicePathNode (DevicePath
);
153 // return the device path
155 *DevicePathData
= DevicePathBuffer
;
161 Get NameSpace from the input NameSpaceId string.
163 This is a internal function.
165 @param String <NameSpaceId> format string.
166 @param NameSpace Return the name space string.
167 @param NextString Return the next string follow namespace.
169 @retval EFI_SUCCESS Get the namespace string success.
170 @retval EFI_INVALID_PARAMETER The NameSpaceId string not follow spec definition.
175 IN EFI_STRING String
,
176 OUT CHAR8
**NameSpace
,
177 OUT EFI_STRING
*NextString
182 ASSERT (NameSpace
!= NULL
);
187 // Input NameSpaceId == NULL
189 if (String
== NULL
) {
191 if (NextString
!= NULL
) {
198 // Skip '&' if exist.
200 if (*String
== L
'&') {
204 if (StrnCmp (String
, L
"NAMESPACE=", StrLen (L
"NAMESPACE=")) != 0) {
205 return EFI_INVALID_PARAMETER
;
207 String
+= StrLen (L
"NAMESPACE=");
209 TmpPtr
= StrStr (String
, L
"&");
210 if (TmpPtr
!= NULL
) {
213 if (NextString
!= NULL
) {
214 *NextString
= String
+ StrLen (String
);
218 // Input NameSpace is unicode string. The language in String package is ascii string.
219 // Here will convert the unicode string to ascii and save it.
221 *NameSpace
= AllocatePool (StrLen (String
) + 1);
222 if (*NameSpace
== NULL
) {
223 return EFI_OUT_OF_RESOURCES
;
225 UnicodeStrToAsciiStr (String
, *NameSpace
);
227 if (TmpPtr
!= NULL
) {
235 Get Keyword from the input KeywordRequest string.
237 This is a internal function.
239 @param String KeywordRequestformat string.
240 @param Keyword return the extract keyword string.
241 @param NextString return the next string follow this keyword sectin.
243 @retval EFI_SUCCESS Success to get the keyword string.
244 @retval EFI_INVALID_PARAMETER Parsr the input string return error.
249 IN EFI_STRING String
,
250 OUT EFI_STRING
*Keyword
,
251 OUT EFI_STRING
*NextString
256 ASSERT ((Keyword
!= NULL
) && (NextString
!= NULL
));
261 // KeywordRequest == NULL case.
263 if (String
== NULL
) {
270 // Skip '&' if exist.
272 if (*String
== L
'&') {
276 if (StrnCmp (String
, L
"KEYWORD=", StrLen (L
"KEYWORD=")) != 0) {
277 return EFI_INVALID_PARAMETER
;
280 String
+= StrLen (L
"KEYWORD=");
282 TmpPtr
= StrStr (String
, L
"&");
283 if (TmpPtr
!= NULL
) {
286 *NextString
= String
+ StrLen (String
);
288 *Keyword
= AllocateCopyPool (StrSize (String
), String
);
289 if (*Keyword
== NULL
) {
290 return EFI_OUT_OF_RESOURCES
;
293 if (TmpPtr
!= NULL
) {
301 Get value from the input KeywordRequest string.
303 This is a internal function.
305 @param String KeywordRequestformat string.
306 @param Value return the extract value string.
307 @param NextString return the next string follow this keyword sectin.
309 @retval EFI_SUCCESS Success to get the keyword string.
310 @retval EFI_INVALID_PARAMETER Parsr the input string return error.
315 IN EFI_STRING String
,
316 OUT EFI_STRING
*Value
,
317 OUT EFI_STRING
*NextString
322 ASSERT ((Value
!= NULL
) && (NextString
!= NULL
) && (String
!= NULL
));
325 // Skip '&' if exist.
327 if (*String
== L
'&') {
331 if (StrnCmp (String
, L
"VALUE=", StrLen (L
"VALUE=")) != 0) {
332 return EFI_INVALID_PARAMETER
;
335 String
+= StrLen (L
"VALUE=");
337 TmpPtr
= StrStr (String
, L
"&");
338 if (TmpPtr
!= NULL
) {
341 *NextString
= String
+ StrLen (String
);
343 *Value
= AllocateCopyPool (StrSize (String
), String
);
344 if (*Value
== NULL
) {
345 return EFI_OUT_OF_RESOURCES
;
348 if (TmpPtr
!= NULL
) {
356 Get filter from the input KeywordRequest string.
358 This is a internal function.
360 @param String KeywordRequestformat string.
361 @param FilterFlags return the filter condition.
362 @param NextString return the next string follow this keyword sectin.
364 @retval EFI_SUCCESS Success to get the keyword string.
365 @retval EFI_INVALID_PARAMETER Parsr the input string return error.
370 IN EFI_STRING String
,
371 OUT UINT8
*FilterFlags
,
372 OUT EFI_STRING
*NextString
379 ASSERT ((FilterFlags
!= NULL
) && (NextString
!= NULL
));
382 // String end, no filter section.
384 if (String
== NULL
) {
393 // Skip '&' if exist.
395 if (*String
== L
'&') {
399 if (StrnCmp (String
, L
"ReadOnly", StrLen (L
"ReadOnly")) == 0) {
401 // Find ReadOnly filter.
403 *FilterFlags
|= EFI_KEYWORD_FILTER_READONY
;
404 String
+= StrLen (L
"ReadOnly");
405 } else if (StrnCmp (String
, L
"ReadWrite", StrLen (L
"ReadWrite")) == 0) {
407 // Find ReadWrite filter.
409 *FilterFlags
|= EFI_KEYWORD_FILTER_REAWRITE
;
410 String
+= StrLen (L
"ReadWrite");
411 } else if (StrnCmp (String
, L
"Buffer", StrLen (L
"Buffer")) == 0) {
413 // Find Buffer Filter.
415 *FilterFlags
|= EFI_KEYWORD_FILTER_BUFFER
;
416 String
+= StrLen (L
"Buffer");
417 } else if (StrnCmp (String
, L
"Numeric", StrLen (L
"Numeric")) == 0) {
419 // Find Numeric Filter
421 String
+= StrLen (L
"Numeric");
422 if (*String
!= L
':') {
423 *FilterFlags
|= EFI_KEYWORD_FILTER_NUMERIC
;
428 *FilterFlags
|= EFI_KEYWORD_FILTER_NUMERIC_1
;
431 *FilterFlags
|= EFI_KEYWORD_FILTER_NUMERIC_2
;
434 *FilterFlags
|= EFI_KEYWORD_FILTER_NUMERIC_4
;
437 *FilterFlags
|= EFI_KEYWORD_FILTER_NUMERIC_8
;
447 // Check whether other filter item defined by Platform.
449 if ((StrnCmp (String
, L
"&PATH", StrLen (L
"&PATH")) == 0) ||
450 (StrnCmp (String
, L
"&KEYWORD", StrLen (L
"&KEYWORD")) == 0)) {
452 // New KeywordRequest start, no platform defined filter.
456 // Platform defined filter rule.
457 // Just skip platform defined filter rule, return success.
459 PathPtr
= StrStr(String
, L
"&PATH");
460 KeywordPtr
= StrStr(String
, L
"&KEYWORD");
461 if (PathPtr
!= NULL
&& KeywordPtr
!= NULL
) {
463 // If both sections exist, return the first follow string.
465 String
= KeywordPtr
> PathPtr
? PathPtr
: KeywordPtr
;
466 } else if (PathPtr
!= NULL
) {
468 // Should not exist PathPtr != NULL && KeywordPtr == NULL case.
471 } else if (KeywordPtr
!= NULL
) {
473 // Just to the next keyword section.
478 // Only has paltform defined filter section, just skip it.
480 String
+= StrLen (String
);
486 *NextString
= String
;
492 Extract Readonly flag from opcode.
494 This is a internal function.
496 @param OpCodeData Input opcode for this question.
498 @retval TRUE This question is readonly.
499 @retval FALSE This question is not readonly.
503 ExtractReadOnlyFromOpCode (
507 EFI_IFR_QUESTION_HEADER
*QuestionHdr
;
509 ASSERT (OpCodeData
!= NULL
);
511 QuestionHdr
= (EFI_IFR_QUESTION_HEADER
*) (OpCodeData
+ sizeof (EFI_IFR_OP_HEADER
));
513 return (QuestionHdr
->Flags
& EFI_IFR_FLAG_READ_ONLY
) != 0;
517 Create a circuit to check the filter section.
519 This is a internal function.
521 @param OpCodeData The questin binary ifr data.
522 @param KeywordRequest KeywordRequestformat string.
523 @param NextString return the next string follow this keyword sectin.
524 @param ReadOnly Return whether this question is read only.
526 @retval KEYWORD_HANDLER_NO_ERROR Success validate.
527 @retval KEYWORD_HANDLER_INCOMPATIBLE_VALUE_DETECTED Validate fail.
532 IN UINT8
*OpCodeData
,
533 IN CHAR16
*KeywordRequest
,
534 OUT CHAR16
**NextString
,
535 OUT BOOLEAN
*ReadOnly
541 EFI_IFR_QUESTION_HEADER
*QuestionHdr
;
542 EFI_IFR_OP_HEADER
*OpCodeHdr
;
546 RetVal
= KEYWORD_HANDLER_NO_ERROR
;
547 StringPtr
= KeywordRequest
;
549 OpCodeHdr
= (EFI_IFR_OP_HEADER
*) OpCodeData
;
550 QuestionHdr
= (EFI_IFR_QUESTION_HEADER
*) (OpCodeData
+ sizeof (EFI_IFR_OP_HEADER
));
551 if (OpCodeHdr
->OpCode
== EFI_IFR_ONE_OF_OP
|| OpCodeHdr
->OpCode
== EFI_IFR_NUMERIC_OP
) {
552 Flags
= *(OpCodeData
+ sizeof (EFI_IFR_OP_HEADER
) + sizeof (EFI_IFR_QUESTION_HEADER
));
558 // Get ReadOnly flag from Question.
560 *ReadOnly
= ExtractReadOnlyFromOpCode(OpCodeData
);
562 while (ExtractFilter (StringPtr
, &FilterFlags
, &NextFilter
)) {
563 switch (FilterFlags
) {
564 case EFI_KEYWORD_FILTER_READONY
:
565 if ((QuestionHdr
->Flags
& EFI_IFR_FLAG_READ_ONLY
) == 0) {
566 RetVal
= KEYWORD_HANDLER_INCOMPATIBLE_VALUE_DETECTED
;
571 case EFI_KEYWORD_FILTER_REAWRITE
:
572 if ((QuestionHdr
->Flags
& EFI_IFR_FLAG_READ_ONLY
) != 0) {
573 RetVal
= KEYWORD_HANDLER_INCOMPATIBLE_VALUE_DETECTED
;
578 case EFI_KEYWORD_FILTER_BUFFER
:
580 // Only these three opcode use numeric value type.
582 if (OpCodeHdr
->OpCode
== EFI_IFR_ONE_OF_OP
|| OpCodeHdr
->OpCode
== EFI_IFR_NUMERIC_OP
|| OpCodeHdr
->OpCode
== EFI_IFR_CHECKBOX_OP
) {
583 RetVal
= KEYWORD_HANDLER_INCOMPATIBLE_VALUE_DETECTED
;
588 case EFI_KEYWORD_FILTER_NUMERIC
:
589 if (OpCodeHdr
->OpCode
!= EFI_IFR_ONE_OF_OP
&& OpCodeHdr
->OpCode
!= EFI_IFR_NUMERIC_OP
&& OpCodeHdr
->OpCode
!= EFI_IFR_CHECKBOX_OP
) {
590 RetVal
= KEYWORD_HANDLER_INCOMPATIBLE_VALUE_DETECTED
;
595 case EFI_KEYWORD_FILTER_NUMERIC_1
:
596 case EFI_KEYWORD_FILTER_NUMERIC_2
:
597 case EFI_KEYWORD_FILTER_NUMERIC_4
:
598 case EFI_KEYWORD_FILTER_NUMERIC_8
:
599 if (OpCodeHdr
->OpCode
!= EFI_IFR_ONE_OF_OP
&& OpCodeHdr
->OpCode
!= EFI_IFR_NUMERIC_OP
&& OpCodeHdr
->OpCode
!= EFI_IFR_CHECKBOX_OP
) {
600 RetVal
= KEYWORD_HANDLER_INCOMPATIBLE_VALUE_DETECTED
;
605 // For numeric and oneof, it has flags field to specify the detail numeric type.
607 if (OpCodeHdr
->OpCode
== EFI_IFR_ONE_OF_OP
|| OpCodeHdr
->OpCode
== EFI_IFR_NUMERIC_OP
) {
608 switch (Flags
& EFI_IFR_NUMERIC_SIZE
) {
609 case EFI_IFR_NUMERIC_SIZE_1
:
610 if (FilterFlags
!= EFI_KEYWORD_FILTER_NUMERIC_1
) {
611 RetVal
= KEYWORD_HANDLER_INCOMPATIBLE_VALUE_DETECTED
;
616 case EFI_IFR_NUMERIC_SIZE_2
:
617 if (FilterFlags
!= EFI_KEYWORD_FILTER_NUMERIC_2
) {
618 RetVal
= KEYWORD_HANDLER_INCOMPATIBLE_VALUE_DETECTED
;
623 case EFI_IFR_NUMERIC_SIZE_4
:
624 if (FilterFlags
!= EFI_KEYWORD_FILTER_NUMERIC_4
) {
625 RetVal
= KEYWORD_HANDLER_INCOMPATIBLE_VALUE_DETECTED
;
630 case EFI_IFR_NUMERIC_SIZE_8
:
631 if (FilterFlags
!= EFI_KEYWORD_FILTER_NUMERIC_8
) {
632 RetVal
= KEYWORD_HANDLER_INCOMPATIBLE_VALUE_DETECTED
;
650 // Jump to the next filter.
652 StringPtr
= NextFilter
;
657 // The current filter which is processing.
659 *NextString
= StringPtr
;
665 Get HII_DATABASE_RECORD from the input device path info.
667 This is a internal function.
669 @param DevicePath UEFI device path protocol.
671 @retval Internal data base record.
674 HII_DATABASE_RECORD
*
675 GetRecordFromDevicePath (
676 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
680 UINT8
*DevicePathPkg
;
681 UINT8
*CurrentDevicePath
;
682 UINTN DevicePathSize
;
683 HII_DATABASE_RECORD
*TempDatabase
;
685 ASSERT (DevicePath
!= NULL
);
687 for (Link
= mPrivate
.DatabaseList
.ForwardLink
; Link
!= &mPrivate
.DatabaseList
; Link
= Link
->ForwardLink
) {
688 TempDatabase
= CR (Link
, HII_DATABASE_RECORD
, DatabaseEntry
, HII_DATABASE_RECORD_SIGNATURE
);
689 DevicePathPkg
= TempDatabase
->PackageList
->DevicePathPkg
;
690 if (DevicePathPkg
!= NULL
) {
691 CurrentDevicePath
= DevicePathPkg
+ sizeof (EFI_HII_PACKAGE_HEADER
);
692 DevicePathSize
= GetDevicePathSize ((EFI_DEVICE_PATH_PROTOCOL
*) CurrentDevicePath
);
693 if ((CompareMem (DevicePath
, CurrentDevicePath
, DevicePathSize
) == 0)) {
703 Calculate the size of StringSrc and output it. Also copy string text from src
706 This is a internal function.
708 @param StringSrc Points to current null-terminated string.
709 @param BufferSize Length of the buffer.
710 @param StringDest Buffer to store the string text.
712 @retval EFI_SUCCESS The string text was outputed successfully.
713 @retval EFI_OUT_OF_RESOURCES Out of resource.
717 GetUnicodeStringTextAndSize (
719 OUT UINTN
*BufferSize
,
720 OUT EFI_STRING
*StringDest
726 ASSERT (StringSrc
!= NULL
&& BufferSize
!= NULL
&& StringDest
!= NULL
);
728 StringSize
= sizeof (CHAR16
);
729 StringPtr
= StringSrc
;
730 while (ReadUnaligned16 ((UINT16
*) StringPtr
) != 0) {
731 StringSize
+= sizeof (CHAR16
);
732 StringPtr
+= sizeof (CHAR16
);
735 *StringDest
= AllocatePool (StringSize
);
736 if (*StringDest
== NULL
) {
737 return EFI_OUT_OF_RESOURCES
;
740 CopyMem (*StringDest
, StringSrc
, StringSize
);
742 *BufferSize
= StringSize
;
747 Find the string id for the input keyword.
749 @param StringPackage Hii string package instance.
750 @param KeywordValue Input keyword value.
751 @param StringId The string's id, which is unique within PackageList.
754 @retval EFI_SUCCESS The string text and font is retrieved
756 @retval EFI_NOT_FOUND The specified text or font info can not be found
758 @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the
762 GetStringIdFromString (
763 IN HII_STRING_PACKAGE_INSTANCE
*StringPackage
,
764 IN CHAR16
*KeywordValue
,
765 OUT EFI_STRING_ID
*StringId
769 EFI_STRING_ID CurrentStringId
;
772 UINT8
*StringTextPtr
;
777 EFI_HII_SIBT_EXT2_BLOCK Ext2
;
781 CHAR8
*AsciiKeywordValue
;
784 ASSERT (StringPackage
!= NULL
&& KeywordValue
!= NULL
&& StringId
!= NULL
);
785 ASSERT (StringPackage
->Signature
== HII_STRING_PACKAGE_SIGNATURE
);
788 Status
= EFI_SUCCESS
;
790 BlockHdr
= StringPackage
->StringBlock
;
795 // Make a ascii keyword value for later use.
797 AsciiKeywordValue
= AllocatePool (StrLen (KeywordValue
) + 1);
798 if (AsciiKeywordValue
== NULL
) {
799 return EFI_OUT_OF_RESOURCES
;
801 UnicodeStrToAsciiStr(KeywordValue
, AsciiKeywordValue
);
803 while (*BlockHdr
!= EFI_HII_SIBT_END
) {
805 case EFI_HII_SIBT_STRING_SCSU
:
806 Offset
= sizeof (EFI_HII_STRING_BLOCK
);
807 StringTextPtr
= BlockHdr
+ Offset
;
808 BlockSize
+= Offset
+ AsciiStrSize ((CHAR8
*) StringTextPtr
);
809 if (AsciiStrCmp(AsciiKeywordValue
, (CHAR8
*) StringTextPtr
) == 0) {
810 *StringId
= CurrentStringId
;
816 case EFI_HII_SIBT_STRING_SCSU_FONT
:
817 Offset
= sizeof (EFI_HII_SIBT_STRING_SCSU_FONT_BLOCK
) - sizeof (UINT8
);
818 StringTextPtr
= BlockHdr
+ Offset
;
819 if (AsciiStrCmp(AsciiKeywordValue
, (CHAR8
*) StringTextPtr
) == 0) {
820 *StringId
= CurrentStringId
;
823 BlockSize
+= Offset
+ AsciiStrSize ((CHAR8
*) StringTextPtr
);
827 case EFI_HII_SIBT_STRINGS_SCSU
:
828 CopyMem (&StringCount
, BlockHdr
+ sizeof (EFI_HII_STRING_BLOCK
), sizeof (UINT16
));
829 StringTextPtr
= (UINT8
*)((UINTN
)BlockHdr
+ sizeof (EFI_HII_SIBT_STRINGS_SCSU_BLOCK
) - sizeof (UINT8
));
830 BlockSize
+= StringTextPtr
- BlockHdr
;
832 for (Index
= 0; Index
< StringCount
; Index
++) {
833 BlockSize
+= AsciiStrSize ((CHAR8
*) StringTextPtr
);
834 if (AsciiStrCmp(AsciiKeywordValue
, (CHAR8
*) StringTextPtr
) == 0) {
835 *StringId
= CurrentStringId
;
838 StringTextPtr
= StringTextPtr
+ AsciiStrSize ((CHAR8
*) StringTextPtr
);
843 case EFI_HII_SIBT_STRINGS_SCSU_FONT
:
846 (UINT8
*)((UINTN
)BlockHdr
+ sizeof (EFI_HII_STRING_BLOCK
) + sizeof (UINT8
)),
849 StringTextPtr
= (UINT8
*)((UINTN
)BlockHdr
+ sizeof (EFI_HII_SIBT_STRINGS_SCSU_FONT_BLOCK
) - sizeof (UINT8
));
850 BlockSize
+= StringTextPtr
- BlockHdr
;
852 for (Index
= 0; Index
< StringCount
; Index
++) {
853 BlockSize
+= AsciiStrSize ((CHAR8
*) StringTextPtr
);
854 if (AsciiStrCmp(AsciiKeywordValue
, (CHAR8
*) StringTextPtr
) == 0) {
855 *StringId
= CurrentStringId
;
858 StringTextPtr
= StringTextPtr
+ AsciiStrSize ((CHAR8
*) StringTextPtr
);
863 case EFI_HII_SIBT_STRING_UCS2
:
864 Offset
= sizeof (EFI_HII_STRING_BLOCK
);
865 StringTextPtr
= BlockHdr
+ Offset
;
867 // Use StringSize to store the size of the specified string, including the NULL
870 Status
= GetUnicodeStringTextAndSize (StringTextPtr
, &StringSize
, &String
);
871 if (EFI_ERROR (Status
)) {
875 if (StrCmp(KeywordValue
, String
) == 0) {
876 *StringId
= CurrentStringId
;
879 BlockSize
+= Offset
+ StringSize
;
883 case EFI_HII_SIBT_STRING_UCS2_FONT
:
884 Offset
= sizeof (EFI_HII_SIBT_STRING_UCS2_FONT_BLOCK
) - sizeof (CHAR16
);
885 StringTextPtr
= BlockHdr
+ Offset
;
887 // Use StringSize to store the size of the specified string, including the NULL
890 Status
= GetUnicodeStringTextAndSize (StringTextPtr
, &StringSize
, &String
);
891 if (EFI_ERROR (Status
)) {
895 if (StrCmp(KeywordValue
, String
) == 0) {
896 *StringId
= CurrentStringId
;
899 BlockSize
+= Offset
+ StringSize
;
903 case EFI_HII_SIBT_STRINGS_UCS2
:
904 Offset
= sizeof (EFI_HII_SIBT_STRINGS_UCS2_BLOCK
) - sizeof (CHAR16
);
905 StringTextPtr
= BlockHdr
+ Offset
;
907 CopyMem (&StringCount
, BlockHdr
+ sizeof (EFI_HII_STRING_BLOCK
), sizeof (UINT16
));
908 for (Index
= 0; Index
< StringCount
; Index
++) {
909 Status
= GetUnicodeStringTextAndSize (StringTextPtr
, &StringSize
, &String
);
910 if (EFI_ERROR (Status
)) {
914 BlockSize
+= StringSize
;
915 if (StrCmp(KeywordValue
, String
) == 0) {
916 *StringId
= CurrentStringId
;
919 StringTextPtr
= StringTextPtr
+ StringSize
;
924 case EFI_HII_SIBT_STRINGS_UCS2_FONT
:
925 Offset
= sizeof (EFI_HII_SIBT_STRINGS_UCS2_FONT_BLOCK
) - sizeof (CHAR16
);
926 StringTextPtr
= BlockHdr
+ Offset
;
930 (UINT8
*)((UINTN
)BlockHdr
+ sizeof (EFI_HII_STRING_BLOCK
) + sizeof (UINT8
)),
933 for (Index
= 0; Index
< StringCount
; Index
++) {
934 Status
= GetUnicodeStringTextAndSize (StringTextPtr
, &StringSize
, &String
);
935 if (EFI_ERROR (Status
)) {
939 BlockSize
+= StringSize
;
940 if (StrCmp(KeywordValue
, String
) == 0) {
941 *StringId
= CurrentStringId
;
944 StringTextPtr
= StringTextPtr
+ StringSize
;
949 case EFI_HII_SIBT_DUPLICATE
:
950 BlockSize
+= sizeof (EFI_HII_SIBT_DUPLICATE_BLOCK
);
954 case EFI_HII_SIBT_SKIP1
:
955 SkipCount
= (UINT16
) (*(UINT8
*)((UINTN
)BlockHdr
+ sizeof (EFI_HII_STRING_BLOCK
)));
956 CurrentStringId
= (UINT16
) (CurrentStringId
+ SkipCount
);
957 BlockSize
+= sizeof (EFI_HII_SIBT_SKIP1_BLOCK
);
960 case EFI_HII_SIBT_SKIP2
:
961 CopyMem (&SkipCount
, BlockHdr
+ sizeof (EFI_HII_STRING_BLOCK
), sizeof (UINT16
));
962 CurrentStringId
= (UINT16
) (CurrentStringId
+ SkipCount
);
963 BlockSize
+= sizeof (EFI_HII_SIBT_SKIP2_BLOCK
);
966 case EFI_HII_SIBT_EXT1
:
969 (UINT8
*)((UINTN
)BlockHdr
+ sizeof (EFI_HII_STRING_BLOCK
) + sizeof (UINT8
)),
972 BlockSize
+= Length8
;
975 case EFI_HII_SIBT_EXT2
:
976 CopyMem (&Ext2
, BlockHdr
, sizeof (EFI_HII_SIBT_EXT2_BLOCK
));
977 BlockSize
+= Ext2
.Length
;
980 case EFI_HII_SIBT_EXT4
:
983 (UINT8
*)((UINTN
)BlockHdr
+ sizeof (EFI_HII_STRING_BLOCK
) + sizeof (UINT8
)),
987 BlockSize
+= Length32
;
994 if (String
!= NULL
) {
999 BlockHdr
= StringPackage
->StringBlock
+ BlockSize
;
1002 Status
= EFI_NOT_FOUND
;
1005 if (AsciiKeywordValue
!= NULL
) {
1006 FreePool (AsciiKeywordValue
);
1008 if (String
!= NULL
) {
1015 Find the next valid string id for the input string id.
1017 @param StringPackage Hii string package instance.
1018 @param StringId The current string id which is already got.
1019 1 means just begin to get the string id.
1020 @param KeywordValue Return the string for the next string id.
1023 @retval EFI_STRING_ID Not 0 means a valid stringid found.
1024 0 means not found a valid string id.
1028 IN HII_STRING_PACKAGE_INSTANCE
*StringPackage
,
1029 IN EFI_STRING_ID StringId
,
1030 OUT EFI_STRING
*KeywordValue
1034 EFI_STRING_ID CurrentStringId
;
1037 UINT8
*StringTextPtr
;
1042 EFI_HII_SIBT_EXT2_BLOCK Ext2
;
1048 ASSERT (StringPackage
!= NULL
);
1049 ASSERT (StringPackage
->Signature
== HII_STRING_PACKAGE_SIGNATURE
);
1051 CurrentStringId
= 1;
1056 // Parse the string blocks to get the string text and font.
1058 BlockHdr
= StringPackage
->StringBlock
;
1061 while (*BlockHdr
!= EFI_HII_SIBT_END
) {
1062 switch (*BlockHdr
) {
1063 case EFI_HII_SIBT_STRING_SCSU
:
1064 Offset
= sizeof (EFI_HII_STRING_BLOCK
);
1065 StringTextPtr
= BlockHdr
+ Offset
;
1068 *KeywordValue
= AllocatePool (AsciiStrSize ((CHAR8
*) StringTextPtr
) * sizeof (CHAR16
));
1069 if (*KeywordValue
== NULL
) {
1072 AsciiStrToUnicodeStr ((CHAR8
*) StringTextPtr
, *KeywordValue
);
1073 return CurrentStringId
;
1074 } else if (CurrentStringId
== StringId
) {
1078 BlockSize
+= Offset
+ AsciiStrSize ((CHAR8
*) StringTextPtr
);
1082 case EFI_HII_SIBT_STRING_SCSU_FONT
:
1083 Offset
= sizeof (EFI_HII_SIBT_STRING_SCSU_FONT_BLOCK
) - sizeof (UINT8
);
1084 StringTextPtr
= BlockHdr
+ Offset
;
1087 *KeywordValue
= AllocatePool (AsciiStrSize ((CHAR8
*) StringTextPtr
) * sizeof (CHAR16
));
1088 if (*KeywordValue
== NULL
) {
1091 AsciiStrToUnicodeStr ((CHAR8
*) StringTextPtr
, *KeywordValue
);
1092 return CurrentStringId
;
1093 } else if (CurrentStringId
== StringId
) {
1097 BlockSize
+= Offset
+ AsciiStrSize ((CHAR8
*) StringTextPtr
);
1101 case EFI_HII_SIBT_STRINGS_SCSU
:
1102 CopyMem (&StringCount
, BlockHdr
+ sizeof (EFI_HII_STRING_BLOCK
), sizeof (UINT16
));
1103 StringTextPtr
= (UINT8
*)((UINTN
)BlockHdr
+ sizeof (EFI_HII_SIBT_STRINGS_SCSU_BLOCK
) - sizeof (UINT8
));
1104 BlockSize
+= StringTextPtr
- BlockHdr
;
1106 for (Index
= 0; Index
< StringCount
; Index
++) {
1108 *KeywordValue
= AllocatePool (AsciiStrSize ((CHAR8
*) StringTextPtr
) * sizeof (CHAR16
));
1109 if (*KeywordValue
== NULL
) {
1112 AsciiStrToUnicodeStr ((CHAR8
*) StringTextPtr
, *KeywordValue
);
1113 return CurrentStringId
;
1114 } else if (CurrentStringId
== StringId
) {
1118 BlockSize
+= AsciiStrSize ((CHAR8
*) StringTextPtr
);
1119 StringTextPtr
= StringTextPtr
+ AsciiStrSize ((CHAR8
*) StringTextPtr
);
1124 case EFI_HII_SIBT_STRINGS_SCSU_FONT
:
1127 (UINT8
*)((UINTN
)BlockHdr
+ sizeof (EFI_HII_STRING_BLOCK
) + sizeof (UINT8
)),
1130 StringTextPtr
= (UINT8
*)((UINTN
)BlockHdr
+ sizeof (EFI_HII_SIBT_STRINGS_SCSU_FONT_BLOCK
) - sizeof (UINT8
));
1131 BlockSize
+= StringTextPtr
- BlockHdr
;
1133 for (Index
= 0; Index
< StringCount
; Index
++) {
1135 *KeywordValue
= AllocatePool (AsciiStrSize ((CHAR8
*) StringTextPtr
) * sizeof (CHAR16
));
1136 if (*KeywordValue
== NULL
) {
1139 AsciiStrToUnicodeStr ((CHAR8
*) StringTextPtr
, *KeywordValue
);
1140 return CurrentStringId
;
1141 } else if (CurrentStringId
== StringId
) {
1145 BlockSize
+= AsciiStrSize ((CHAR8
*) StringTextPtr
);
1146 StringTextPtr
= StringTextPtr
+ AsciiStrSize ((CHAR8
*) StringTextPtr
);
1151 case EFI_HII_SIBT_STRING_UCS2
:
1152 Offset
= sizeof (EFI_HII_STRING_BLOCK
);
1153 StringTextPtr
= BlockHdr
+ Offset
;
1155 // Use StringSize to store the size of the specified string, including the NULL
1158 GetUnicodeStringTextAndSize (StringTextPtr
, &StringSize
, &String
);
1159 if (FindString
&& (String
!= NULL
) && (*String
!= L
'\0')) {
1161 // String protocol use this type for the string id which has value for other package.
1162 // It will allocate an empty string block for this string id. so here we also check
1163 // *String != L'\0' to prohibit this case.
1165 *KeywordValue
= String
;
1166 return CurrentStringId
;
1167 } else if (CurrentStringId
== StringId
) {
1171 BlockSize
+= Offset
+ StringSize
;
1175 case EFI_HII_SIBT_STRING_UCS2_FONT
:
1176 Offset
= sizeof (EFI_HII_SIBT_STRING_UCS2_FONT_BLOCK
) - sizeof (CHAR16
);
1177 StringTextPtr
= BlockHdr
+ Offset
;
1179 // Use StringSize to store the size of the specified string, including the NULL
1182 GetUnicodeStringTextAndSize (StringTextPtr
, &StringSize
, &String
);
1184 *KeywordValue
= String
;
1185 return CurrentStringId
;
1186 } else if (CurrentStringId
== StringId
) {
1190 BlockSize
+= Offset
+ StringSize
;
1194 case EFI_HII_SIBT_STRINGS_UCS2
:
1195 Offset
= sizeof (EFI_HII_SIBT_STRINGS_UCS2_BLOCK
) - sizeof (CHAR16
);
1196 StringTextPtr
= BlockHdr
+ Offset
;
1197 BlockSize
+= Offset
;
1198 CopyMem (&StringCount
, BlockHdr
+ sizeof (EFI_HII_STRING_BLOCK
), sizeof (UINT16
));
1199 for (Index
= 0; Index
< StringCount
; Index
++) {
1200 GetUnicodeStringTextAndSize (StringTextPtr
, &StringSize
, &String
);
1203 *KeywordValue
= String
;
1204 return CurrentStringId
;
1205 } else if (CurrentStringId
== StringId
) {
1209 BlockSize
+= StringSize
;
1210 StringTextPtr
= StringTextPtr
+ StringSize
;
1215 case EFI_HII_SIBT_STRINGS_UCS2_FONT
:
1216 Offset
= sizeof (EFI_HII_SIBT_STRINGS_UCS2_FONT_BLOCK
) - sizeof (CHAR16
);
1217 StringTextPtr
= BlockHdr
+ Offset
;
1218 BlockSize
+= Offset
;
1221 (UINT8
*)((UINTN
)BlockHdr
+ sizeof (EFI_HII_STRING_BLOCK
) + sizeof (UINT8
)),
1224 for (Index
= 0; Index
< StringCount
; Index
++) {
1225 GetUnicodeStringTextAndSize (StringTextPtr
, &StringSize
, &String
);
1227 *KeywordValue
= String
;
1228 return CurrentStringId
;
1229 } else if (CurrentStringId
== StringId
) {
1233 BlockSize
+= StringSize
;
1234 StringTextPtr
= StringTextPtr
+ StringSize
;
1239 case EFI_HII_SIBT_DUPLICATE
:
1240 BlockSize
+= sizeof (EFI_HII_SIBT_DUPLICATE_BLOCK
);
1244 case EFI_HII_SIBT_SKIP1
:
1245 SkipCount
= (UINT16
) (*(UINT8
*)((UINTN
)BlockHdr
+ sizeof (EFI_HII_STRING_BLOCK
)));
1246 CurrentStringId
= (UINT16
) (CurrentStringId
+ SkipCount
);
1247 BlockSize
+= sizeof (EFI_HII_SIBT_SKIP1_BLOCK
);
1250 case EFI_HII_SIBT_SKIP2
:
1251 CopyMem (&SkipCount
, BlockHdr
+ sizeof (EFI_HII_STRING_BLOCK
), sizeof (UINT16
));
1252 CurrentStringId
= (UINT16
) (CurrentStringId
+ SkipCount
);
1253 BlockSize
+= sizeof (EFI_HII_SIBT_SKIP2_BLOCK
);
1256 case EFI_HII_SIBT_EXT1
:
1259 (UINT8
*)((UINTN
)BlockHdr
+ sizeof (EFI_HII_STRING_BLOCK
) + sizeof (UINT8
)),
1262 BlockSize
+= Length8
;
1265 case EFI_HII_SIBT_EXT2
:
1266 CopyMem (&Ext2
, BlockHdr
, sizeof (EFI_HII_SIBT_EXT2_BLOCK
));
1267 BlockSize
+= Ext2
.Length
;
1270 case EFI_HII_SIBT_EXT4
:
1273 (UINT8
*)((UINTN
)BlockHdr
+ sizeof (EFI_HII_STRING_BLOCK
) + sizeof (UINT8
)),
1277 BlockSize
+= Length32
;
1284 if (String
!= NULL
) {
1289 BlockHdr
= StringPackage
->StringBlock
+ BlockSize
;
1296 Get string package from the input NameSpace string.
1298 This is a internal function.
1300 @param DatabaseRecord HII_DATABASE_RECORD format string.
1301 @param NameSpace NameSpace format string.
1302 @param KeywordValue Keyword value.
1303 @param StringId String Id for this keyword.
1305 @retval KEYWORD_HANDLER_NO_ERROR Get String id succes.
1306 @retval KEYWORD_HANDLER_KEYWORD_NOT_FOUND Not found the string id in the string package.
1307 @retval KEYWORD_HANDLER_NAMESPACE_ID_NOT_FOUND Not found the string package for this namespace.
1308 @retval KEYWORD_HANDLER_UNDEFINED_PROCESSING_ERROR Out of resource error.
1312 GetStringIdFromRecord (
1313 IN HII_DATABASE_RECORD
*DatabaseRecord
,
1314 IN CHAR8
**NameSpace
,
1315 IN CHAR16
*KeywordValue
,
1316 OUT EFI_STRING_ID
*StringId
1320 HII_DATABASE_PACKAGE_LIST_INSTANCE
*PackageListNode
;
1321 HII_STRING_PACKAGE_INSTANCE
*StringPackage
;
1326 ASSERT (DatabaseRecord
!= NULL
&& NameSpace
!= NULL
&& KeywordValue
!= NULL
);
1328 PackageListNode
= DatabaseRecord
->PackageList
;
1329 RetVal
= KEYWORD_HANDLER_NAMESPACE_ID_NOT_FOUND
;
1331 if (*NameSpace
!= NULL
) {
1334 Name
= UEFI_CONFIG_LANG
;
1337 for (Link
= PackageListNode
->StringPkgHdr
.ForwardLink
; Link
!= &PackageListNode
->StringPkgHdr
; Link
= Link
->ForwardLink
) {
1338 StringPackage
= CR (Link
, HII_STRING_PACKAGE_INSTANCE
, StringEntry
, HII_STRING_PACKAGE_SIGNATURE
);
1340 if (AsciiStrnCmp(Name
, StringPackage
->StringPkgHdr
->Language
, AsciiStrLen (Name
)) == 0) {
1341 Status
= GetStringIdFromString (StringPackage
, KeywordValue
, StringId
);
1342 if (EFI_ERROR (Status
)) {
1343 RetVal
= KEYWORD_HANDLER_KEYWORD_NOT_FOUND
;
1346 if (*NameSpace
== NULL
) {
1347 *NameSpace
= AllocateCopyPool (AsciiStrSize (StringPackage
->StringPkgHdr
->Language
), StringPackage
->StringPkgHdr
->Language
);
1348 if (*NameSpace
== NULL
) {
1349 return KEYWORD_HANDLER_UNDEFINED_PROCESSING_ERROR
;
1352 return KEYWORD_HANDLER_NO_ERROR
;
1361 Tell whether this Operand is an Statement OpCode.
1363 @param Operand Operand of an IFR OpCode.
1365 @retval TRUE This is an Statement OpCode.
1366 @retval FALSE Not an Statement OpCode.
1374 if ((Operand
== EFI_IFR_SUBTITLE_OP
) ||
1375 (Operand
== EFI_IFR_TEXT_OP
) ||
1376 (Operand
== EFI_IFR_RESET_BUTTON_OP
) ||
1377 (Operand
== EFI_IFR_REF_OP
) ||
1378 (Operand
== EFI_IFR_ACTION_OP
) ||
1379 (Operand
== EFI_IFR_NUMERIC_OP
) ||
1380 (Operand
== EFI_IFR_ORDERED_LIST_OP
) ||
1381 (Operand
== EFI_IFR_CHECKBOX_OP
) ||
1382 (Operand
== EFI_IFR_STRING_OP
) ||
1383 (Operand
== EFI_IFR_PASSWORD_OP
) ||
1384 (Operand
== EFI_IFR_DATE_OP
) ||
1385 (Operand
== EFI_IFR_TIME_OP
) ||
1386 (Operand
== EFI_IFR_GUID_OP
) ||
1387 (Operand
== EFI_IFR_ONE_OF_OP
)) {
1395 Tell whether this Operand is an Statement OpCode.
1397 @param Operand Operand of an IFR OpCode.
1399 @retval TRUE This is an Statement OpCode.
1400 @retval FALSE Not an Statement OpCode.
1408 if ((Operand
== EFI_IFR_VARSTORE_OP
) ||
1409 (Operand
== EFI_IFR_VARSTORE_NAME_VALUE_OP
) ||
1410 (Operand
== EFI_IFR_VARSTORE_EFI_OP
)) {
1418 Base on the prompt string id to find the question.
1420 @param FormPackage The input form package.
1421 @param KeywordStrId The input prompt string id for one question.
1423 @retval the opcode for the question.
1427 FindQuestionFromStringId (
1428 IN HII_IFR_PACKAGE_INSTANCE
*FormPackage
,
1429 IN EFI_STRING_ID KeywordStrId
1434 EFI_IFR_STATEMENT_HEADER
*StatementHeader
;
1435 EFI_IFR_OP_HEADER
*OpCodeHeader
;
1438 ASSERT (FormPackage
!= NULL
);
1440 FormDataLen
= FormPackage
->FormPkgHdr
.Length
- sizeof (EFI_HII_PACKAGE_HEADER
);
1442 while (Offset
< FormDataLen
) {
1443 OpCodeData
= FormPackage
->IfrData
+ Offset
;
1444 OpCodeHeader
= (EFI_IFR_OP_HEADER
*) OpCodeData
;
1446 if (IsStatementOpCode(OpCodeHeader
->OpCode
)) {
1447 StatementHeader
= (EFI_IFR_STATEMENT_HEADER
*) (OpCodeData
+ sizeof (EFI_IFR_OP_HEADER
));
1448 if (StatementHeader
->Prompt
== KeywordStrId
) {
1453 Offset
+= OpCodeHeader
->Length
;
1460 Base on the varstore id to find the storage info.
1462 @param FormPackage The input form package.
1463 @param VarStoreId The input storage id.
1465 @retval the opcode for the storage.
1469 FindStorageFromVarId (
1470 IN HII_IFR_PACKAGE_INSTANCE
*FormPackage
,
1471 IN EFI_VARSTORE_ID VarStoreId
1476 EFI_IFR_OP_HEADER
*OpCodeHeader
;
1479 ASSERT (FormPackage
!= NULL
);
1481 FormDataLen
= FormPackage
->FormPkgHdr
.Length
- sizeof (EFI_HII_PACKAGE_HEADER
);
1483 while (Offset
< FormDataLen
) {
1484 OpCodeData
= FormPackage
->IfrData
+ Offset
;
1485 OpCodeHeader
= (EFI_IFR_OP_HEADER
*) OpCodeData
;
1487 if (IsStorageOpCode(OpCodeHeader
->OpCode
)) {
1488 switch (OpCodeHeader
->OpCode
) {
1489 case EFI_IFR_VARSTORE_OP
:
1490 if (VarStoreId
== ((EFI_IFR_VARSTORE
*) OpCodeData
)->VarStoreId
) {
1495 case EFI_IFR_VARSTORE_NAME_VALUE_OP
:
1496 if (VarStoreId
== ((EFI_IFR_VARSTORE_NAME_VALUE
*) OpCodeData
)->VarStoreId
) {
1501 case EFI_IFR_VARSTORE_EFI_OP
:
1502 if (VarStoreId
== ((EFI_IFR_VARSTORE_EFI
*) OpCodeData
)->VarStoreId
) {
1512 Offset
+= OpCodeHeader
->Length
;
1519 Get width info for one question.
1521 @param OpCodeData The input opcode for one question.
1523 @retval the width info for one question.
1528 IN UINT8
*OpCodeData
1531 UINT8
*NextOpCodeData
;
1533 ASSERT (OpCodeData
!= NULL
);
1535 switch (((EFI_IFR_OP_HEADER
*) OpCodeData
)->OpCode
) {
1536 case EFI_IFR_REF_OP
:
1537 return (UINT16
) sizeof (EFI_HII_REF
);
1539 case EFI_IFR_ONE_OF_OP
:
1540 case EFI_IFR_NUMERIC_OP
:
1541 switch (((EFI_IFR_ONE_OF
*) OpCodeData
)->Flags
& EFI_IFR_NUMERIC_SIZE
) {
1542 case EFI_IFR_NUMERIC_SIZE_1
:
1543 return (UINT16
) sizeof (UINT8
);
1545 case EFI_IFR_NUMERIC_SIZE_2
:
1546 return (UINT16
) sizeof (UINT16
);
1548 case EFI_IFR_NUMERIC_SIZE_4
:
1549 return (UINT16
) sizeof (UINT32
);
1551 case EFI_IFR_NUMERIC_SIZE_8
:
1552 return (UINT16
) sizeof (UINT64
);
1559 case EFI_IFR_ORDERED_LIST_OP
:
1560 NextOpCodeData
= OpCodeData
+ ((EFI_IFR_ORDERED_LIST
*) OpCodeData
)->Header
.Length
;
1562 // OneOfOption must follow the orderedlist opcode.
1564 ASSERT (((EFI_IFR_OP_HEADER
*) NextOpCodeData
)->OpCode
== EFI_IFR_ONE_OF_OPTION_OP
);
1565 switch (((EFI_IFR_ONE_OF_OPTION
*) NextOpCodeData
)->Type
) {
1566 case EFI_IFR_TYPE_NUM_SIZE_8
:
1567 return (UINT16
) sizeof (UINT8
) * ((EFI_IFR_ORDERED_LIST
*) OpCodeData
)->MaxContainers
;
1569 case EFI_IFR_TYPE_NUM_SIZE_16
:
1570 return (UINT16
) sizeof (UINT16
) * ((EFI_IFR_ORDERED_LIST
*) OpCodeData
)->MaxContainers
;
1572 case EFI_IFR_TYPE_NUM_SIZE_32
:
1573 return (UINT16
) sizeof (UINT32
) * ((EFI_IFR_ORDERED_LIST
*) OpCodeData
)->MaxContainers
;
1575 case EFI_IFR_TYPE_NUM_SIZE_64
:
1576 return (UINT16
) sizeof (UINT64
) * ((EFI_IFR_ORDERED_LIST
*) OpCodeData
)->MaxContainers
;
1583 case EFI_IFR_CHECKBOX_OP
:
1584 return (UINT16
) sizeof (BOOLEAN
);
1586 case EFI_IFR_PASSWORD_OP
:
1587 case EFI_IFR_STRING_OP
:
1588 return (UINT16
)((UINTN
) ((EFI_IFR_STRING
*) OpCodeData
)->MaxSize
* sizeof (CHAR16
));
1590 case EFI_IFR_DATE_OP
:
1591 return (UINT16
) sizeof (EFI_HII_DATE
);
1593 case EFI_IFR_TIME_OP
:
1594 return (UINT16
) sizeof (EFI_HII_TIME
);
1603 Converts all hex dtring characters in range ['A'..'F'] to ['a'..'f'] for
1604 hex digits that appear between a '=' and a '&' in a config string.
1606 If ConfigString is NULL, then ASSERT().
1608 @param[in] ConfigString Pointer to a Null-terminated Unicode string.
1610 @return Pointer to the Null-terminated Unicode result string.
1615 InternalLowerConfigString (
1616 IN EFI_STRING ConfigString
1622 ASSERT (ConfigString
!= NULL
);
1625 // Convert all hex digits in range [A-F] in the configuration header to [a-f]
1627 for (String
= ConfigString
, Lower
= FALSE
; *String
!= L
'\0'; String
++) {
1628 if (*String
== L
'=') {
1630 } else if (*String
== L
'&') {
1632 } else if (Lower
&& *String
>= L
'A' && *String
<= L
'F') {
1633 *String
= (CHAR16
) (*String
- L
'A' + L
'a');
1637 return ConfigString
;
1641 Allocates and returns a Null-terminated Unicode <ConfigHdr> string.
1643 The format of a <ConfigHdr> is as follows:
1645 GUID=<HexCh>32&NAME=<Char>NameLength&PATH=<HexChar>DevicePathSize<Null>
1647 @param[in] OpCodeData The opcode for the storage.
1648 @param[in] DriverHandle The driver handle which supports a Device Path Protocol
1649 that is the routing information PATH. Each byte of
1650 the Device Path associated with DriverHandle is converted
1651 to a 2 Unicode character hexidecimal string.
1653 @retval NULL DriverHandle does not support the Device Path Protocol.
1654 @retval Other A pointer to the Null-terminate Unicode <ConfigHdr> string
1658 ConstructConfigHdr (
1659 IN UINT8
*OpCodeData
,
1660 IN EFI_HANDLE DriverHandle
1664 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1665 UINTN DevicePathSize
;
1667 CHAR16
*ReturnString
;
1674 ASSERT (OpCodeData
!= NULL
);
1676 switch (((EFI_IFR_OP_HEADER
*)OpCodeData
)->OpCode
) {
1677 case EFI_IFR_VARSTORE_OP
:
1678 Guid
= (EFI_GUID
*)(UINTN
*)&((EFI_IFR_VARSTORE
*) OpCodeData
)->Guid
;
1679 AsciiName
= (CHAR8
*) ((EFI_IFR_VARSTORE
*) OpCodeData
)->Name
;
1682 case EFI_IFR_VARSTORE_NAME_VALUE_OP
:
1683 Guid
= (EFI_GUID
*)(UINTN
*)&((EFI_IFR_VARSTORE_NAME_VALUE
*) OpCodeData
)->Guid
;
1687 case EFI_IFR_VARSTORE_EFI_OP
:
1688 Guid
= (EFI_GUID
*)(UINTN
*)&((EFI_IFR_VARSTORE_EFI
*) OpCodeData
)->Guid
;
1689 AsciiName
= (CHAR8
*) ((EFI_IFR_VARSTORE_EFI
*) OpCodeData
)->Name
;
1699 if (AsciiName
!= NULL
) {
1700 Name
= AllocateZeroPool (AsciiStrSize (AsciiName
) * 2);
1701 ASSERT (Name
!= NULL
);
1702 AsciiStrToUnicodeStr(AsciiName
, Name
);
1708 // Compute the length of Name in Unicode characters.
1709 // If Name is NULL, then the length is 0.
1713 NameLength
= StrLen (Name
);
1719 // Retrieve DevicePath Protocol associated with DriverHandle
1721 if (DriverHandle
!= NULL
) {
1722 DevicePath
= DevicePathFromHandle (DriverHandle
);
1723 if (DevicePath
== NULL
) {
1727 // Compute the size of the device path in bytes
1729 DevicePathSize
= GetDevicePathSize (DevicePath
);
1733 // GUID=<HexCh>32&NAME=<Char>NameLength&PATH=<HexChar>DevicePathSize <Null>
1734 // | 5 | sizeof (EFI_GUID) * 2 | 6 | NameStrLen*4 | 6 | DevicePathSize * 2 | 1 |
1736 String
= AllocateZeroPool ((5 + sizeof (EFI_GUID
) * 2 + 6 + NameLength
* 4 + 6 + DevicePathSize
* 2 + 1) * sizeof (CHAR16
));
1737 if (String
== NULL
) {
1742 // Start with L"GUID="
1744 ReturnString
= StrCpy (String
, L
"GUID=");
1745 String
+= StrLen (String
);
1749 // Append Guid converted to <HexCh>32
1751 for (Index
= 0, Buffer
= (UINT8
*)Guid
; Index
< sizeof (EFI_GUID
); Index
++) {
1752 String
+= UnicodeValueToString (String
, PREFIX_ZERO
| RADIX_HEX
, *(Buffer
++), 2);
1759 StrCpy (String
, L
"&NAME=");
1760 String
+= StrLen (String
);
1764 // Append Name converted to <Char>NameLength
1766 for (; *Name
!= L
'\0'; Name
++) {
1767 String
+= UnicodeValueToString (String
, PREFIX_ZERO
| RADIX_HEX
, *Name
, 4);
1774 StrCpy (String
, L
"&PATH=");
1775 String
+= StrLen (String
);
1778 // Append the device path associated with DriverHandle converted to <HexChar>DevicePathSize
1780 for (Index
= 0, Buffer
= (UINT8
*)DevicePath
; Index
< DevicePathSize
; Index
++) {
1781 String
+= UnicodeValueToString (String
, PREFIX_ZERO
| RADIX_HEX
, *(Buffer
++), 2);
1785 // Null terminate the Unicode string
1790 // Convert all hex digits in range [A-F] in the configuration header to [a-f]
1792 return InternalLowerConfigString (ReturnString
);
1796 Generate the Config request element for one question.
1798 @param Name The name info for one question.
1799 @param Offset The offset info for one question.
1800 @param Width The width info for one question.
1802 @return Pointer to the Null-terminated Unicode request element string.
1806 ConstructRequestElement (
1817 // Add <BlockName> length for each Name
1819 // <BlockName> ::= Name + \0
1822 Length
= StrLen (Name
) + 1;
1825 // Add <BlockName> length for each Offset/Width pair
1827 // <BlockName> ::= OFFSET=1234&WIDTH=1234 + \0
1828 // | 7 | 4 | 7 | 4 | 1
1830 Length
= (7 + 4 + 7 + 4 + 1);
1834 // Allocate buffer for the entire <ConfigRequest>
1836 StringPtr
= AllocateZeroPool (Length
* sizeof (CHAR16
));
1837 ASSERT (StringPtr
!= NULL
);
1845 (StrLen (Name
) + 1) * sizeof (CHAR16
),
1851 // Append OFFSET=XXXX&WIDTH=YYYY\0
1855 (7 + 4 + 7 + 4 + 1) * sizeof (CHAR16
),
1856 L
"OFFSET=%04X&WIDTH=%04X",
1866 Get string value for question's name field.
1868 @param DatabaseRecord HII_DATABASE_RECORD format string.
1869 @param NameId The string id for the name field.
1871 @retval Name string.
1876 IN HII_DATABASE_RECORD
*DatabaseRecord
,
1877 IN EFI_STRING_ID NameId
1881 CHAR8
*PlatformLanguage
;
1882 CHAR8
*SupportedLanguages
;
1883 CHAR8
*BestLanguage
;
1889 BestLanguage
= NULL
;
1890 PlatformLanguage
= NULL
;
1891 SupportedLanguages
= NULL
;
1893 GetEfiGlobalVariable2 (L
"PlatformLang", (VOID
**)&PlatformLanguage
, NULL
);
1894 SupportedLanguages
= GetSupportedLanguages(DatabaseRecord
->Handle
);
1897 // Get the best matching language from SupportedLanguages
1899 BestLanguage
= GetBestLanguage (
1901 FALSE
, // RFC 4646 mode
1902 PlatformLanguage
!= NULL
? PlatformLanguage
: "", // Highest priority
1903 SupportedLanguages
, // Lowest priority
1906 if (BestLanguage
== NULL
) {
1907 BestLanguage
= AllocateCopyPool (AsciiStrLen ("en-US"), "en-US");
1908 ASSERT (BestLanguage
!= NULL
);
1912 Status
= mPrivate
.HiiString
.GetString (
1913 &mPrivate
.HiiString
,
1915 DatabaseRecord
->Handle
,
1921 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
1925 Name
= AllocateZeroPool (StringSize
);
1930 Status
= mPrivate
.HiiString
.GetString (
1931 &mPrivate
.HiiString
,
1933 DatabaseRecord
->Handle
,
1940 if (EFI_ERROR (Status
)) {
1947 if (SupportedLanguages
!= NULL
) {
1948 FreePool(SupportedLanguages
);
1950 if (BestLanguage
!= NULL
) {
1951 FreePool (BestLanguage
);
1953 if (PlatformLanguage
!= NULL
) {
1954 FreePool (PlatformLanguage
);
1961 Base on the input parameter to generate the ConfigRequest string.
1963 This is a internal function.
1965 @param DatabaseRecord HII_DATABASE_RECORD format string.
1966 @param KeywordStrId Keyword string id.
1967 @param OpCodeData The IFR data for this question.
1968 @param ConfigRequest Return the generate ConfigRequest string.
1970 @retval EFI_SUCCESS Generate ConfigResp string success.
1971 @retval EFI_OUT_OF_RESOURCES System out of memory resource error.
1972 @retval EFI_NOT_FOUND Not found the question which use this string id
1973 as the prompt string id.
1976 ExtractConfigRequest (
1977 IN HII_DATABASE_RECORD
*DatabaseRecord
,
1978 IN EFI_STRING_ID KeywordStrId
,
1979 OUT UINT8
**OpCodeData
,
1980 OUT EFI_STRING
*ConfigRequest
1984 HII_DATABASE_PACKAGE_LIST_INSTANCE
*PackageListNode
;
1985 HII_IFR_PACKAGE_INSTANCE
*FormPackage
;
1986 EFI_IFR_QUESTION_HEADER
*Header
;
1993 CHAR16
*RequestElement
;
1997 ASSERT (DatabaseRecord
!= NULL
&& OpCodeData
!= NULL
&& ConfigRequest
!= NULL
);
2004 PackageListNode
= DatabaseRecord
->PackageList
;
2007 // Search the languages in the specified packagelist.
2009 for (Link
= PackageListNode
->FormPkgHdr
.ForwardLink
; Link
!= &PackageListNode
->FormPkgHdr
; Link
= Link
->ForwardLink
) {
2010 FormPackage
= CR (Link
, HII_IFR_PACKAGE_INSTANCE
, IfrEntry
, HII_IFR_PACKAGE_SIGNATURE
);
2012 OpCode
= FindQuestionFromStringId (FormPackage
, KeywordStrId
);
2013 if (OpCode
!= NULL
) {
2014 *OpCodeData
= OpCode
;
2015 Header
= (EFI_IFR_QUESTION_HEADER
*) (OpCode
+ sizeof (EFI_IFR_OP_HEADER
));
2017 // Header->VarStoreId == 0 means no storage for this question.
2019 ASSERT (Header
->VarStoreId
!= 0);
2020 DEBUG ((EFI_D_INFO
, "Varstore Id: 0x%x\n", Header
->VarStoreId
));
2022 Storage
= FindStorageFromVarId (FormPackage
, Header
->VarStoreId
);
2023 ASSERT (Storage
!= NULL
);
2025 if (((EFI_IFR_OP_HEADER
*) Storage
)->OpCode
== EFI_IFR_VARSTORE_NAME_VALUE_OP
) {
2026 Name
= GetNameFromId (DatabaseRecord
, Header
->VarStoreInfo
.VarName
);
2028 Offset
= Header
->VarStoreInfo
.VarOffset
;
2029 Width
= GetWidth (OpCode
);
2031 RequestElement
= ConstructRequestElement(Name
, Offset
, Width
);
2032 ConfigHdr
= ConstructConfigHdr(Storage
, DatabaseRecord
->DriverHandle
);
2033 ASSERT (ConfigHdr
!= NULL
);
2035 Length
= (StrLen (ConfigHdr
) + 1 + StrLen(RequestElement
) + 1) * sizeof (CHAR16
);
2036 *ConfigRequest
= AllocatePool (Length
);
2037 if (*ConfigRequest
== NULL
) {
2038 FreePool (ConfigHdr
);
2039 FreePool (RequestElement
);
2040 return EFI_OUT_OF_RESOURCES
;
2042 StringPtr
= *ConfigRequest
;
2044 StrCpy (StringPtr
, ConfigHdr
);
2045 StringPtr
+= StrLen (StringPtr
);
2050 StrCpy (StringPtr
, RequestElement
);
2051 StringPtr
+= StrLen (StringPtr
);
2054 FreePool (ConfigHdr
);
2055 FreePool (RequestElement
);
2061 return EFI_NOT_FOUND
;
2065 Base on the input parameter to generate the ConfigResp string.
2067 This is a internal function.
2069 @param DatabaseRecord HII_DATABASE_RECORD format string.
2070 @param KeywordStrId Keyword string id.
2071 @param ValueElement The value for the question which use keyword string id
2072 as the prompt string id.
2073 @param OpCodeData The IFR data for this question.
2074 @param ConfigResp Return the generate ConfigResp string.
2076 @retval EFI_SUCCESS Generate ConfigResp string success.
2077 @retval EFI_OUT_OF_RESOURCES System out of memory resource error.
2078 @retval EFI_NOT_FOUND Not found the question which use this string id
2079 as the prompt string id.
2083 IN HII_DATABASE_RECORD
*DatabaseRecord
,
2084 IN EFI_STRING_ID KeywordStrId
,
2085 IN EFI_STRING ValueElement
,
2086 OUT UINT8
**OpCodeData
,
2087 OUT EFI_STRING
*ConfigResp
2091 HII_DATABASE_PACKAGE_LIST_INSTANCE
*PackageListNode
;
2092 HII_IFR_PACKAGE_INSTANCE
*FormPackage
;
2093 EFI_IFR_QUESTION_HEADER
*Header
;
2100 CHAR16
*RequestElement
;
2104 ASSERT ((DatabaseRecord
!= NULL
) && (OpCodeData
!= NULL
) && (ConfigResp
!= NULL
) && (ValueElement
!= NULL
));
2111 PackageListNode
= DatabaseRecord
->PackageList
;
2114 // Search the languages in the specified packagelist.
2116 for (Link
= PackageListNode
->FormPkgHdr
.ForwardLink
; Link
!= &PackageListNode
->FormPkgHdr
; Link
= Link
->ForwardLink
) {
2117 FormPackage
= CR (Link
, HII_IFR_PACKAGE_INSTANCE
, IfrEntry
, HII_IFR_PACKAGE_SIGNATURE
);
2119 OpCode
= FindQuestionFromStringId (FormPackage
, KeywordStrId
);
2120 if (OpCode
!= NULL
) {
2121 *OpCodeData
= OpCode
;
2122 Header
= (EFI_IFR_QUESTION_HEADER
*) (OpCode
+ sizeof (EFI_IFR_OP_HEADER
));
2124 // Header->VarStoreId == 0 means no storage for this question.
2126 ASSERT (Header
->VarStoreId
!= 0);
2127 DEBUG ((EFI_D_INFO
, "Varstore Id: 0x%x\n", Header
->VarStoreId
));
2129 Storage
= FindStorageFromVarId (FormPackage
, Header
->VarStoreId
);
2130 ASSERT (Storage
!= NULL
);
2132 if (((EFI_IFR_OP_HEADER
*) Storage
)->OpCode
== EFI_IFR_VARSTORE_NAME_VALUE_OP
) {
2133 Name
= GetNameFromId (DatabaseRecord
, Header
->VarStoreInfo
.VarName
);
2135 Offset
= Header
->VarStoreInfo
.VarOffset
;
2136 Width
= GetWidth (OpCode
);
2138 RequestElement
= ConstructRequestElement(Name
, Offset
, Width
);
2140 ConfigHdr
= ConstructConfigHdr(Storage
, DatabaseRecord
->DriverHandle
);
2141 ASSERT (ConfigHdr
!= NULL
);
2143 Length
= (StrLen (ConfigHdr
) + 1 + StrLen(RequestElement
) + 1 + StrLen (L
"VALUE=") + StrLen(ValueElement
) + 1) * sizeof (CHAR16
);
2144 *ConfigResp
= AllocatePool (Length
);
2145 if (*ConfigResp
== NULL
) {
2146 FreePool (ConfigHdr
);
2147 FreePool (RequestElement
);
2148 return EFI_OUT_OF_RESOURCES
;
2150 StringPtr
= *ConfigResp
;
2152 StrCpy (StringPtr
, ConfigHdr
);
2153 StringPtr
+= StrLen (StringPtr
);
2158 StrCpy (StringPtr
, RequestElement
);
2159 StringPtr
+= StrLen (StringPtr
);
2164 StrCpy (StringPtr
, L
"VALUE=");
2165 StringPtr
+= StrLen (StringPtr
);
2167 StrCpy (StringPtr
, ValueElement
);
2168 StringPtr
+= StrLen (StringPtr
);
2171 FreePool (ConfigHdr
);
2172 FreePool (RequestElement
);
2178 return EFI_NOT_FOUND
;
2182 Get the Value section from the Hii driver.
2184 This is a internal function.
2186 @param ConfigRequest The input ConfigRequest string.
2187 @param ValueElement The respond Value section from the hii driver.
2189 @retval Misc value The error status return from ExtractConfig function.
2190 @retval EFI_OUT_OF_RESOURCES The memory can't be allocated
2191 @retval EFI_SUCCESS Get the value section success.
2195 ExtractValueFromDriver (
2196 IN CHAR16
*ConfigRequest
,
2197 OUT CHAR16
**ValueElement
2202 EFI_STRING Progress
;
2206 ASSERT ((ConfigRequest
!= NULL
) && (ValueElement
!= NULL
));
2208 Status
= mPrivate
.ConfigRouting
.ExtractConfig (
2209 &mPrivate
.ConfigRouting
,
2210 (EFI_STRING
) ConfigRequest
,
2214 if (EFI_ERROR (Status
)) {
2219 // Find Value Section and return it.
2221 StringPtr
= StrStr (Result
, L
"&VALUE=");
2222 ASSERT (StringPtr
!= NULL
);
2223 StringEnd
= StrStr (StringPtr
+ 1, L
"&");
2224 if (StringEnd
!= NULL
) {
2228 *ValueElement
= AllocateCopyPool (StrSize (StringPtr
), StringPtr
);
2229 if (*ValueElement
== NULL
) {
2230 return EFI_OUT_OF_RESOURCES
;
2233 if (StringEnd
!= NULL
) {
2242 Get EFI_STRING_ID info from the input device path, namespace and keyword.
2244 This is a internal function.
2246 @param DevicePath Input device path info.
2247 @param NameSpace NameSpace format string.
2248 @param KeywordData Keyword used to get string id.
2249 @param ProgressErr Return extra error type.
2250 @param KeywordStringId Return EFI_STRING_ID.
2251 @param DataBaseRecord DataBase record data for this driver.
2253 @retval EFI_INVALID_PARAMETER Can't find the database record base on the input device path or namespace.
2254 @retval EFI_NOT_FOUND Can't find the EFI_STRING_ID for the keyword.
2255 @retval EFI_SUCCESS Find the EFI_STRING_ID.
2259 GetStringIdFromDatabase (
2260 IN EFI_DEVICE_PATH_PROTOCOL
**DevicePath
,
2261 IN CHAR8
**NameSpace
,
2262 IN CHAR16
*KeywordData
,
2263 OUT UINT32
*ProgressErr
,
2264 OUT EFI_STRING_ID
*KeywordStringId
,
2265 OUT HII_DATABASE_RECORD
**DataBaseRecord
2268 HII_DATABASE_RECORD
*Record
;
2270 BOOLEAN FindNameSpace
;
2271 EFI_DEVICE_PATH_PROTOCOL
*DestDevicePath
;
2272 UINT8
*DevicePathPkg
;
2273 UINTN DevicePathSize
;
2275 ASSERT ((NameSpace
!= NULL
) && (KeywordData
!= NULL
) && (ProgressErr
!= NULL
) && (KeywordStringId
!= NULL
) && (DataBaseRecord
!= NULL
));
2277 FindNameSpace
= FALSE
;
2279 if (*DevicePath
!= NULL
) {
2281 // Get DataBaseRecord from device path protocol.
2283 Record
= GetRecordFromDevicePath(*DevicePath
);
2284 if (Record
== NULL
) {
2286 // Can't find the DatabaseRecord base on the input device path info.
2287 // NEED TO CONFIRM the return ProgressErr.
2289 *ProgressErr
= KEYWORD_HANDLER_MALFORMED_STRING
;
2290 return EFI_INVALID_PARAMETER
;
2294 // Get string id from the record.
2296 *ProgressErr
= GetStringIdFromRecord (Record
, NameSpace
, KeywordData
, KeywordStringId
);
2297 switch (*ProgressErr
) {
2298 case KEYWORD_HANDLER_NO_ERROR
:
2299 *DataBaseRecord
= Record
;
2302 case KEYWORD_HANDLER_NAMESPACE_ID_NOT_FOUND
:
2303 return EFI_INVALID_PARAMETER
;
2306 ASSERT (*ProgressErr
== KEYWORD_HANDLER_KEYWORD_NOT_FOUND
);
2307 return EFI_NOT_FOUND
;
2311 // Find driver which matches the routing data.
2313 for (Link
= mPrivate
.DatabaseList
.ForwardLink
; Link
!= &mPrivate
.DatabaseList
; Link
= Link
->ForwardLink
) {
2314 Record
= CR (Link
, HII_DATABASE_RECORD
, DatabaseEntry
, HII_DATABASE_RECORD_SIGNATURE
);
2316 *ProgressErr
= GetStringIdFromRecord (Record
, NameSpace
, KeywordData
, KeywordStringId
);
2317 if (*ProgressErr
== KEYWORD_HANDLER_NO_ERROR
) {
2318 *DataBaseRecord
= Record
;
2320 if ((DevicePathPkg
= Record
->PackageList
->DevicePathPkg
) != NULL
) {
2321 DestDevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) (DevicePathPkg
+ sizeof (EFI_HII_PACKAGE_HEADER
));
2322 DevicePathSize
= GetDevicePathSize ((EFI_DEVICE_PATH_PROTOCOL
*) DestDevicePath
);
2323 *DevicePath
= AllocateCopyPool (DevicePathSize
, DestDevicePath
);
2324 if (*DevicePath
== NULL
) {
2325 return EFI_OUT_OF_RESOURCES
;
2329 // Need to verify this ASSERT.
2335 } else if (*ProgressErr
== KEYWORD_HANDLER_UNDEFINED_PROCESSING_ERROR
) {
2336 return EFI_OUT_OF_RESOURCES
;
2337 } else if (*ProgressErr
== KEYWORD_HANDLER_KEYWORD_NOT_FOUND
) {
2338 FindNameSpace
= TRUE
;
2343 // When PathHdr not input, if ever find the namespace, will return KEYWORD_HANDLER_KEYWORD_NOT_FOUND.
2344 // This is a bit more progress than KEYWORD_HANDLER_NAMESPACE_ID_NOT_FOUND.
2346 if (FindNameSpace
) {
2347 return EFI_NOT_FOUND
;
2349 return EFI_INVALID_PARAMETER
;
2355 Genereate the KeywordResp String.
2357 <KeywordResp> ::= <NameSpaceId><PathHdr>'&'<Keyword>'&VALUE='<Number>['&READONLY']
2359 @param NameSpace NameSpace format string.
2360 @param DevicePath Input device path info.
2361 @param KeywordData Keyword used to get string id.
2362 @param ValueStr The value section for the keyword.
2363 @param ReadOnly Whether this value is readonly.
2364 @param KeywordResp Return the point to the KeywordResp string.
2366 @retval EFI_OUT_OF_RESOURCES The memory can't be allocated.
2367 @retval EFI_SUCCESS Generate the KeywordResp string.
2371 GenerateKeywordResp (
2372 IN CHAR8
*NameSpace
,
2373 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
2374 IN EFI_STRING KeywordData
,
2375 IN EFI_STRING ValueStr
,
2376 IN BOOLEAN ReadOnly
,
2377 OUT EFI_STRING
*KeywordResp
2383 CHAR16
*UnicodeNameSpace
;
2385 ASSERT ((NameSpace
!= NULL
) && (DevicePath
!= NULL
) && (KeywordData
!= NULL
) && (ValueStr
!= NULL
) && (KeywordResp
!= NULL
));
2388 // 1. Calculate the string length.
2391 // 1.1 NameSpaceId size.
2392 // 'NAMESPACE='<String>
2394 RespStrLen
= 10 + AsciiStrLen (NameSpace
);
2395 UnicodeNameSpace
= AllocatePool ((AsciiStrLen (NameSpace
) + 1) * sizeof (CHAR16
));
2396 if (UnicodeNameSpace
== NULL
) {
2397 return EFI_OUT_OF_RESOURCES
;
2399 AsciiStrToUnicodeStr(NameSpace
, UnicodeNameSpace
);
2402 // 1.2 PathHdr size.
2403 // PATH=<UEFI binary Device Path represented as hex number>'&'
2404 // Attention: The output include the '&' at the end.
2408 GetDevicePathSize ((EFI_DEVICE_PATH_PROTOCOL
*) DevicePath
),
2409 (VOID
*) DevicePath
,
2413 RespStrLen
+= StrLen (PathHdr
);
2416 // 1.3 Keyword setion.
2417 // 'KEYWORD='<String>[':'<DecCh>(1/4)]
2419 RespStrLen
+= 8 + StrLen (KeywordData
);
2422 // 1.4 Value section.
2423 // ValueStr = '&VALUE='<Number>
2425 RespStrLen
+= StrLen (ValueStr
);
2428 // 1.5 ReadOnly Section.
2436 // 2. Allocate the buffer and create the KeywordResp string.
2438 *KeywordResp
= AllocatePool ((RespStrLen
+ 1) * sizeof (CHAR16
));
2439 if (*KeywordResp
== NULL
) {
2440 if (UnicodeNameSpace
!= NULL
) {
2441 FreePool (UnicodeNameSpace
);
2444 return EFI_OUT_OF_RESOURCES
;
2446 RespStr
= *KeywordResp
;
2449 // 2.1 Copy NameSpaceId section.
2451 StrCpy (RespStr
, L
"NAMESPACE=");
2452 RespStr
+= StrLen (RespStr
);
2453 StrCpy (RespStr
, UnicodeNameSpace
);
2454 RespStr
+= StrLen (RespStr
);
2457 // 2.2 Copy PathHdr section.
2459 StrCpy (RespStr
, PathHdr
);
2460 RespStr
+= StrLen (RespStr
);
2463 // 2.3 Copy Keyword section.
2465 StrCpy (RespStr
, L
"KEYWORD=");
2466 RespStr
+= StrLen (RespStr
);
2467 StrCpy (RespStr
, KeywordData
);
2468 RespStr
+= StrLen (RespStr
);
2471 // 2.4 Copy the Value section.
2473 StrCpy (RespStr
, ValueStr
);
2474 RespStr
+= StrLen (RespStr
);
2477 // 2.5 Copy ReadOnly section if exist.
2480 StrCpy (RespStr
, L
"&READONLY");
2481 RespStr
+= StrLen (RespStr
);
2489 if (UnicodeNameSpace
!= NULL
) {
2490 FreePool (UnicodeNameSpace
);
2492 if (PathHdr
!= NULL
) {
2500 Merge the KeywordResp String to MultiKeywordResp string.
2502 This is a internal function.
2504 @param MultiKeywordResp The existed multikeywordresp string.
2505 @param KeywordResp The input keywordResp string.
2507 @retval EFI_OUT_OF_RESOURCES The memory can't be allocated.
2508 @retval EFI_SUCCESS Generate the MultiKeywordResp string.
2512 MergeToMultiKeywordResp (
2513 IN OUT EFI_STRING
*MultiKeywordResp
,
2514 IN EFI_STRING
*KeywordResp
2517 UINTN MultiKeywordRespLen
;
2518 EFI_STRING StringPtr
;
2520 if (*MultiKeywordResp
== NULL
) {
2521 *MultiKeywordResp
= *KeywordResp
;
2522 *KeywordResp
= NULL
;
2526 MultiKeywordRespLen
= (StrLen (*MultiKeywordResp
) + 1 + StrLen (*KeywordResp
) + 1) * sizeof (CHAR16
);
2528 StringPtr
= AllocateCopyPool (MultiKeywordRespLen
, *MultiKeywordResp
);
2529 if (StringPtr
== NULL
) {
2530 return EFI_OUT_OF_RESOURCES
;
2533 FreePool (*MultiKeywordResp
);
2534 *MultiKeywordResp
= StringPtr
;
2536 StringPtr
+= StrLen (StringPtr
);
2541 StrCpy (StringPtr
, *KeywordResp
);
2547 Enumerate all keyword in the system.
2549 If error occur when parse one keyword, just skip it and parse the next one.
2551 This is a internal function.
2553 @param NameSpace The namespace used to search the string.
2554 @param MultiResp Return the MultiKeywordResp string for the system.
2556 @retval EFI_OUT_OF_RESOURCES The memory can't be allocated.
2557 @retval EFI_SUCCESS Generate the MultiKeywordResp string.
2558 @retval EFI_NOT_FOUND No keyword found.
2562 EnumerateAllKeywords (
2563 IN CHAR8
*NameSpace
,
2564 OUT EFI_STRING
*MultiResp
2568 LIST_ENTRY
*StringLink
;
2569 UINT8
*DevicePathPkg
;
2571 HII_DATABASE_RECORD
*DataBaseRecord
;
2572 HII_DATABASE_PACKAGE_LIST_INSTANCE
*PackageListNode
;
2573 HII_STRING_PACKAGE_INSTANCE
*StringPackage
;
2574 CHAR8
*LocalNameSpace
;
2575 EFI_STRING_ID NextStringId
;
2578 CHAR16
*ConfigRequest
;
2579 CHAR16
*ValueElement
;
2580 CHAR16
*KeywordResp
;
2581 CHAR16
*MultiKeywordResp
;
2582 CHAR16
*KeywordData
;
2585 DataBaseRecord
= NULL
;
2586 Status
= EFI_SUCCESS
;
2587 MultiKeywordResp
= NULL
;
2589 LocalNameSpace
= NULL
;
2590 ConfigRequest
= NULL
;
2591 ValueElement
= NULL
;
2594 if (NameSpace
== NULL
) {
2595 NameSpace
= UEFI_CONFIG_LANG
;
2599 // Find driver which matches the routing data.
2601 for (Link
= mPrivate
.DatabaseList
.ForwardLink
; Link
!= &mPrivate
.DatabaseList
; Link
= Link
->ForwardLink
) {
2602 DataBaseRecord
= CR (Link
, HII_DATABASE_RECORD
, DatabaseEntry
, HII_DATABASE_RECORD_SIGNATURE
);
2603 if ((DevicePathPkg
= DataBaseRecord
->PackageList
->DevicePathPkg
) != NULL
) {
2604 DevicePath
= DevicePathPkg
+ sizeof (EFI_HII_PACKAGE_HEADER
);
2606 PackageListNode
= DataBaseRecord
->PackageList
;
2608 for (StringLink
= PackageListNode
->StringPkgHdr
.ForwardLink
; StringLink
!= &PackageListNode
->StringPkgHdr
; StringLink
= StringLink
->ForwardLink
) {
2609 StringPackage
= CR (StringLink
, HII_STRING_PACKAGE_INSTANCE
, StringEntry
, HII_STRING_PACKAGE_SIGNATURE
);
2612 // Check whether has keyword string package.
2614 if (AsciiStrnCmp(NameSpace
, StringPackage
->StringPkgHdr
->Language
, AsciiStrLen (NameSpace
)) == 0) {
2616 // Keep the NameSpace string.
2618 LocalNameSpace
= AllocateCopyPool (AsciiStrSize (StringPackage
->StringPkgHdr
->Language
), StringPackage
->StringPkgHdr
->Language
);
2619 if (LocalNameSpace
== NULL
) {
2620 return EFI_OUT_OF_RESOURCES
;
2624 // 1 means just begin the enumerate the valid string ids.
2625 // StringId == 1 is always used to save the language for this string package.
2626 // Any valid string start from 2. so here initial it to 1.
2631 // Enumerate all valid stringid in the package.
2633 while ((NextStringId
= GetNextStringId (StringPackage
, NextStringId
, &KeywordData
)) != 0) {
2635 // 3.3 Construct the ConfigRequest string.
2637 Status
= ExtractConfigRequest (DataBaseRecord
, NextStringId
, &OpCode
, &ConfigRequest
);
2638 if (EFI_ERROR (Status
)) {
2640 // If can't generate ConfigRequest for this question, skip it and start the next.
2646 // 3.4 Extract Value for the input keyword.
2648 Status
= ExtractValueFromDriver(ConfigRequest
, &ValueElement
);
2649 if (EFI_ERROR (Status
)) {
2650 if (Status
!= EFI_OUT_OF_RESOURCES
) {
2652 // If can't generate ConfigRequest for this question, skip it and start the next.
2657 // If EFI_OUT_OF_RESOURCES error occur, no need to continue.
2663 // Extract readonly flag from opcode.
2665 ReadOnly
= ExtractReadOnlyFromOpCode(OpCode
);
2668 // 5. Generate KeywordResp string.
2670 ASSERT (DevicePath
!= NULL
);
2671 Status
= GenerateKeywordResp(LocalNameSpace
, (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
, KeywordData
, ValueElement
, ReadOnly
, &KeywordResp
);
2672 if (Status
!= EFI_SUCCESS
) {
2674 // If EFI_OUT_OF_RESOURCES error occur, no need to continue.
2680 // 6. Merge to the MultiKeywordResp string.
2682 Status
= MergeToMultiKeywordResp(&MultiKeywordResp
, &KeywordResp
);
2683 if (EFI_ERROR (Status
)) {
2688 // Clean the temp buffer to later use again.
2690 if (ConfigRequest
!= NULL
) {
2691 FreePool (ConfigRequest
);
2692 ConfigRequest
= NULL
;
2694 if (ValueElement
!= NULL
) {
2695 FreePool (ValueElement
);
2696 ValueElement
= NULL
;
2698 if (KeywordResp
!= NULL
) {
2699 FreePool (KeywordResp
);
2704 if (LocalNameSpace
!= NULL
) {
2705 FreePool (LocalNameSpace
);
2706 LocalNameSpace
= NULL
;
2713 // return the already get MultiKeywordString even error occured.
2715 if (MultiKeywordResp
== NULL
) {
2716 Status
= EFI_NOT_FOUND
;
2718 Status
= EFI_SUCCESS
;
2720 *MultiResp
= MultiKeywordResp
;
2723 if (LocalNameSpace
!= NULL
) {
2724 FreePool (LocalNameSpace
);
2726 if (ConfigRequest
!= NULL
) {
2727 FreePool (ConfigRequest
);
2729 if (ValueElement
!= NULL
) {
2730 FreePool (ValueElement
);
2738 This function accepts a <MultiKeywordResp> formatted string, finds the associated
2739 keyword owners, creates a <MultiConfigResp> string from it and forwards it to the
2740 EFI_HII_ROUTING_PROTOCOL.RouteConfig function.
2742 If there is an issue in resolving the contents of the KeywordString, then the
2743 function returns an error and also sets the Progress and ProgressErr with the
2744 appropriate information about where the issue occurred and additional data about
2745 the nature of the issue.
2747 In the case when KeywordString containing multiple keywords, when an EFI_NOT_FOUND
2748 error is generated during processing the second or later keyword element, the system
2749 storage associated with earlier keywords is not modified. All elements of the
2750 KeywordString must successfully pass all tests for format and access prior to making
2751 any modifications to storage.
2753 In the case when EFI_DEVICE_ERROR is returned from the processing of a KeywordString
2754 containing multiple keywords, the state of storage associated with earlier keywords
2758 @param This Pointer to the EFI_KEYWORD_HANDLER _PROTOCOL instance.
2760 @param KeywordString A null-terminated string in <MultiKeywordResp> format.
2762 @param Progress On return, points to a character in the KeywordString.
2763 Points to the string's NULL terminator if the request
2764 was successful. Points to the most recent '&' before
2765 the first failing string element if the request was
2768 @param ProgressErr If during the processing of the KeywordString there was
2769 a failure, this parameter gives additional information
2770 about the possible source of the problem. The various
2771 errors are defined in "Related Definitions" below.
2774 @retval EFI_SUCCESS The specified action was completed successfully.
2776 @retval EFI_INVALID_PARAMETER One or more of the following are TRUE:
2777 1. KeywordString is NULL.
2778 2. Parsing of the KeywordString resulted in an
2779 error. See Progress and ProgressErr for more data.
2781 @retval EFI_NOT_FOUND An element of the KeywordString was not found.
2782 See ProgressErr for more data.
2784 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
2785 See ProgressErr for more data.
2787 @retval EFI_ACCESS_DENIED The action violated system policy. See ProgressErr
2790 @retval EFI_DEVICE_ERROR An unexpected system error occurred. See ProgressErr
2796 EfiConfigKeywordHandlerSetData (
2797 IN EFI_CONFIG_KEYWORD_HANDLER_PROTOCOL
*This
,
2798 IN CONST EFI_STRING KeywordString
,
2799 OUT EFI_STRING
*Progress
,
2800 OUT UINT32
*ProgressErr
2806 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
2807 CHAR16
*NextStringPtr
;
2808 CHAR16
*KeywordData
;
2809 EFI_STRING_ID KeywordStringId
;
2811 HII_DATABASE_RECORD
*DataBaseRecord
;
2814 CHAR16
*MultiConfigResp
;
2815 CHAR16
*ValueElement
;
2817 EFI_STRING InternalProgress
;
2819 if (This
== NULL
|| Progress
== NULL
|| ProgressErr
== NULL
|| KeywordString
== NULL
) {
2820 return EFI_INVALID_PARAMETER
;
2823 *Progress
= KeywordString
;
2824 *ProgressErr
= KEYWORD_HANDLER_UNDEFINED_PROCESSING_ERROR
;
2825 Status
= EFI_SUCCESS
;
2826 StringPtr
= KeywordString
;
2827 MultiConfigResp
= NULL
;
2831 ValueElement
= NULL
;
2833 KeywordStringId
= 0;
2835 while ((StringPtr
!= NULL
) && (*StringPtr
!= L
'\0')) {
2837 // 1. Get NameSpace from NameSpaceId keyword.
2839 Status
= ExtractNameSpace (StringPtr
, &NameSpace
, &NextStringPtr
);
2840 if (EFI_ERROR (Status
)) {
2841 *ProgressErr
= KEYWORD_HANDLER_MALFORMED_STRING
;
2844 StringPtr
= NextStringPtr
;
2847 // 2. Get possible Device Path info from KeywordString.
2849 Status
= ExtractDevicePath (StringPtr
, (UINT8
**)&DevicePath
, &NextStringPtr
);
2850 if (EFI_ERROR (Status
)) {
2851 *ProgressErr
= KEYWORD_HANDLER_MALFORMED_STRING
;
2854 StringPtr
= NextStringPtr
;
2857 // 3. Extract keyword from the KeywordRequest string.
2859 Status
= ExtractKeyword(StringPtr
, &KeywordData
, &NextStringPtr
);
2860 if (EFI_ERROR (Status
)) {
2862 // Can't find Keyword base on the input device path info.
2864 *ProgressErr
= KEYWORD_HANDLER_MALFORMED_STRING
;
2865 Status
= EFI_INVALID_PARAMETER
;
2868 StringPtr
= NextStringPtr
;
2871 // 4. Extract Value from the KeywordRequest string.
2873 Status
= ExtractValue (StringPtr
, &ValueElement
, &NextStringPtr
);
2874 if (EFI_ERROR (Status
)) {
2876 // Can't find Value base on the input device path info.
2878 *ProgressErr
= KEYWORD_HANDLER_MALFORMED_STRING
;
2879 Status
= EFI_INVALID_PARAMETER
;
2882 StringPtr
= NextStringPtr
;
2885 // 5. Find ReadOnly filter.
2887 if ((StringPtr
!= NULL
) && StrnCmp (StringPtr
, L
"&ReadOnly", StrLen (L
"&ReadOnly")) == 0) {
2889 StringPtr
+= StrLen (L
"&ReadOnly");
2895 // 6. Get EFI_STRING_ID for the input keyword.
2897 Status
= GetStringIdFromDatabase (&DevicePath
, &NameSpace
, KeywordData
, &RetVal
, &KeywordStringId
, &DataBaseRecord
);
2898 if (EFI_ERROR (Status
)) {
2899 *ProgressErr
= RetVal
;
2904 // 7. Construct the ConfigRequest string.
2906 Status
= ExtractConfigResp (DataBaseRecord
, KeywordStringId
, ValueElement
, &OpCode
, &ConfigResp
);
2907 if (EFI_ERROR (Status
)) {
2912 // 8. Check the readonly flag.
2914 if (ExtractReadOnlyFromOpCode (OpCode
) != ReadOnly
) {
2915 *ProgressErr
= KEYWORD_HANDLER_INCOMPATIBLE_VALUE_DETECTED
;
2916 Status
= EFI_INVALID_PARAMETER
;
2921 // 9. Merge to the MultiKeywordResp string.
2923 Status
= MergeToMultiKeywordResp(&MultiConfigResp
, &ConfigResp
);
2924 if (EFI_ERROR (Status
)) {
2929 // 10. Clean the temp buffer point.
2931 FreePool (NameSpace
);
2932 FreePool (DevicePath
);
2933 FreePool (KeywordData
);
2934 FreePool (ValueElement
);
2938 ValueElement
= NULL
;
2939 if (ConfigResp
!= NULL
) {
2940 FreePool (ConfigResp
);
2946 // 11. Set value to driver.
2948 Status
= mPrivate
.ConfigRouting
.RouteConfig(
2949 &mPrivate
.ConfigRouting
,
2950 (EFI_STRING
) MultiConfigResp
,
2953 if (EFI_ERROR (Status
)) {
2954 Status
= EFI_DEVICE_ERROR
;
2958 *ProgressErr
= KEYWORD_HANDLER_NO_ERROR
;
2961 if (NameSpace
!= NULL
) {
2962 FreePool (NameSpace
);
2964 if (DevicePath
!= NULL
) {
2965 FreePool (DevicePath
);
2967 if (KeywordData
!= NULL
) {
2968 FreePool (KeywordData
);
2970 if (ValueElement
!= NULL
) {
2971 FreePool (ValueElement
);
2973 if (ConfigResp
!= NULL
) {
2974 FreePool (ConfigResp
);
2976 if (MultiConfigResp
!= NULL
&& MultiConfigResp
!= ConfigResp
) {
2977 FreePool (MultiConfigResp
);
2979 *Progress
= StringPtr
;
2985 This function accepts a <MultiKeywordRequest> formatted string, finds the underlying
2986 keyword owners, creates a <MultiConfigRequest> string from it and forwards it to the
2987 EFI_HII_ROUTING_PROTOCOL.ExtractConfig function.
2989 If there is an issue in resolving the contents of the KeywordString, then the function
2990 returns an EFI_INVALID_PARAMETER and also set the Progress and ProgressErr with the
2991 appropriate information about where the issue occurred and additional data about the
2992 nature of the issue.
2994 In the case when KeywordString is NULL, or contains multiple keywords, or when
2995 EFI_NOT_FOUND is generated while processing the keyword elements, the Results string
2996 contains values returned for all keywords processed prior to the keyword generating the
2997 error but no values for the keyword with error or any following keywords.
3000 @param This Pointer to the EFI_KEYWORD_HANDLER _PROTOCOL instance.
3002 @param NameSpaceId A null-terminated string containing the platform configuration
3003 language to search through in the system. If a NULL is passed
3004 in, then it is assumed that any platform configuration language
3005 with the prefix of "x-UEFI-" are searched.
3007 @param KeywordString A null-terminated string in <MultiKeywordRequest> format. If a
3008 NULL is passed in the KeywordString field, all of the known
3009 keywords in the system for the NameSpaceId specified are
3010 returned in the Results field.
3012 @param Progress On return, points to a character in the KeywordString. Points
3013 to the string's NULL terminator if the request was successful.
3014 Points to the most recent '&' before the first failing string
3015 element if the request was not successful.
3017 @param ProgressErr If during the processing of the KeywordString there was a
3018 failure, this parameter gives additional information about the
3019 possible source of the problem. See the definitions in SetData()
3020 for valid value definitions.
3022 @param Results A null-terminated string in <MultiKeywordResp> format is returned
3023 which has all the values filled in for the keywords in the
3024 KeywordString. This is a callee-allocated field, and must be freed
3025 by the caller after being used.
3027 @retval EFI_SUCCESS The specified action was completed successfully.
3029 @retval EFI_INVALID_PARAMETER One or more of the following are TRUE:
3030 1.Progress, ProgressErr, or Resuts is NULL.
3031 2.Parsing of the KeywordString resulted in an error. See
3032 Progress and ProgressErr for more data.
3035 @retval EFI_NOT_FOUND An element of the KeywordString was not found. See
3036 ProgressErr for more data.
3038 @retval EFI_NOT_FOUND The NamespaceId specified was not found. See ProgressErr
3041 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. See
3042 ProgressErr for more data.
3044 @retval EFI_ACCESS_DENIED The action violated system policy. See ProgressErr for
3047 @retval EFI_DEVICE_ERROR An unexpected system error occurred. See ProgressErr
3053 EfiConfigKeywordHandlerGetData (
3054 IN EFI_CONFIG_KEYWORD_HANDLER_PROTOCOL
*This
,
3055 IN CONST EFI_STRING NameSpaceId
, OPTIONAL
3056 IN CONST EFI_STRING KeywordString
, OPTIONAL
3057 OUT EFI_STRING
*Progress
,
3058 OUT UINT32
*ProgressErr
,
3059 OUT EFI_STRING
*Results
3064 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
3065 HII_DATABASE_RECORD
*DataBaseRecord
;
3067 CHAR16
*NextStringPtr
;
3068 CHAR16
*KeywordData
;
3069 EFI_STRING_ID KeywordStringId
;
3071 CHAR16
*ConfigRequest
;
3072 CHAR16
*ValueElement
;
3075 CHAR16
*KeywordResp
;
3076 CHAR16
*MultiKeywordResp
;
3078 if (This
== NULL
|| Progress
== NULL
|| ProgressErr
== NULL
|| Results
== NULL
) {
3079 return EFI_INVALID_PARAMETER
;
3082 *ProgressErr
= KEYWORD_HANDLER_UNDEFINED_PROCESSING_ERROR
;
3083 Status
= EFI_SUCCESS
;
3087 ConfigRequest
= NULL
;
3088 StringPtr
= KeywordString
;
3090 MultiKeywordResp
= NULL
;
3091 KeywordStringId
= 0;
3094 // 1. Get NameSpace from NameSpaceId keyword.
3096 Status
= ExtractNameSpace (NameSpaceId
, &NameSpace
, NULL
);
3097 if (EFI_ERROR (Status
)) {
3098 *ProgressErr
= KEYWORD_HANDLER_NAMESPACE_ID_NOT_FOUND
;
3102 if (KeywordString
!= NULL
) {
3103 StringPtr
= KeywordString
;
3105 while (*StringPtr
!= L
'\0') {
3107 // 2. Get possible Device Path info from KeywordString.
3109 Status
= ExtractDevicePath (StringPtr
, (UINT8
**)&DevicePath
, &NextStringPtr
);
3110 if (EFI_ERROR (Status
)) {
3111 *ProgressErr
= KEYWORD_HANDLER_MALFORMED_STRING
;
3114 StringPtr
= NextStringPtr
;
3118 // 3. Process Keyword section from the input keywordRequest string.
3120 // 3.1 Extract keyword from the KeywordRequest string.
3122 Status
= ExtractKeyword(StringPtr
, &KeywordData
, &NextStringPtr
);
3123 if (EFI_ERROR (Status
)) {
3125 // Can't find Keyword base on the input device path info.
3127 *ProgressErr
= KEYWORD_HANDLER_MALFORMED_STRING
;
3128 Status
= EFI_INVALID_PARAMETER
;
3133 // 3.2 Get EFI_STRING_ID for the input keyword.
3135 Status
= GetStringIdFromDatabase (&DevicePath
, &NameSpace
, KeywordData
, &RetVal
, &KeywordStringId
, &DataBaseRecord
);
3136 if (EFI_ERROR (Status
)) {
3137 *ProgressErr
= RetVal
;
3142 // 3.3 Construct the ConfigRequest string.
3144 Status
= ExtractConfigRequest (DataBaseRecord
, KeywordStringId
, &OpCode
, &ConfigRequest
);
3145 if (EFI_ERROR (Status
)) {
3150 // 3.4 Extract Value for the input keyword.
3152 Status
= ExtractValueFromDriver(ConfigRequest
, &ValueElement
);
3153 if (EFI_ERROR (Status
)) {
3154 if (Status
!= EFI_OUT_OF_RESOURCES
) {
3155 Status
= EFI_DEVICE_ERROR
;
3159 StringPtr
= NextStringPtr
;
3162 // 4. Process the possible filter section.
3164 RetVal
= ValidateFilter (OpCode
, StringPtr
, &NextStringPtr
, &ReadOnly
);
3165 if (RetVal
!= KEYWORD_HANDLER_NO_ERROR
) {
3166 *ProgressErr
= RetVal
;
3167 Status
= EFI_INVALID_PARAMETER
;
3170 StringPtr
= NextStringPtr
;
3174 // 5. Generate KeywordResp string.
3176 Status
= GenerateKeywordResp(NameSpace
, DevicePath
, KeywordData
, ValueElement
, ReadOnly
, &KeywordResp
);
3177 if (Status
!= EFI_SUCCESS
) {
3182 // 6. Merge to the MultiKeywordResp string.
3184 Status
= MergeToMultiKeywordResp(&MultiKeywordResp
, &KeywordResp
);
3185 if (EFI_ERROR (Status
)) {
3190 // 7. Update return value.
3192 *Results
= MultiKeywordResp
;
3195 // 8. Clean the temp buffer.
3197 FreePool (DevicePath
);
3198 FreePool (KeywordData
);
3199 FreePool (ValueElement
);
3200 FreePool (ConfigRequest
);
3203 ValueElement
= NULL
;
3204 ConfigRequest
= NULL
;
3205 if (KeywordResp
!= NULL
) {
3206 FreePool (KeywordResp
);
3212 // Enumerate all keyword in the system.
3214 Status
= EnumerateAllKeywords(NameSpace
, &MultiKeywordResp
);
3215 if (EFI_ERROR (Status
)) {
3218 *Results
= MultiKeywordResp
;
3221 *ProgressErr
= KEYWORD_HANDLER_NO_ERROR
;
3224 if (NameSpace
!= NULL
) {
3225 FreePool (NameSpace
);
3227 if (DevicePath
!= NULL
) {
3228 FreePool (DevicePath
);
3230 if (KeywordData
!= NULL
) {
3231 FreePool (KeywordData
);
3233 *Progress
= StringPtr
;