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 return KEYWORD_HANDLER_KEYWORD_NOT_FOUND
;
1345 if (*NameSpace
== NULL
) {
1346 *NameSpace
= AllocateCopyPool (AsciiStrSize (StringPackage
->StringPkgHdr
->Language
), StringPackage
->StringPkgHdr
->Language
);
1347 if (*NameSpace
== NULL
) {
1348 return KEYWORD_HANDLER_UNDEFINED_PROCESSING_ERROR
;
1351 return KEYWORD_HANDLER_NO_ERROR
;
1360 Tell whether this Operand is an Statement OpCode.
1362 @param Operand Operand of an IFR OpCode.
1364 @retval TRUE This is an Statement OpCode.
1365 @retval FALSE Not an Statement OpCode.
1373 if ((Operand
== EFI_IFR_SUBTITLE_OP
) ||
1374 (Operand
== EFI_IFR_TEXT_OP
) ||
1375 (Operand
== EFI_IFR_RESET_BUTTON_OP
) ||
1376 (Operand
== EFI_IFR_REF_OP
) ||
1377 (Operand
== EFI_IFR_ACTION_OP
) ||
1378 (Operand
== EFI_IFR_NUMERIC_OP
) ||
1379 (Operand
== EFI_IFR_ORDERED_LIST_OP
) ||
1380 (Operand
== EFI_IFR_CHECKBOX_OP
) ||
1381 (Operand
== EFI_IFR_STRING_OP
) ||
1382 (Operand
== EFI_IFR_PASSWORD_OP
) ||
1383 (Operand
== EFI_IFR_DATE_OP
) ||
1384 (Operand
== EFI_IFR_TIME_OP
) ||
1385 (Operand
== EFI_IFR_GUID_OP
) ||
1386 (Operand
== EFI_IFR_ONE_OF_OP
)) {
1394 Tell whether this Operand is an Statement OpCode.
1396 @param Operand Operand of an IFR OpCode.
1398 @retval TRUE This is an Statement OpCode.
1399 @retval FALSE Not an Statement OpCode.
1407 if ((Operand
== EFI_IFR_VARSTORE_OP
) ||
1408 (Operand
== EFI_IFR_VARSTORE_NAME_VALUE_OP
) ||
1409 (Operand
== EFI_IFR_VARSTORE_EFI_OP
)) {
1417 Base on the prompt string id to find the question.
1419 @param FormPackage The input form package.
1420 @param KeywordStrId The input prompt string id for one question.
1422 @retval the opcode for the question.
1426 FindQuestionFromStringId (
1427 IN HII_IFR_PACKAGE_INSTANCE
*FormPackage
,
1428 IN EFI_STRING_ID KeywordStrId
1433 EFI_IFR_STATEMENT_HEADER
*StatementHeader
;
1434 EFI_IFR_OP_HEADER
*OpCodeHeader
;
1437 ASSERT (FormPackage
!= NULL
);
1439 FormDataLen
= FormPackage
->FormPkgHdr
.Length
- sizeof (EFI_HII_PACKAGE_HEADER
);
1441 while (Offset
< FormDataLen
) {
1442 OpCodeData
= FormPackage
->IfrData
+ Offset
;
1443 OpCodeHeader
= (EFI_IFR_OP_HEADER
*) OpCodeData
;
1445 if (IsStatementOpCode(OpCodeHeader
->OpCode
)) {
1446 StatementHeader
= (EFI_IFR_STATEMENT_HEADER
*) (OpCodeData
+ sizeof (EFI_IFR_OP_HEADER
));
1447 if (StatementHeader
->Prompt
== KeywordStrId
) {
1452 Offset
+= OpCodeHeader
->Length
;
1459 Base on the varstore id to find the storage info.
1461 @param FormPackage The input form package.
1462 @param VarStoreId The input storage id.
1464 @retval the opcode for the storage.
1468 FindStorageFromVarId (
1469 IN HII_IFR_PACKAGE_INSTANCE
*FormPackage
,
1470 IN EFI_VARSTORE_ID VarStoreId
1475 EFI_IFR_OP_HEADER
*OpCodeHeader
;
1478 ASSERT (FormPackage
!= NULL
);
1480 FormDataLen
= FormPackage
->FormPkgHdr
.Length
- sizeof (EFI_HII_PACKAGE_HEADER
);
1482 while (Offset
< FormDataLen
) {
1483 OpCodeData
= FormPackage
->IfrData
+ Offset
;
1484 OpCodeHeader
= (EFI_IFR_OP_HEADER
*) OpCodeData
;
1486 if (IsStorageOpCode(OpCodeHeader
->OpCode
)) {
1487 switch (OpCodeHeader
->OpCode
) {
1488 case EFI_IFR_VARSTORE_OP
:
1489 if (VarStoreId
== ((EFI_IFR_VARSTORE
*) OpCodeData
)->VarStoreId
) {
1494 case EFI_IFR_VARSTORE_NAME_VALUE_OP
:
1495 if (VarStoreId
== ((EFI_IFR_VARSTORE_NAME_VALUE
*) OpCodeData
)->VarStoreId
) {
1500 case EFI_IFR_VARSTORE_EFI_OP
:
1501 if (VarStoreId
== ((EFI_IFR_VARSTORE_EFI
*) OpCodeData
)->VarStoreId
) {
1511 Offset
+= OpCodeHeader
->Length
;
1518 Get width info for one question.
1520 @param OpCodeData The input opcode for one question.
1522 @retval the width info for one question.
1527 IN UINT8
*OpCodeData
1530 UINT8
*NextOpCodeData
;
1532 ASSERT (OpCodeData
!= NULL
);
1534 switch (((EFI_IFR_OP_HEADER
*) OpCodeData
)->OpCode
) {
1535 case EFI_IFR_REF_OP
:
1536 return (UINT16
) sizeof (EFI_HII_REF
);
1538 case EFI_IFR_ONE_OF_OP
:
1539 case EFI_IFR_NUMERIC_OP
:
1540 switch (((EFI_IFR_ONE_OF
*) OpCodeData
)->Flags
& EFI_IFR_NUMERIC_SIZE
) {
1541 case EFI_IFR_NUMERIC_SIZE_1
:
1542 return (UINT16
) sizeof (UINT8
);
1544 case EFI_IFR_NUMERIC_SIZE_2
:
1545 return (UINT16
) sizeof (UINT16
);
1547 case EFI_IFR_NUMERIC_SIZE_4
:
1548 return (UINT16
) sizeof (UINT32
);
1550 case EFI_IFR_NUMERIC_SIZE_8
:
1551 return (UINT16
) sizeof (UINT64
);
1558 case EFI_IFR_ORDERED_LIST_OP
:
1559 NextOpCodeData
= OpCodeData
+ ((EFI_IFR_ORDERED_LIST
*) OpCodeData
)->Header
.Length
;
1561 // OneOfOption must follow the orderedlist opcode.
1563 ASSERT (((EFI_IFR_OP_HEADER
*) NextOpCodeData
)->OpCode
== EFI_IFR_ONE_OF_OPTION_OP
);
1564 switch (((EFI_IFR_ONE_OF_OPTION
*) NextOpCodeData
)->Type
) {
1565 case EFI_IFR_TYPE_NUM_SIZE_8
:
1566 return (UINT16
) sizeof (UINT8
) * ((EFI_IFR_ORDERED_LIST
*) OpCodeData
)->MaxContainers
;
1568 case EFI_IFR_TYPE_NUM_SIZE_16
:
1569 return (UINT16
) sizeof (UINT16
) * ((EFI_IFR_ORDERED_LIST
*) OpCodeData
)->MaxContainers
;
1571 case EFI_IFR_TYPE_NUM_SIZE_32
:
1572 return (UINT16
) sizeof (UINT32
) * ((EFI_IFR_ORDERED_LIST
*) OpCodeData
)->MaxContainers
;
1574 case EFI_IFR_TYPE_NUM_SIZE_64
:
1575 return (UINT16
) sizeof (UINT64
) * ((EFI_IFR_ORDERED_LIST
*) OpCodeData
)->MaxContainers
;
1582 case EFI_IFR_CHECKBOX_OP
:
1583 return (UINT16
) sizeof (BOOLEAN
);
1585 case EFI_IFR_PASSWORD_OP
:
1586 case EFI_IFR_STRING_OP
:
1587 return (UINT16
)((UINTN
) ((EFI_IFR_STRING
*) OpCodeData
)->MaxSize
* sizeof (CHAR16
));
1589 case EFI_IFR_DATE_OP
:
1590 return (UINT16
) sizeof (EFI_HII_DATE
);
1592 case EFI_IFR_TIME_OP
:
1593 return (UINT16
) sizeof (EFI_HII_TIME
);
1602 Converts all hex dtring characters in range ['A'..'F'] to ['a'..'f'] for
1603 hex digits that appear between a '=' and a '&' in a config string.
1605 If ConfigString is NULL, then ASSERT().
1607 @param[in] ConfigString Pointer to a Null-terminated Unicode string.
1609 @return Pointer to the Null-terminated Unicode result string.
1614 InternalLowerConfigString (
1615 IN EFI_STRING ConfigString
1621 ASSERT (ConfigString
!= NULL
);
1624 // Convert all hex digits in range [A-F] in the configuration header to [a-f]
1626 for (String
= ConfigString
, Lower
= FALSE
; *String
!= L
'\0'; String
++) {
1627 if (*String
== L
'=') {
1629 } else if (*String
== L
'&') {
1631 } else if (Lower
&& *String
>= L
'A' && *String
<= L
'F') {
1632 *String
= (CHAR16
) (*String
- L
'A' + L
'a');
1636 return ConfigString
;
1640 Allocates and returns a Null-terminated Unicode <ConfigHdr> string.
1642 The format of a <ConfigHdr> is as follows:
1644 GUID=<HexCh>32&NAME=<Char>NameLength&PATH=<HexChar>DevicePathSize<Null>
1646 @param[in] OpCodeData The opcode for the storage.
1647 @param[in] DriverHandle The driver handle which supports a Device Path Protocol
1648 that is the routing information PATH. Each byte of
1649 the Device Path associated with DriverHandle is converted
1650 to a 2 Unicode character hexidecimal string.
1652 @retval NULL DriverHandle does not support the Device Path Protocol.
1653 @retval Other A pointer to the Null-terminate Unicode <ConfigHdr> string
1657 ConstructConfigHdr (
1658 IN UINT8
*OpCodeData
,
1659 IN EFI_HANDLE DriverHandle
1663 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1664 UINTN DevicePathSize
;
1666 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 MaxLen
= 5 + sizeof (EFI_GUID
) * 2 + 6 + NameLength
* 4 + 6 + DevicePathSize
* 2 + 1;
1737 String
= AllocateZeroPool (MaxLen
* sizeof (CHAR16
));
1738 if (String
== NULL
) {
1743 // Start with L"GUID="
1745 StrCpyS (String
, MaxLen
, L
"GUID=");
1746 ReturnString
= String
;
1747 String
+= StrLen (String
);
1751 // Append Guid converted to <HexCh>32
1753 for (Index
= 0, Buffer
= (UINT8
*)Guid
; Index
< sizeof (EFI_GUID
); Index
++) {
1754 String
+= UnicodeValueToString (String
, PREFIX_ZERO
| RADIX_HEX
, *(Buffer
++), 2);
1761 StrCatS (ReturnString
, MaxLen
, L
"&NAME=");
1762 String
+= StrLen (String
);
1766 // Append Name converted to <Char>NameLength
1768 for (; *Name
!= L
'\0'; Name
++) {
1769 String
+= UnicodeValueToString (String
, PREFIX_ZERO
| RADIX_HEX
, *Name
, 4);
1776 StrCatS (ReturnString
, MaxLen
, L
"&PATH=");
1777 String
+= StrLen (String
);
1780 // Append the device path associated with DriverHandle converted to <HexChar>DevicePathSize
1782 for (Index
= 0, Buffer
= (UINT8
*)DevicePath
; Index
< DevicePathSize
; Index
++) {
1783 String
+= UnicodeValueToString (String
, PREFIX_ZERO
| RADIX_HEX
, *(Buffer
++), 2);
1787 // Null terminate the Unicode string
1792 // Convert all hex digits in range [A-F] in the configuration header to [a-f]
1794 return InternalLowerConfigString (ReturnString
);
1798 Generate the Config request element for one question.
1800 @param Name The name info for one question.
1801 @param Offset The offset info for one question.
1802 @param Width The width info for one question.
1804 @return Pointer to the Null-terminated Unicode request element string.
1808 ConstructRequestElement (
1819 // Add <BlockName> length for each Name
1821 // <BlockName> ::= Name + \0
1824 Length
= StrLen (Name
) + 1;
1827 // Add <BlockName> length for each Offset/Width pair
1829 // <BlockName> ::= OFFSET=1234&WIDTH=1234 + \0
1830 // | 7 | 4 | 7 | 4 | 1
1832 Length
= (7 + 4 + 7 + 4 + 1);
1836 // Allocate buffer for the entire <ConfigRequest>
1838 StringPtr
= AllocateZeroPool (Length
* sizeof (CHAR16
));
1839 ASSERT (StringPtr
!= NULL
);
1847 (StrLen (Name
) + 1) * sizeof (CHAR16
),
1853 // Append OFFSET=XXXX&WIDTH=YYYY\0
1857 (7 + 4 + 7 + 4 + 1) * sizeof (CHAR16
),
1858 L
"OFFSET=%04X&WIDTH=%04X",
1868 Get string value for question's name field.
1870 @param DatabaseRecord HII_DATABASE_RECORD format string.
1871 @param NameId The string id for the name field.
1873 @retval Name string.
1878 IN HII_DATABASE_RECORD
*DatabaseRecord
,
1879 IN EFI_STRING_ID NameId
1883 CHAR8
*PlatformLanguage
;
1884 CHAR8
*SupportedLanguages
;
1885 CHAR8
*BestLanguage
;
1891 BestLanguage
= NULL
;
1892 PlatformLanguage
= NULL
;
1893 SupportedLanguages
= NULL
;
1895 GetEfiGlobalVariable2 (L
"PlatformLang", (VOID
**)&PlatformLanguage
, NULL
);
1896 SupportedLanguages
= GetSupportedLanguages(DatabaseRecord
->Handle
);
1899 // Get the best matching language from SupportedLanguages
1901 BestLanguage
= GetBestLanguage (
1903 FALSE
, // RFC 4646 mode
1904 PlatformLanguage
!= NULL
? PlatformLanguage
: "", // Highest priority
1905 SupportedLanguages
, // Lowest priority
1908 if (BestLanguage
== NULL
) {
1909 BestLanguage
= AllocateCopyPool (AsciiStrLen ("en-US"), "en-US");
1910 ASSERT (BestLanguage
!= NULL
);
1914 Status
= mPrivate
.HiiString
.GetString (
1915 &mPrivate
.HiiString
,
1917 DatabaseRecord
->Handle
,
1923 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
1927 Name
= AllocateZeroPool (StringSize
);
1932 Status
= mPrivate
.HiiString
.GetString (
1933 &mPrivate
.HiiString
,
1935 DatabaseRecord
->Handle
,
1942 if (EFI_ERROR (Status
)) {
1949 if (SupportedLanguages
!= NULL
) {
1950 FreePool(SupportedLanguages
);
1952 if (BestLanguage
!= NULL
) {
1953 FreePool (BestLanguage
);
1955 if (PlatformLanguage
!= NULL
) {
1956 FreePool (PlatformLanguage
);
1963 Base on the input parameter to generate the ConfigRequest string.
1965 This is a internal function.
1967 @param DatabaseRecord HII_DATABASE_RECORD format string.
1968 @param KeywordStrId Keyword string id.
1969 @param OpCodeData The IFR data for this question.
1970 @param ConfigRequest Return the generate ConfigRequest string.
1972 @retval EFI_SUCCESS Generate ConfigResp string success.
1973 @retval EFI_OUT_OF_RESOURCES System out of memory resource error.
1974 @retval EFI_NOT_FOUND Not found the question which use this string id
1975 as the prompt string id.
1978 ExtractConfigRequest (
1979 IN HII_DATABASE_RECORD
*DatabaseRecord
,
1980 IN EFI_STRING_ID KeywordStrId
,
1981 OUT UINT8
**OpCodeData
,
1982 OUT EFI_STRING
*ConfigRequest
1986 HII_DATABASE_PACKAGE_LIST_INSTANCE
*PackageListNode
;
1987 HII_IFR_PACKAGE_INSTANCE
*FormPackage
;
1988 EFI_IFR_QUESTION_HEADER
*Header
;
1995 CHAR16
*RequestElement
;
1999 ASSERT (DatabaseRecord
!= NULL
&& OpCodeData
!= NULL
&& ConfigRequest
!= NULL
);
2006 PackageListNode
= DatabaseRecord
->PackageList
;
2009 // Search the languages in the specified packagelist.
2011 for (Link
= PackageListNode
->FormPkgHdr
.ForwardLink
; Link
!= &PackageListNode
->FormPkgHdr
; Link
= Link
->ForwardLink
) {
2012 FormPackage
= CR (Link
, HII_IFR_PACKAGE_INSTANCE
, IfrEntry
, HII_IFR_PACKAGE_SIGNATURE
);
2014 OpCode
= FindQuestionFromStringId (FormPackage
, KeywordStrId
);
2015 if (OpCode
!= NULL
) {
2016 *OpCodeData
= OpCode
;
2017 Header
= (EFI_IFR_QUESTION_HEADER
*) (OpCode
+ sizeof (EFI_IFR_OP_HEADER
));
2019 // Header->VarStoreId == 0 means no storage for this question.
2021 ASSERT (Header
->VarStoreId
!= 0);
2022 DEBUG ((EFI_D_INFO
, "Varstore Id: 0x%x\n", Header
->VarStoreId
));
2024 Storage
= FindStorageFromVarId (FormPackage
, Header
->VarStoreId
);
2025 ASSERT (Storage
!= NULL
);
2027 if (((EFI_IFR_OP_HEADER
*) Storage
)->OpCode
== EFI_IFR_VARSTORE_NAME_VALUE_OP
) {
2028 Name
= GetNameFromId (DatabaseRecord
, Header
->VarStoreInfo
.VarName
);
2030 Offset
= Header
->VarStoreInfo
.VarOffset
;
2031 Width
= GetWidth (OpCode
);
2033 RequestElement
= ConstructRequestElement(Name
, Offset
, Width
);
2034 ConfigHdr
= ConstructConfigHdr(Storage
, DatabaseRecord
->DriverHandle
);
2035 ASSERT (ConfigHdr
!= NULL
);
2037 MaxLen
= StrLen (ConfigHdr
) + 1 + StrLen(RequestElement
) + 1;
2038 *ConfigRequest
= AllocatePool (MaxLen
* sizeof (CHAR16
));
2039 if (*ConfigRequest
== NULL
) {
2040 FreePool (ConfigHdr
);
2041 FreePool (RequestElement
);
2042 return EFI_OUT_OF_RESOURCES
;
2044 StringPtr
= *ConfigRequest
;
2046 StrCpyS (StringPtr
, MaxLen
, ConfigHdr
);
2048 StrCatS (StringPtr
, MaxLen
, L
"&");
2050 StrCatS (StringPtr
, MaxLen
, RequestElement
);
2052 FreePool (ConfigHdr
);
2053 FreePool (RequestElement
);
2059 return EFI_NOT_FOUND
;
2063 Base on the input parameter to generate the ConfigResp string.
2065 This is a internal function.
2067 @param DatabaseRecord HII_DATABASE_RECORD format string.
2068 @param KeywordStrId Keyword string id.
2069 @param ValueElement The value for the question which use keyword string id
2070 as the prompt string id.
2071 @param OpCodeData The IFR data for this question.
2072 @param ConfigResp Return the generate ConfigResp string.
2074 @retval EFI_SUCCESS Generate ConfigResp string success.
2075 @retval EFI_OUT_OF_RESOURCES System out of memory resource error.
2076 @retval EFI_NOT_FOUND Not found the question which use this string id
2077 as the prompt string id.
2081 IN HII_DATABASE_RECORD
*DatabaseRecord
,
2082 IN EFI_STRING_ID KeywordStrId
,
2083 IN EFI_STRING ValueElement
,
2084 OUT UINT8
**OpCodeData
,
2085 OUT EFI_STRING
*ConfigResp
2089 HII_DATABASE_PACKAGE_LIST_INSTANCE
*PackageListNode
;
2090 HII_IFR_PACKAGE_INSTANCE
*FormPackage
;
2091 EFI_IFR_QUESTION_HEADER
*Header
;
2098 CHAR16
*RequestElement
;
2102 ASSERT ((DatabaseRecord
!= NULL
) && (OpCodeData
!= NULL
) && (ConfigResp
!= NULL
) && (ValueElement
!= NULL
));
2109 PackageListNode
= DatabaseRecord
->PackageList
;
2112 // Search the languages in the specified packagelist.
2114 for (Link
= PackageListNode
->FormPkgHdr
.ForwardLink
; Link
!= &PackageListNode
->FormPkgHdr
; Link
= Link
->ForwardLink
) {
2115 FormPackage
= CR (Link
, HII_IFR_PACKAGE_INSTANCE
, IfrEntry
, HII_IFR_PACKAGE_SIGNATURE
);
2117 OpCode
= FindQuestionFromStringId (FormPackage
, KeywordStrId
);
2118 if (OpCode
!= NULL
) {
2119 *OpCodeData
= OpCode
;
2120 Header
= (EFI_IFR_QUESTION_HEADER
*) (OpCode
+ sizeof (EFI_IFR_OP_HEADER
));
2122 // Header->VarStoreId == 0 means no storage for this question.
2124 ASSERT (Header
->VarStoreId
!= 0);
2125 DEBUG ((EFI_D_INFO
, "Varstore Id: 0x%x\n", Header
->VarStoreId
));
2127 Storage
= FindStorageFromVarId (FormPackage
, Header
->VarStoreId
);
2128 ASSERT (Storage
!= NULL
);
2130 if (((EFI_IFR_OP_HEADER
*) Storage
)->OpCode
== EFI_IFR_VARSTORE_NAME_VALUE_OP
) {
2131 Name
= GetNameFromId (DatabaseRecord
, Header
->VarStoreInfo
.VarName
);
2133 Offset
= Header
->VarStoreInfo
.VarOffset
;
2134 Width
= GetWidth (OpCode
);
2136 RequestElement
= ConstructRequestElement(Name
, Offset
, Width
);
2138 ConfigHdr
= ConstructConfigHdr(Storage
, DatabaseRecord
->DriverHandle
);
2139 ASSERT (ConfigHdr
!= NULL
);
2141 MaxLen
= StrLen (ConfigHdr
) + 1 + StrLen(RequestElement
) + 1 + StrLen (L
"VALUE=") + StrLen(ValueElement
) + 1;
2142 *ConfigResp
= AllocatePool (MaxLen
* sizeof (CHAR16
));
2143 if (*ConfigResp
== NULL
) {
2144 FreePool (ConfigHdr
);
2145 FreePool (RequestElement
);
2146 return EFI_OUT_OF_RESOURCES
;
2148 StringPtr
= *ConfigResp
;
2150 StrCpyS (StringPtr
, MaxLen
, ConfigHdr
);
2152 StrCatS (StringPtr
, MaxLen
, L
"&");
2155 StrCatS (StringPtr
, MaxLen
, RequestElement
);
2157 StrCatS (StringPtr
, MaxLen
, L
"&");
2159 StrCatS (StringPtr
, MaxLen
, L
"VALUE=");
2161 StrCatS (StringPtr
, MaxLen
, ValueElement
);
2163 FreePool (ConfigHdr
);
2164 FreePool (RequestElement
);
2170 return EFI_NOT_FOUND
;
2174 Get the Value section from the Hii driver.
2176 This is a internal function.
2178 @param ConfigRequest The input ConfigRequest string.
2179 @param ValueElement The respond Value section from the hii driver.
2181 @retval Misc value The error status return from ExtractConfig function.
2182 @retval EFI_OUT_OF_RESOURCES The memory can't be allocated
2183 @retval EFI_SUCCESS Get the value section success.
2187 ExtractValueFromDriver (
2188 IN CHAR16
*ConfigRequest
,
2189 OUT CHAR16
**ValueElement
2194 EFI_STRING Progress
;
2198 ASSERT ((ConfigRequest
!= NULL
) && (ValueElement
!= NULL
));
2200 Status
= mPrivate
.ConfigRouting
.ExtractConfig (
2201 &mPrivate
.ConfigRouting
,
2202 (EFI_STRING
) ConfigRequest
,
2206 if (EFI_ERROR (Status
)) {
2211 // Find Value Section and return it.
2213 StringPtr
= StrStr (Result
, L
"&VALUE=");
2214 ASSERT (StringPtr
!= NULL
);
2215 StringEnd
= StrStr (StringPtr
+ 1, L
"&");
2216 if (StringEnd
!= NULL
) {
2220 *ValueElement
= AllocateCopyPool (StrSize (StringPtr
), StringPtr
);
2221 if (*ValueElement
== NULL
) {
2222 return EFI_OUT_OF_RESOURCES
;
2225 if (StringEnd
!= NULL
) {
2234 Get EFI_STRING_ID info from the input device path, namespace and keyword.
2236 This is a internal function.
2238 @param DevicePath Input device path info.
2239 @param NameSpace NameSpace format string.
2240 @param KeywordData Keyword used to get string id.
2241 @param ProgressErr Return extra error type.
2242 @param KeywordStringId Return EFI_STRING_ID.
2243 @param DataBaseRecord DataBase record data for this driver.
2245 @retval EFI_INVALID_PARAMETER Can't find the database record base on the input device path or namespace.
2246 @retval EFI_NOT_FOUND Can't find the EFI_STRING_ID for the keyword.
2247 @retval EFI_SUCCESS Find the EFI_STRING_ID.
2251 GetStringIdFromDatabase (
2252 IN EFI_DEVICE_PATH_PROTOCOL
**DevicePath
,
2253 IN CHAR8
**NameSpace
,
2254 IN CHAR16
*KeywordData
,
2255 OUT UINT32
*ProgressErr
,
2256 OUT EFI_STRING_ID
*KeywordStringId
,
2257 OUT HII_DATABASE_RECORD
**DataBaseRecord
2260 HII_DATABASE_RECORD
*Record
;
2262 BOOLEAN FindNameSpace
;
2263 EFI_DEVICE_PATH_PROTOCOL
*DestDevicePath
;
2264 UINT8
*DevicePathPkg
;
2265 UINTN DevicePathSize
;
2267 ASSERT ((NameSpace
!= NULL
) && (KeywordData
!= NULL
) && (ProgressErr
!= NULL
) && (KeywordStringId
!= NULL
) && (DataBaseRecord
!= NULL
));
2269 FindNameSpace
= FALSE
;
2271 if (*DevicePath
!= NULL
) {
2273 // Get DataBaseRecord from device path protocol.
2275 Record
= GetRecordFromDevicePath(*DevicePath
);
2276 if (Record
== NULL
) {
2278 // Can't find the DatabaseRecord base on the input device path info.
2279 // NEED TO CONFIRM the return ProgressErr.
2281 *ProgressErr
= KEYWORD_HANDLER_MALFORMED_STRING
;
2282 return EFI_INVALID_PARAMETER
;
2286 // Get string id from the record.
2288 *ProgressErr
= GetStringIdFromRecord (Record
, NameSpace
, KeywordData
, KeywordStringId
);
2289 switch (*ProgressErr
) {
2290 case KEYWORD_HANDLER_NO_ERROR
:
2291 *DataBaseRecord
= Record
;
2294 case KEYWORD_HANDLER_NAMESPACE_ID_NOT_FOUND
:
2295 return EFI_INVALID_PARAMETER
;
2298 ASSERT (*ProgressErr
== KEYWORD_HANDLER_KEYWORD_NOT_FOUND
);
2299 return EFI_NOT_FOUND
;
2303 // Find driver which matches the routing data.
2305 for (Link
= mPrivate
.DatabaseList
.ForwardLink
; Link
!= &mPrivate
.DatabaseList
; Link
= Link
->ForwardLink
) {
2306 Record
= CR (Link
, HII_DATABASE_RECORD
, DatabaseEntry
, HII_DATABASE_RECORD_SIGNATURE
);
2308 *ProgressErr
= GetStringIdFromRecord (Record
, NameSpace
, KeywordData
, KeywordStringId
);
2309 if (*ProgressErr
== KEYWORD_HANDLER_NO_ERROR
) {
2310 *DataBaseRecord
= Record
;
2312 if ((DevicePathPkg
= Record
->PackageList
->DevicePathPkg
) != NULL
) {
2313 DestDevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) (DevicePathPkg
+ sizeof (EFI_HII_PACKAGE_HEADER
));
2314 DevicePathSize
= GetDevicePathSize ((EFI_DEVICE_PATH_PROTOCOL
*) DestDevicePath
);
2315 *DevicePath
= AllocateCopyPool (DevicePathSize
, DestDevicePath
);
2316 if (*DevicePath
== NULL
) {
2317 return EFI_OUT_OF_RESOURCES
;
2321 // Need to verify this ASSERT.
2327 } else if (*ProgressErr
== KEYWORD_HANDLER_UNDEFINED_PROCESSING_ERROR
) {
2328 return EFI_OUT_OF_RESOURCES
;
2329 } else if (*ProgressErr
== KEYWORD_HANDLER_KEYWORD_NOT_FOUND
) {
2330 FindNameSpace
= TRUE
;
2335 // When PathHdr not input, if ever find the namespace, will return KEYWORD_HANDLER_KEYWORD_NOT_FOUND.
2336 // This is a bit more progress than KEYWORD_HANDLER_NAMESPACE_ID_NOT_FOUND.
2338 if (FindNameSpace
) {
2339 return EFI_NOT_FOUND
;
2341 return EFI_INVALID_PARAMETER
;
2347 Genereate the KeywordResp String.
2349 <KeywordResp> ::= <NameSpaceId><PathHdr>'&'<Keyword>'&VALUE='<Number>['&READONLY']
2351 @param NameSpace NameSpace format string.
2352 @param DevicePath Input device path info.
2353 @param KeywordData Keyword used to get string id.
2354 @param ValueStr The value section for the keyword.
2355 @param ReadOnly Whether this value is readonly.
2356 @param KeywordResp Return the point to the KeywordResp string.
2358 @retval EFI_OUT_OF_RESOURCES The memory can't be allocated.
2359 @retval EFI_SUCCESS Generate the KeywordResp string.
2363 GenerateKeywordResp (
2364 IN CHAR8
*NameSpace
,
2365 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
2366 IN EFI_STRING KeywordData
,
2367 IN EFI_STRING ValueStr
,
2368 IN BOOLEAN ReadOnly
,
2369 OUT EFI_STRING
*KeywordResp
2375 CHAR16
*UnicodeNameSpace
;
2377 ASSERT ((NameSpace
!= NULL
) && (DevicePath
!= NULL
) && (KeywordData
!= NULL
) && (ValueStr
!= NULL
) && (KeywordResp
!= NULL
));
2380 // 1. Calculate the string length.
2383 // 1.1 NameSpaceId size.
2384 // 'NAMESPACE='<String>
2386 RespStrLen
= 10 + AsciiStrLen (NameSpace
);
2387 UnicodeNameSpace
= AllocatePool ((AsciiStrLen (NameSpace
) + 1) * sizeof (CHAR16
));
2388 if (UnicodeNameSpace
== NULL
) {
2389 return EFI_OUT_OF_RESOURCES
;
2391 AsciiStrToUnicodeStr(NameSpace
, UnicodeNameSpace
);
2394 // 1.2 PathHdr size.
2395 // PATH=<UEFI binary Device Path represented as hex number>'&'
2396 // Attention: The output include the '&' at the end.
2400 GetDevicePathSize ((EFI_DEVICE_PATH_PROTOCOL
*) DevicePath
),
2401 (VOID
*) DevicePath
,
2405 RespStrLen
+= StrLen (PathHdr
);
2408 // 1.3 Keyword setion.
2409 // 'KEYWORD='<String>[':'<DecCh>(1/4)]
2411 RespStrLen
+= 8 + StrLen (KeywordData
);
2414 // 1.4 Value section.
2415 // ValueStr = '&VALUE='<Number>
2417 RespStrLen
+= StrLen (ValueStr
);
2420 // 1.5 ReadOnly Section.
2428 // 2. Allocate the buffer and create the KeywordResp string include '\0'.
2431 *KeywordResp
= AllocatePool (RespStrLen
* sizeof (CHAR16
));
2432 if (*KeywordResp
== NULL
) {
2433 if (UnicodeNameSpace
!= NULL
) {
2434 FreePool (UnicodeNameSpace
);
2437 return EFI_OUT_OF_RESOURCES
;
2439 RespStr
= *KeywordResp
;
2442 // 2.1 Copy NameSpaceId section.
2444 StrCpyS (RespStr
, RespStrLen
, L
"NAMESPACE=");
2446 StrCatS (RespStr
, RespStrLen
, UnicodeNameSpace
);
2449 // 2.2 Copy PathHdr section.
2451 StrCatS (RespStr
, RespStrLen
, PathHdr
);
2454 // 2.3 Copy Keyword section.
2456 StrCatS (RespStr
, RespStrLen
, L
"KEYWORD=");
2458 StrCatS (RespStr
, RespStrLen
, KeywordData
);
2461 // 2.4 Copy the Value section.
2463 StrCatS (RespStr
, RespStrLen
, ValueStr
);
2466 // 2.5 Copy ReadOnly section if exist.
2469 StrCatS (RespStr
, RespStrLen
, L
"&READONLY");
2472 if (UnicodeNameSpace
!= NULL
) {
2473 FreePool (UnicodeNameSpace
);
2475 if (PathHdr
!= NULL
) {
2483 Merge the KeywordResp String to MultiKeywordResp string.
2485 This is a internal function.
2487 @param MultiKeywordResp The existed multikeywordresp string.
2488 @param KeywordResp The input keywordResp string.
2490 @retval EFI_OUT_OF_RESOURCES The memory can't be allocated.
2491 @retval EFI_SUCCESS Generate the MultiKeywordResp string.
2495 MergeToMultiKeywordResp (
2496 IN OUT EFI_STRING
*MultiKeywordResp
,
2497 IN EFI_STRING
*KeywordResp
2500 UINTN MultiKeywordRespLen
;
2501 EFI_STRING StringPtr
;
2503 if (*MultiKeywordResp
== NULL
) {
2504 *MultiKeywordResp
= *KeywordResp
;
2505 *KeywordResp
= NULL
;
2509 MultiKeywordRespLen
= (StrLen (*MultiKeywordResp
) + 1 + StrLen (*KeywordResp
) + 1) * sizeof (CHAR16
);
2511 StringPtr
= AllocateCopyPool (MultiKeywordRespLen
, *MultiKeywordResp
);
2512 if (StringPtr
== NULL
) {
2513 return EFI_OUT_OF_RESOURCES
;
2516 FreePool (*MultiKeywordResp
);
2517 *MultiKeywordResp
= StringPtr
;
2519 StrCatS (StringPtr
, MultiKeywordRespLen
/ sizeof (CHAR16
), L
"&");
2521 StrCatS (StringPtr
, MultiKeywordRespLen
/ sizeof (CHAR16
), *KeywordResp
);
2527 Enumerate all keyword in the system.
2529 If error occur when parse one keyword, just skip it and parse the next one.
2531 This is a internal function.
2533 @param NameSpace The namespace used to search the string.
2534 @param MultiResp Return the MultiKeywordResp string for the system.
2535 @param ProgressErr Return the error status.
2537 @retval EFI_OUT_OF_RESOURCES The memory can't be allocated.
2538 @retval EFI_SUCCESS Generate the MultiKeywordResp string.
2539 @retval EFI_NOT_FOUND No keyword found.
2543 EnumerateAllKeywords (
2544 IN CHAR8
*NameSpace
,
2545 OUT EFI_STRING
*MultiResp
,
2546 OUT UINT32
*ProgressErr
2550 LIST_ENTRY
*StringLink
;
2551 UINT8
*DevicePathPkg
;
2553 HII_DATABASE_RECORD
*DataBaseRecord
;
2554 HII_DATABASE_PACKAGE_LIST_INSTANCE
*PackageListNode
;
2555 HII_STRING_PACKAGE_INSTANCE
*StringPackage
;
2556 CHAR8
*LocalNameSpace
;
2557 EFI_STRING_ID NextStringId
;
2560 CHAR16
*ConfigRequest
;
2561 CHAR16
*ValueElement
;
2562 CHAR16
*KeywordResp
;
2563 CHAR16
*MultiKeywordResp
;
2564 CHAR16
*KeywordData
;
2566 BOOLEAN FindKeywordPackages
;
2568 DataBaseRecord
= NULL
;
2569 Status
= EFI_SUCCESS
;
2570 MultiKeywordResp
= NULL
;
2572 LocalNameSpace
= NULL
;
2573 ConfigRequest
= NULL
;
2574 ValueElement
= NULL
;
2576 FindKeywordPackages
= FALSE
;
2578 if (NameSpace
== NULL
) {
2579 NameSpace
= UEFI_CONFIG_LANG
;
2583 // Find driver which matches the routing data.
2585 for (Link
= mPrivate
.DatabaseList
.ForwardLink
; Link
!= &mPrivate
.DatabaseList
; Link
= Link
->ForwardLink
) {
2586 DataBaseRecord
= CR (Link
, HII_DATABASE_RECORD
, DatabaseEntry
, HII_DATABASE_RECORD_SIGNATURE
);
2587 if ((DevicePathPkg
= DataBaseRecord
->PackageList
->DevicePathPkg
) != NULL
) {
2588 DevicePath
= DevicePathPkg
+ sizeof (EFI_HII_PACKAGE_HEADER
);
2590 PackageListNode
= DataBaseRecord
->PackageList
;
2592 for (StringLink
= PackageListNode
->StringPkgHdr
.ForwardLink
; StringLink
!= &PackageListNode
->StringPkgHdr
; StringLink
= StringLink
->ForwardLink
) {
2593 StringPackage
= CR (StringLink
, HII_STRING_PACKAGE_INSTANCE
, StringEntry
, HII_STRING_PACKAGE_SIGNATURE
);
2596 // Check whether has keyword string package.
2598 if (AsciiStrnCmp(NameSpace
, StringPackage
->StringPkgHdr
->Language
, AsciiStrLen (NameSpace
)) == 0) {
2599 FindKeywordPackages
= TRUE
;
2601 // Keep the NameSpace string.
2603 LocalNameSpace
= AllocateCopyPool (AsciiStrSize (StringPackage
->StringPkgHdr
->Language
), StringPackage
->StringPkgHdr
->Language
);
2604 if (LocalNameSpace
== NULL
) {
2605 return EFI_OUT_OF_RESOURCES
;
2609 // 1 means just begin the enumerate the valid string ids.
2610 // StringId == 1 is always used to save the language for this string package.
2611 // Any valid string start from 2. so here initial it to 1.
2616 // Enumerate all valid stringid in the package.
2618 while ((NextStringId
= GetNextStringId (StringPackage
, NextStringId
, &KeywordData
)) != 0) {
2620 // 3.3 Construct the ConfigRequest string.
2622 Status
= ExtractConfigRequest (DataBaseRecord
, NextStringId
, &OpCode
, &ConfigRequest
);
2623 if (EFI_ERROR (Status
)) {
2625 // If can't generate ConfigRequest for this question, skip it and start the next.
2631 // 3.4 Extract Value for the input keyword.
2633 Status
= ExtractValueFromDriver(ConfigRequest
, &ValueElement
);
2634 if (EFI_ERROR (Status
)) {
2635 if (Status
!= EFI_OUT_OF_RESOURCES
) {
2637 // If can't generate ConfigRequest for this question, skip it and start the next.
2642 // If EFI_OUT_OF_RESOURCES error occur, no need to continue.
2648 // Extract readonly flag from opcode.
2650 ReadOnly
= ExtractReadOnlyFromOpCode(OpCode
);
2653 // 5. Generate KeywordResp string.
2655 ASSERT (DevicePath
!= NULL
);
2656 Status
= GenerateKeywordResp(LocalNameSpace
, (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
, KeywordData
, ValueElement
, ReadOnly
, &KeywordResp
);
2657 if (Status
!= EFI_SUCCESS
) {
2659 // If EFI_OUT_OF_RESOURCES error occur, no need to continue.
2665 // 6. Merge to the MultiKeywordResp string.
2667 Status
= MergeToMultiKeywordResp(&MultiKeywordResp
, &KeywordResp
);
2668 if (EFI_ERROR (Status
)) {
2673 // Clean the temp buffer to later use again.
2675 if (ConfigRequest
!= NULL
) {
2676 FreePool (ConfigRequest
);
2677 ConfigRequest
= NULL
;
2679 if (ValueElement
!= NULL
) {
2680 FreePool (ValueElement
);
2681 ValueElement
= NULL
;
2683 if (KeywordResp
!= NULL
) {
2684 FreePool (KeywordResp
);
2689 if (LocalNameSpace
!= NULL
) {
2690 FreePool (LocalNameSpace
);
2691 LocalNameSpace
= NULL
;
2698 // return the already get MultiKeywordString even error occured.
2700 if (MultiKeywordResp
== NULL
) {
2701 Status
= EFI_NOT_FOUND
;
2702 if (!FindKeywordPackages
) {
2703 *ProgressErr
= KEYWORD_HANDLER_NAMESPACE_ID_NOT_FOUND
;
2705 *ProgressErr
= KEYWORD_HANDLER_KEYWORD_NOT_FOUND
;
2708 Status
= EFI_SUCCESS
;
2710 *MultiResp
= MultiKeywordResp
;
2713 if (LocalNameSpace
!= NULL
) {
2714 FreePool (LocalNameSpace
);
2716 if (ConfigRequest
!= NULL
) {
2717 FreePool (ConfigRequest
);
2719 if (ValueElement
!= NULL
) {
2720 FreePool (ValueElement
);
2728 This function accepts a <MultiKeywordResp> formatted string, finds the associated
2729 keyword owners, creates a <MultiConfigResp> string from it and forwards it to the
2730 EFI_HII_ROUTING_PROTOCOL.RouteConfig function.
2732 If there is an issue in resolving the contents of the KeywordString, then the
2733 function returns an error and also sets the Progress and ProgressErr with the
2734 appropriate information about where the issue occurred and additional data about
2735 the nature of the issue.
2737 In the case when KeywordString containing multiple keywords, when an EFI_NOT_FOUND
2738 error is generated during processing the second or later keyword element, the system
2739 storage associated with earlier keywords is not modified. All elements of the
2740 KeywordString must successfully pass all tests for format and access prior to making
2741 any modifications to storage.
2743 In the case when EFI_DEVICE_ERROR is returned from the processing of a KeywordString
2744 containing multiple keywords, the state of storage associated with earlier keywords
2748 @param This Pointer to the EFI_KEYWORD_HANDLER _PROTOCOL instance.
2750 @param KeywordString A null-terminated string in <MultiKeywordResp> format.
2752 @param Progress On return, points to a character in the KeywordString.
2753 Points to the string's NULL terminator if the request
2754 was successful. Points to the most recent '&' before
2755 the first failing string element if the request was
2758 @param ProgressErr If during the processing of the KeywordString there was
2759 a failure, this parameter gives additional information
2760 about the possible source of the problem. The various
2761 errors are defined in "Related Definitions" below.
2764 @retval EFI_SUCCESS The specified action was completed successfully.
2766 @retval EFI_INVALID_PARAMETER One or more of the following are TRUE:
2767 1. KeywordString is NULL.
2768 2. Parsing of the KeywordString resulted in an
2769 error. See Progress and ProgressErr for more data.
2771 @retval EFI_NOT_FOUND An element of the KeywordString was not found.
2772 See ProgressErr for more data.
2774 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
2775 See ProgressErr for more data.
2777 @retval EFI_ACCESS_DENIED The action violated system policy. See ProgressErr
2780 @retval EFI_DEVICE_ERROR An unexpected system error occurred. See ProgressErr
2786 EfiConfigKeywordHandlerSetData (
2787 IN EFI_CONFIG_KEYWORD_HANDLER_PROTOCOL
*This
,
2788 IN CONST EFI_STRING KeywordString
,
2789 OUT EFI_STRING
*Progress
,
2790 OUT UINT32
*ProgressErr
2796 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
2797 CHAR16
*NextStringPtr
;
2798 CHAR16
*KeywordData
;
2799 EFI_STRING_ID KeywordStringId
;
2801 HII_DATABASE_RECORD
*DataBaseRecord
;
2804 CHAR16
*MultiConfigResp
;
2805 CHAR16
*ValueElement
;
2807 EFI_STRING InternalProgress
;
2809 CHAR16
*KeywordStartPos
;
2811 if (This
== NULL
|| Progress
== NULL
|| ProgressErr
== NULL
|| KeywordString
== NULL
) {
2812 return EFI_INVALID_PARAMETER
;
2815 *Progress
= KeywordString
;
2816 *ProgressErr
= KEYWORD_HANDLER_UNDEFINED_PROCESSING_ERROR
;
2817 Status
= EFI_SUCCESS
;
2818 MultiConfigResp
= NULL
;
2822 ValueElement
= NULL
;
2824 KeywordStartPos
= NULL
;
2825 KeywordStringId
= 0;
2828 // Use temp string to avoid changing input string buffer.
2830 TempString
= AllocateCopyPool (StrSize (KeywordString
), KeywordString
);
2831 ASSERT (TempString
!= NULL
);
2832 StringPtr
= TempString
;
2834 while ((StringPtr
!= NULL
) && (*StringPtr
!= L
'\0')) {
2836 // 1. Get NameSpace from NameSpaceId keyword.
2838 Status
= ExtractNameSpace (StringPtr
, &NameSpace
, &NextStringPtr
);
2839 if (EFI_ERROR (Status
)) {
2840 *ProgressErr
= KEYWORD_HANDLER_MALFORMED_STRING
;
2843 ASSERT (NameSpace
!= NULL
);
2845 // 1.1 Check whether the input namespace is valid.
2847 if (AsciiStrnCmp(NameSpace
, UEFI_CONFIG_LANG
, AsciiStrLen (UEFI_CONFIG_LANG
)) != 0) {
2848 *ProgressErr
= KEYWORD_HANDLER_MALFORMED_STRING
;
2849 Status
= EFI_INVALID_PARAMETER
;
2853 StringPtr
= NextStringPtr
;
2856 // 2. Get possible Device Path info from KeywordString.
2858 Status
= ExtractDevicePath (StringPtr
, (UINT8
**)&DevicePath
, &NextStringPtr
);
2859 if (EFI_ERROR (Status
)) {
2860 *ProgressErr
= KEYWORD_HANDLER_MALFORMED_STRING
;
2863 StringPtr
= NextStringPtr
;
2866 // 3. Extract keyword from the KeywordRequest string.
2868 KeywordStartPos
= StringPtr
;
2869 Status
= ExtractKeyword(StringPtr
, &KeywordData
, &NextStringPtr
);
2870 if (EFI_ERROR (Status
)) {
2872 // Can't find Keyword base on the input device path info.
2874 *ProgressErr
= KEYWORD_HANDLER_MALFORMED_STRING
;
2875 Status
= EFI_INVALID_PARAMETER
;
2878 StringPtr
= NextStringPtr
;
2881 // 4. Extract Value from the KeywordRequest string.
2883 Status
= ExtractValue (StringPtr
, &ValueElement
, &NextStringPtr
);
2884 if (EFI_ERROR (Status
)) {
2886 // Can't find Value base on the input device path info.
2888 *ProgressErr
= KEYWORD_HANDLER_MALFORMED_STRING
;
2889 Status
= EFI_INVALID_PARAMETER
;
2892 StringPtr
= NextStringPtr
;
2895 // 5. Find ReadOnly filter.
2897 if ((StringPtr
!= NULL
) && StrnCmp (StringPtr
, L
"&ReadOnly", StrLen (L
"&ReadOnly")) == 0) {
2899 StringPtr
+= StrLen (L
"&ReadOnly");
2905 // 6. Get EFI_STRING_ID for the input keyword.
2907 Status
= GetStringIdFromDatabase (&DevicePath
, &NameSpace
, KeywordData
, &RetVal
, &KeywordStringId
, &DataBaseRecord
);
2908 if (EFI_ERROR (Status
)) {
2909 *ProgressErr
= RetVal
;
2914 // 7. Construct the ConfigRequest string.
2916 Status
= ExtractConfigResp (DataBaseRecord
, KeywordStringId
, ValueElement
, &OpCode
, &ConfigResp
);
2917 if (EFI_ERROR (Status
)) {
2922 // 8. Check the readonly flag.
2924 if (ExtractReadOnlyFromOpCode (OpCode
) != ReadOnly
) {
2925 *ProgressErr
= KEYWORD_HANDLER_ACCESS_NOT_PERMITTED
;
2926 Status
= EFI_ACCESS_DENIED
;
2931 // 9. Merge to the MultiKeywordResp string.
2933 Status
= MergeToMultiKeywordResp(&MultiConfigResp
, &ConfigResp
);
2934 if (EFI_ERROR (Status
)) {
2939 // 10. Clean the temp buffer point.
2941 FreePool (NameSpace
);
2942 FreePool (DevicePath
);
2943 FreePool (KeywordData
);
2944 FreePool (ValueElement
);
2948 ValueElement
= NULL
;
2949 if (ConfigResp
!= NULL
) {
2950 FreePool (ConfigResp
);
2953 KeywordStartPos
= NULL
;
2957 // 11. Set value to driver.
2959 Status
= mPrivate
.ConfigRouting
.RouteConfig(
2960 &mPrivate
.ConfigRouting
,
2961 (EFI_STRING
) MultiConfigResp
,
2964 if (EFI_ERROR (Status
)) {
2965 Status
= EFI_DEVICE_ERROR
;
2969 *ProgressErr
= KEYWORD_HANDLER_NO_ERROR
;
2972 if (KeywordStartPos
!= NULL
) {
2973 *Progress
= KeywordString
+ (KeywordStartPos
- TempString
);
2975 *Progress
= KeywordString
+ (StringPtr
- TempString
);
2978 ASSERT (TempString
!= NULL
);
2979 FreePool (TempString
);
2980 if (NameSpace
!= NULL
) {
2981 FreePool (NameSpace
);
2983 if (DevicePath
!= NULL
) {
2984 FreePool (DevicePath
);
2986 if (KeywordData
!= NULL
) {
2987 FreePool (KeywordData
);
2989 if (ValueElement
!= NULL
) {
2990 FreePool (ValueElement
);
2992 if (ConfigResp
!= NULL
) {
2993 FreePool (ConfigResp
);
2995 if (MultiConfigResp
!= NULL
&& MultiConfigResp
!= ConfigResp
) {
2996 FreePool (MultiConfigResp
);
3004 This function accepts a <MultiKeywordRequest> formatted string, finds the underlying
3005 keyword owners, creates a <MultiConfigRequest> string from it and forwards it to the
3006 EFI_HII_ROUTING_PROTOCOL.ExtractConfig function.
3008 If there is an issue in resolving the contents of the KeywordString, then the function
3009 returns an EFI_INVALID_PARAMETER and also set the Progress and ProgressErr with the
3010 appropriate information about where the issue occurred and additional data about the
3011 nature of the issue.
3013 In the case when KeywordString is NULL, or contains multiple keywords, or when
3014 EFI_NOT_FOUND is generated while processing the keyword elements, the Results string
3015 contains values returned for all keywords processed prior to the keyword generating the
3016 error but no values for the keyword with error or any following keywords.
3019 @param This Pointer to the EFI_KEYWORD_HANDLER _PROTOCOL instance.
3021 @param NameSpaceId A null-terminated string containing the platform configuration
3022 language to search through in the system. If a NULL is passed
3023 in, then it is assumed that any platform configuration language
3024 with the prefix of "x-UEFI-" are searched.
3026 @param KeywordString A null-terminated string in <MultiKeywordRequest> format. If a
3027 NULL is passed in the KeywordString field, all of the known
3028 keywords in the system for the NameSpaceId specified are
3029 returned in the Results field.
3031 @param Progress On return, points to a character in the KeywordString. Points
3032 to the string's NULL terminator if the request was successful.
3033 Points to the most recent '&' before the first failing string
3034 element if the request was not successful.
3036 @param ProgressErr If during the processing of the KeywordString there was a
3037 failure, this parameter gives additional information about the
3038 possible source of the problem. See the definitions in SetData()
3039 for valid value definitions.
3041 @param Results A null-terminated string in <MultiKeywordResp> format is returned
3042 which has all the values filled in for the keywords in the
3043 KeywordString. This is a callee-allocated field, and must be freed
3044 by the caller after being used.
3046 @retval EFI_SUCCESS The specified action was completed successfully.
3048 @retval EFI_INVALID_PARAMETER One or more of the following are TRUE:
3049 1.Progress, ProgressErr, or Resuts is NULL.
3050 2.Parsing of the KeywordString resulted in an error. See
3051 Progress and ProgressErr for more data.
3054 @retval EFI_NOT_FOUND An element of the KeywordString was not found. See
3055 ProgressErr for more data.
3057 @retval EFI_NOT_FOUND The NamespaceId specified was not found. See ProgressErr
3060 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. See
3061 ProgressErr for more data.
3063 @retval EFI_ACCESS_DENIED The action violated system policy. See ProgressErr for
3066 @retval EFI_DEVICE_ERROR An unexpected system error occurred. See ProgressErr
3072 EfiConfigKeywordHandlerGetData (
3073 IN EFI_CONFIG_KEYWORD_HANDLER_PROTOCOL
*This
,
3074 IN CONST EFI_STRING NameSpaceId
, OPTIONAL
3075 IN CONST EFI_STRING KeywordString
, OPTIONAL
3076 OUT EFI_STRING
*Progress
,
3077 OUT UINT32
*ProgressErr
,
3078 OUT EFI_STRING
*Results
3083 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
3084 HII_DATABASE_RECORD
*DataBaseRecord
;
3086 CHAR16
*NextStringPtr
;
3087 CHAR16
*KeywordData
;
3088 EFI_STRING_ID KeywordStringId
;
3090 CHAR16
*ConfigRequest
;
3091 CHAR16
*ValueElement
;
3094 CHAR16
*KeywordResp
;
3095 CHAR16
*MultiKeywordResp
;
3098 if (This
== NULL
|| Progress
== NULL
|| ProgressErr
== NULL
|| Results
== NULL
) {
3099 return EFI_INVALID_PARAMETER
;
3102 *ProgressErr
= KEYWORD_HANDLER_UNDEFINED_PROCESSING_ERROR
;
3103 Status
= EFI_SUCCESS
;
3107 ConfigRequest
= NULL
;
3108 StringPtr
= KeywordString
;
3110 MultiKeywordResp
= NULL
;
3111 KeywordStringId
= 0;
3115 // Use temp string to avoid changing input string buffer.
3117 if (NameSpaceId
!= NULL
) {
3118 TempString
= AllocateCopyPool (StrSize (NameSpaceId
), NameSpaceId
);
3119 ASSERT (TempString
!= NULL
);
3122 // 1. Get NameSpace from NameSpaceId keyword.
3124 Status
= ExtractNameSpace (TempString
, &NameSpace
, NULL
);
3125 if (TempString
!= NULL
) {
3126 FreePool (TempString
);
3129 if (EFI_ERROR (Status
)) {
3130 *ProgressErr
= KEYWORD_HANDLER_MALFORMED_STRING
;
3134 // 1.1 Check whether the input namespace is valid.
3136 if (NameSpace
!= NULL
){
3137 if (AsciiStrnCmp(NameSpace
, UEFI_CONFIG_LANG
, AsciiStrLen (UEFI_CONFIG_LANG
)) != 0) {
3138 *ProgressErr
= KEYWORD_HANDLER_MALFORMED_STRING
;
3139 return EFI_INVALID_PARAMETER
;
3143 if (KeywordString
!= NULL
) {
3145 // Use temp string to avoid changing input string buffer.
3147 TempString
= AllocateCopyPool (StrSize (KeywordString
), KeywordString
);
3148 ASSERT (TempString
!= NULL
);
3149 StringPtr
= TempString
;
3151 while (*StringPtr
!= L
'\0') {
3153 // 2. Get possible Device Path info from KeywordString.
3155 Status
= ExtractDevicePath (StringPtr
, (UINT8
**)&DevicePath
, &NextStringPtr
);
3156 if (EFI_ERROR (Status
)) {
3157 *ProgressErr
= KEYWORD_HANDLER_MALFORMED_STRING
;
3160 StringPtr
= NextStringPtr
;
3164 // 3. Process Keyword section from the input keywordRequest string.
3166 // 3.1 Extract keyword from the KeywordRequest string.
3168 Status
= ExtractKeyword(StringPtr
, &KeywordData
, &NextStringPtr
);
3169 if (EFI_ERROR (Status
)) {
3171 // Can't find Keyword base on the input device path info.
3173 *ProgressErr
= KEYWORD_HANDLER_MALFORMED_STRING
;
3174 Status
= EFI_INVALID_PARAMETER
;
3179 // 3.2 Get EFI_STRING_ID for the input keyword.
3181 Status
= GetStringIdFromDatabase (&DevicePath
, &NameSpace
, KeywordData
, &RetVal
, &KeywordStringId
, &DataBaseRecord
);
3182 if (EFI_ERROR (Status
)) {
3183 *ProgressErr
= RetVal
;
3188 // 3.3 Construct the ConfigRequest string.
3190 Status
= ExtractConfigRequest (DataBaseRecord
, KeywordStringId
, &OpCode
, &ConfigRequest
);
3191 if (EFI_ERROR (Status
)) {
3196 // 3.4 Extract Value for the input keyword.
3198 Status
= ExtractValueFromDriver(ConfigRequest
, &ValueElement
);
3199 if (EFI_ERROR (Status
)) {
3200 if (Status
!= EFI_OUT_OF_RESOURCES
) {
3201 Status
= EFI_DEVICE_ERROR
;
3205 StringPtr
= NextStringPtr
;
3208 // 4. Process the possible filter section.
3210 RetVal
= ValidateFilter (OpCode
, StringPtr
, &NextStringPtr
, &ReadOnly
);
3211 if (RetVal
!= KEYWORD_HANDLER_NO_ERROR
) {
3212 *ProgressErr
= RetVal
;
3213 Status
= EFI_INVALID_PARAMETER
;
3216 StringPtr
= NextStringPtr
;
3220 // 5. Generate KeywordResp string.
3222 Status
= GenerateKeywordResp(NameSpace
, DevicePath
, KeywordData
, ValueElement
, ReadOnly
, &KeywordResp
);
3223 if (Status
!= EFI_SUCCESS
) {
3228 // 6. Merge to the MultiKeywordResp string.
3230 Status
= MergeToMultiKeywordResp(&MultiKeywordResp
, &KeywordResp
);
3231 if (EFI_ERROR (Status
)) {
3236 // 7. Update return value.
3238 *Results
= MultiKeywordResp
;
3241 // 8. Clean the temp buffer.
3243 FreePool (DevicePath
);
3244 FreePool (KeywordData
);
3245 FreePool (ValueElement
);
3246 FreePool (ConfigRequest
);
3249 ValueElement
= NULL
;
3250 ConfigRequest
= NULL
;
3251 if (KeywordResp
!= NULL
) {
3252 FreePool (KeywordResp
);
3258 // Enumerate all keyword in the system.
3260 Status
= EnumerateAllKeywords(NameSpace
, &MultiKeywordResp
, ProgressErr
);
3261 if (EFI_ERROR (Status
)) {
3264 *Results
= MultiKeywordResp
;
3267 *ProgressErr
= KEYWORD_HANDLER_NO_ERROR
;
3270 *Progress
= KeywordString
+ (StringPtr
- TempString
);
3272 if (TempString
!= NULL
) {
3273 FreePool (TempString
);
3275 if (NameSpace
!= NULL
) {
3276 FreePool (NameSpace
);
3278 if (DevicePath
!= NULL
) {
3279 FreePool (DevicePath
);
3281 if (KeywordData
!= NULL
) {
3282 FreePool (KeywordData
);