]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Universal/HiiDatabaseDxe/ConfigKeywordHandler.c
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
NetworkPkg: Fix connection issue after correct SPD and re-enable IPsec
[mirror_edk2.git] / MdeModulePkg / Universal / HiiDatabaseDxe / ConfigKeywordHandler.c
CommitLineData
87bfeb11
ED		 1/** @file\r
2Implementation of interfaces function for EFI_CONFIG_KEYWORD_HANDLER_PROTOCOL.\r
3\r
4Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r
5This program and the accompanying materials\r
6are licensed and made available under the terms and conditions of the BSD License\r
7which accompanies this distribution. The full text of the license may be found at\r
8http://opensource.org/licenses/bsd-license.php\r
9\r
10THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13**/\r
14\r
15\r
16#include "HiiDatabase.h"\r
17\r
18extern HII_DATABASE_PRIVATE_DATA mPrivate;\r
19\r
20/**\r
21 Convert the hex UNICODE %02x encoding of a UEFI device path to binary\r
22 from <PathHdr> of <MultiKeywordRequest>.\r
23\r
24 This is a internal function.\r
25\r
26 @param String MultiKeywordRequest string.\r
27 @param DevicePathData Binary of a UEFI device path.\r
28 @param NextString string follow the possible PathHdr string.\r
29\r
30 @retval EFI_INVALID_PARAMETER The device path is not valid or the incoming parameter is invalid.\r
31 @retval EFI_OUT_OF_RESOURCES Lake of resources to store neccesary structures.\r
32 @retval EFI_SUCCESS The device path is retrieved and translated to binary format.\r
33 The Input string not include PathHdr section.\r
34\r
35**/\r
36EFI_STATUS\r
37ExtractDevicePath (\r
38 IN EFI_STRING String,\r
39 OUT UINT8 **DevicePathData,\r
40 OUT EFI_STRING *NextString\r
41 )\r
42{\r
43 UINTN Length;\r
44 EFI_STRING PathHdr;\r
45 UINT8 *DevicePathBuffer;\r
46 CHAR16 TemStr[2];\r
47 UINTN Index;\r
48 UINT8 DigitUint8;\r
49 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
50\r
51 ASSERT (NextString != NULL && DevicePathData != NULL);\r
52\r
53 //\r
54 // KeywordRequest == NULL case.\r
55 //\r
56 if (String == NULL) {\r
57 *DevicePathData = NULL;\r
58 *NextString = NULL;\r
59 return EFI_SUCCESS;\r
60 }\r
61\r
62 //\r
63 // Skip '&' if exist.\r
64 //\r
65 if (*String == L'&') {\r
66 String ++;\r
67 }\r
68\r
69 //\r
70 // Find the 'PATH=' of <PathHdr>.\r
71 //\r
72 if (StrnCmp (String, L"PATH=", StrLen (L"PATH=")) != 0) {\r
73 if (StrnCmp (String, L"KEYWORD=", StrLen (L"KEYWORD=")) != 0) {\r
74 return EFI_INVALID_PARAMETER;\r
75 } else {\r
76 //\r
77 // Not include PathHdr, return success and DevicePath = NULL.\r
78 //\r
79 *DevicePathData = NULL;\r
80 *NextString = String;\r
81 return EFI_SUCCESS;\r
82 }\r
83 }\r
84\r
85 //\r
86 // Check whether path data does exist.\r
87 //\r
88 String += StrLen (L"PATH=");\r
89 if (*String == 0) {\r
90 return EFI_INVALID_PARAMETER;\r
91 }\r
92 PathHdr = String;\r
93\r
94 //\r
95 // The content between 'PATH=' of <ConfigHdr> and '&' of next element\r
96 // or '\0' (end of configuration string) is the UNICODE %02x bytes encoding\r
97 // of UEFI device path.\r
98 //\r
99 for (Length = 0; *String != 0 && *String != L'&'; String++, Length++);\r
100\r
101 //\r
102 // Save the return next keyword string value.\r
103 //\r
104 *NextString = String;\r
105\r
106 //\r
107 // Check DevicePath Length\r
108 //\r
109 if (((Length + 1) / 2) < sizeof (EFI_DEVICE_PATH_PROTOCOL)) {\r
110 return EFI_INVALID_PARAMETER;\r
111 }\r
112 \r
113 //\r
114 // The data in <PathHdr> is encoded as hex UNICODE %02x bytes in the same order\r
115 // as the device path resides in RAM memory.\r
116 // Translate the data into binary.\r
117 //\r
118 DevicePathBuffer = (UINT8 *) AllocateZeroPool ((Length + 1) / 2);\r
119 if (DevicePathBuffer == NULL) {\r
120 return EFI_OUT_OF_RESOURCES;\r
121 }\r
122 \r
123 //\r
124 // Convert DevicePath\r
125 //\r
126 ZeroMem (TemStr, sizeof (TemStr));\r
127 for (Index = 0; Index < Length; Index ++) {\r
128 TemStr[0] = PathHdr[Index];\r
129 DigitUint8 = (UINT8) StrHexToUint64 (TemStr);\r
130 if ((Index & 1) == 0) {\r
131 DevicePathBuffer [Index/2] = DigitUint8;\r
132 } else {\r
133 DevicePathBuffer [Index/2] = (UINT8) ((DevicePathBuffer [Index/2] << 4) + DigitUint8);\r
134 }\r
135 }\r
136 \r
137 //\r
138 // Validate DevicePath\r
139 //\r
140 DevicePath = (EFI_DEVICE_PATH_PROTOCOL *) DevicePathBuffer;\r
141 while (!IsDevicePathEnd (DevicePath)) {\r
142 if ((DevicePath->Type == 0) || (DevicePath->SubType == 0) || (DevicePathNodeLength (DevicePath) < sizeof (EFI_DEVICE_PATH_PROTOCOL))) {\r
143 //\r
144 // Invalid device path\r
145 //\r
146 FreePool (DevicePathBuffer);\r
147 return EFI_INVALID_PARAMETER;\r
148 }\r
149 DevicePath = NextDevicePathNode (DevicePath);\r
150 }\r
151\r
152 //\r
153 // return the device path\r
154 //\r
155 *DevicePathData = DevicePathBuffer;\r
156\r
157 return EFI_SUCCESS;\r
158}\r
159\r
160/**\r
161 Get NameSpace from the input NameSpaceId string.\r
162\r
163 This is a internal function.\r
164\r
165 @param String <NameSpaceId> format string.\r
166 @param NameSpace Return the name space string.\r
167 @param NextString Return the next string follow namespace.\r
168\r
169 @retval EFI_SUCCESS Get the namespace string success.\r
170 @retval EFI_INVALID_PARAMETER The NameSpaceId string not follow spec definition.\r
171\r
172**/\r
173EFI_STATUS\r
174ExtractNameSpace (\r
175 IN EFI_STRING String,\r
176 OUT CHAR8 **NameSpace,\r
177 OUT EFI_STRING *NextString\r
178 )\r
179{\r
180 CHAR16 *TmpPtr;\r
181\r
182 ASSERT (NameSpace != NULL);\r
183\r
184 TmpPtr = NULL;\r
185\r
186 //\r
187 // Input NameSpaceId == NULL\r
188 //\r
189 if (String == NULL) {\r
190 *NameSpace = NULL;\r
191 if (NextString != NULL) {\r
192 *NextString = NULL;\r
193 }\r
194 return EFI_SUCCESS;\r
195 }\r
196\r
197 //\r
198 // Skip '&' if exist.\r
199 //\r
200 if (*String == L'&') {\r
201 String++;\r
202 }\r
203\r
204 if (StrnCmp (String, L"NAMESPACE=", StrLen (L"NAMESPACE=")) != 0) {\r
205 return EFI_INVALID_PARAMETER;\r
206 }\r
207 String += StrLen (L"NAMESPACE=");\r
208\r
209 TmpPtr = StrStr (String, L"&");\r
210 if (TmpPtr != NULL) {\r
211 *TmpPtr = 0; \r
212 }\r
213 if (NextString != NULL) {\r
214 *NextString = String + StrLen (String);\r
215 }\r
216\r
217 //\r
218 // Input NameSpace is unicode string. The language in String package is ascii string.\r
219 // Here will convert the unicode string to ascii and save it.\r
220 //\r
221 *NameSpace = AllocatePool (StrLen (String) + 1);\r
222 if (*NameSpace == NULL) {\r
223 return EFI_OUT_OF_RESOURCES;\r
224 }\r
225 UnicodeStrToAsciiStr (String, *NameSpace);\r
226\r
227 if (TmpPtr != NULL) {\r
228 *TmpPtr = L'&'; \r
229 }\r
230\r
231 return EFI_SUCCESS;\r
232}\r
233\r
234/**\r
235 Get Keyword from the input KeywordRequest string.\r
236\r
237 This is a internal function.\r
238\r
239 @param String KeywordRequestformat string.\r
240 @param Keyword return the extract keyword string.\r
241 @param NextString return the next string follow this keyword sectin.\r
242\r
243 @retval EFI_SUCCESS Success to get the keyword string.\r
244 @retval EFI_INVALID_PARAMETER Parsr the input string return error.\r
245\r
246**/\r
247EFI_STATUS\r
248ExtractKeyword (\r
249 IN EFI_STRING String,\r
250 OUT EFI_STRING *Keyword,\r
251 OUT EFI_STRING *NextString\r
252 )\r
253{\r
254 EFI_STRING TmpPtr;\r
255\r
256 ASSERT ((Keyword != NULL) && (NextString != NULL));\r
257 \r
258 TmpPtr = NULL;\r
259\r
260 //\r
261 // KeywordRequest == NULL case.\r
262 //\r
263 if (String == NULL) {\r
264 *Keyword = NULL;\r
265 *NextString = NULL;\r
266 return EFI_SUCCESS;\r
267 }\r
268\r
269 //\r
270 // Skip '&' if exist.\r
271 //\r
272 if (*String == L'&') {\r
273 String++;\r
274 }\r
275\r
276 if (StrnCmp (String, L"KEYWORD=", StrLen (L"KEYWORD=")) != 0) {\r
277 return EFI_INVALID_PARAMETER;\r
278 }\r
279\r
280 String += StrLen (L"KEYWORD=");\r
281 \r
282 TmpPtr = StrStr (String, L"&");\r
283 if (TmpPtr != NULL) {\r
284 *TmpPtr = 0; \r
285 }\r
286 *NextString = String + StrLen (String);\r
287\r
288 *Keyword = AllocateCopyPool (StrSize (String), String);\r
289 if (*Keyword == NULL) {\r
290 return EFI_OUT_OF_RESOURCES;\r
291 }\r
292\r
293 if (TmpPtr != NULL) {\r
294 *TmpPtr = L'&';\r
295 }\r
296 \r
297 return EFI_SUCCESS;\r
298}\r
299\r
300/**\r
301 Get value from the input KeywordRequest string.\r
302\r
303 This is a internal function.\r
304\r
305 @param String KeywordRequestformat string.\r
306 @param Value return the extract value string.\r
307 @param NextString return the next string follow this keyword sectin.\r
308\r
309 @retval EFI_SUCCESS Success to get the keyword string.\r
310 @retval EFI_INVALID_PARAMETER Parsr the input string return error.\r
311\r
312**/\r
313EFI_STATUS\r
314ExtractValue (\r
315 IN EFI_STRING String,\r
316 OUT EFI_STRING *Value,\r
317 OUT EFI_STRING *NextString\r
318 )\r
319{\r
320 EFI_STRING TmpPtr;\r
321\r
322 ASSERT ((Value != NULL) && (NextString != NULL) && (String != NULL));\r
323\r
324 //\r
325 // Skip '&' if exist.\r
326 //\r
327 if (*String == L'&') {\r
328 String++;\r
329 }\r
330\r
331 if (StrnCmp (String, L"VALUE=", StrLen (L"VALUE=")) != 0) {\r
332 return EFI_INVALID_PARAMETER;\r
333 }\r
334\r
335 String += StrLen (L"VALUE=");\r
336 \r
337 TmpPtr = StrStr (String, L"&");\r
338 if (TmpPtr != NULL) {\r
339 *TmpPtr = 0; \r
340 }\r
341 *NextString = String + StrLen (String);\r
342\r
343 *Value = AllocateCopyPool (StrSize (String), String);\r
344 if (*Value == NULL) {\r
345 return EFI_OUT_OF_RESOURCES;\r
346 }\r
347\r
348 if (TmpPtr != NULL) {\r
349 *TmpPtr = L'&';\r
350 }\r
351 \r
352 return EFI_SUCCESS;\r
353}\r
354\r
355/**\r
356 Get filter from the input KeywordRequest string.\r
357\r
358 This is a internal function.\r
359\r
360 @param String KeywordRequestformat string.\r
361 @param FilterFlags return the filter condition.\r
362 @param NextString return the next string follow this keyword sectin.\r
363\r
364 @retval EFI_SUCCESS Success to get the keyword string.\r
365 @retval EFI_INVALID_PARAMETER Parsr the input string return error.\r
366\r
367**/\r
368BOOLEAN\r
369ExtractFilter (\r
370 IN EFI_STRING String,\r
371 OUT UINT8 *FilterFlags,\r
372 OUT EFI_STRING *NextString\r
373 )\r
374{\r
375 CHAR16 *PathPtr;\r
376 CHAR16 *KeywordPtr;\r
377 BOOLEAN RetVal; \r
378\r
379 ASSERT ((FilterFlags != NULL) && (NextString != NULL));\r
380\r
381 //\r
382 // String end, no filter section.\r
383 //\r
384 if (String == NULL) {\r
385 *NextString = NULL;\r
386 return FALSE;\r
387 }\r
388 \r
389 *FilterFlags = 0;\r
390 RetVal = TRUE;\r
391\r
392 //\r
393 // Skip '&' if exist.\r
394 //\r
395 if (*String == L'&') {\r
396 String++;\r
397 }\r
398\r
399 if (StrnCmp (String, L"ReadOnly", StrLen (L"ReadOnly")) == 0) {\r
400 //\r
401 // Find ReadOnly filter.\r
402 //\r
403 *FilterFlags |= EFI_KEYWORD_FILTER_READONY;\r
404 String += StrLen (L"ReadOnly");\r
405 } else if (StrnCmp (String, L"ReadWrite", StrLen (L"ReadWrite")) == 0) {\r
406 //\r
407 // Find ReadWrite filter.\r
408 //\r
409 *FilterFlags |= EFI_KEYWORD_FILTER_REAWRITE;\r
410 String += StrLen (L"ReadWrite");\r
411 } else if (StrnCmp (String, L"Buffer", StrLen (L"Buffer")) == 0) {\r
412 //\r
413 // Find Buffer Filter.\r
414 //\r
415 *FilterFlags |= EFI_KEYWORD_FILTER_BUFFER;\r
416 String += StrLen (L"Buffer");\r
417 } else if (StrnCmp (String, L"Numeric", StrLen (L"Numeric")) == 0) {\r
418 //\r
419 // Find Numeric Filter\r
420 //\r
421 String += StrLen (L"Numeric");\r
422 if (*String != L':') {\r
423 *FilterFlags |= EFI_KEYWORD_FILTER_NUMERIC;\r
424 } else {\r
425 String++;\r
426 switch (*String) {\r
427 case L'1':\r
428 *FilterFlags |= EFI_KEYWORD_FILTER_NUMERIC_1;\r
429 break;\r
430 case L'2':\r
431 *FilterFlags |= EFI_KEYWORD_FILTER_NUMERIC_2;\r
432 break;\r
433 case L'4':\r
434 *FilterFlags |= EFI_KEYWORD_FILTER_NUMERIC_4;\r
435 break;\r
436 case L'8':\r
437 *FilterFlags |= EFI_KEYWORD_FILTER_NUMERIC_8;\r
438 break;\r
439 default:\r
440 ASSERT (FALSE);\r
441 break;\r
442 }\r
443 String++;\r
444 }\r
445 } else {\r
446 //\r
447 // Check whether other filter item defined by Platform.\r
448 //\r
449 if ((StrnCmp (String, L"&PATH", StrLen (L"&PATH")) == 0) ||\r
450 (StrnCmp (String, L"&KEYWORD", StrLen (L"&KEYWORD")) == 0)) {\r
451 //\r
452 // New KeywordRequest start, no platform defined filter.\r
453 //\r
454 } else {\r
455 //\r
456 // Platform defined filter rule.\r
457 // Just skip platform defined filter rule, return success.\r
458 //\r
459 PathPtr = StrStr(String, L"&PATH");\r
460 KeywordPtr = StrStr(String, L"&KEYWORD");\r
461 if (PathPtr != NULL && KeywordPtr != NULL) {\r
462 //\r
463 // If both sections exist, return the first follow string.\r
464 //\r
465 String = KeywordPtr > PathPtr ? PathPtr : KeywordPtr;\r
466 } else if (PathPtr != NULL) {\r
467 //\r
468 // Should not exist PathPtr != NULL && KeywordPtr == NULL case.\r
469 //\r
470 ASSERT (FALSE);\r
471 } else if (KeywordPtr != NULL) {\r
472 //\r
473 // Just to the next keyword section.\r
474 //\r
475 String = KeywordPtr;\r
476 } else {\r
477 //\r
478 // Only has paltform defined filter section, just skip it.\r
479 //\r
480 String += StrLen (String);\r
481 }\r
482 }\r
483 RetVal = FALSE;\r
484 }\r
485\r
486 *NextString = String;\r
487\r
488 return RetVal;\r
489}\r
490\r
491/**\r
492 Extract Readonly flag from opcode.\r
493\r
494 This is a internal function.\r
495\r
496 @param OpCodeData Input opcode for this question.\r
497\r
498 @retval TRUE This question is readonly.\r
499 @retval FALSE This question is not readonly.\r
500\r
501**/\r
502BOOLEAN\r
503ExtractReadOnlyFromOpCode (\r
504 IN UINT8 *OpCodeData\r
505 )\r
506{\r
507 EFI_IFR_QUESTION_HEADER *QuestionHdr;\r
508\r
509 ASSERT (OpCodeData != NULL);\r
510\r
511 QuestionHdr = (EFI_IFR_QUESTION_HEADER *) (OpCodeData + sizeof (EFI_IFR_OP_HEADER));\r
512\r
513 return (QuestionHdr->Flags & EFI_IFR_FLAG_READ_ONLY) != 0;\r
514}\r
515\r
516/**\r
517 Create a circuit to check the filter section.\r
518\r
519 This is a internal function.\r
520\r
521 @param OpCodeData The questin binary ifr data.\r
522 @param KeywordRequest KeywordRequestformat string.\r
523 @param NextString return the next string follow this keyword sectin.\r
524 @param ReadOnly Return whether this question is read only.\r
525\r
526 @retval KEYWORD_HANDLER_NO_ERROR Success validate.\r
527 @retval KEYWORD_HANDLER_INCOMPATIBLE_VALUE_DETECTED Validate fail.\r
528\r
529**/\r
530UINT32\r
531ValidateFilter (\r
532 IN UINT8 *OpCodeData,\r
533 IN CHAR16 *KeywordRequest,\r
534 OUT CHAR16 **NextString,\r
535 OUT BOOLEAN *ReadOnly\r
536 )\r
537{\r
538 CHAR16 *NextFilter;\r
539 CHAR16 *StringPtr;\r
540 UINT8 FilterFlags;\r
541 EFI_IFR_QUESTION_HEADER *QuestionHdr;\r
542 EFI_IFR_OP_HEADER *OpCodeHdr;\r
543 UINT8 Flags;\r
544 UINT32 RetVal;\r
545\r
546 RetVal = KEYWORD_HANDLER_NO_ERROR;\r
547 StringPtr = KeywordRequest;\r
548\r
549 OpCodeHdr = (EFI_IFR_OP_HEADER *) OpCodeData;\r
550 QuestionHdr = (EFI_IFR_QUESTION_HEADER *) (OpCodeData + sizeof (EFI_IFR_OP_HEADER));\r
551 if (OpCodeHdr->OpCode == EFI_IFR_ONE_OF_OP || OpCodeHdr->OpCode == EFI_IFR_NUMERIC_OP) {\r
552 Flags = *(OpCodeData + sizeof (EFI_IFR_OP_HEADER) + sizeof (EFI_IFR_QUESTION_HEADER));\r
553 } else {\r
554 Flags = 0;\r
555 }\r
556\r
557 //\r
558 // Get ReadOnly flag from Question.\r
559 // \r
560 *ReadOnly = ExtractReadOnlyFromOpCode(OpCodeData);\r
561\r
562 while (ExtractFilter (StringPtr, &FilterFlags, &NextFilter)) {\r
563 switch (FilterFlags) {\r
564 case EFI_KEYWORD_FILTER_READONY:\r
565 if ((QuestionHdr->Flags & EFI_IFR_FLAG_READ_ONLY) == 0) {\r
566 RetVal = KEYWORD_HANDLER_INCOMPATIBLE_VALUE_DETECTED;\r
567 goto Done;\r
568 }\r
569 break;\r
570\r
571 case EFI_KEYWORD_FILTER_REAWRITE:\r
572 if ((QuestionHdr->Flags & EFI_IFR_FLAG_READ_ONLY) != 0) {\r
573 RetVal = KEYWORD_HANDLER_INCOMPATIBLE_VALUE_DETECTED;\r
574 goto Done;\r
575 }\r
576 break;\r
577\r
578 case EFI_KEYWORD_FILTER_BUFFER:\r
579 //\r
580 // Only these three opcode use numeric value type.\r
581 //\r
582 if (OpCodeHdr->OpCode == EFI_IFR_ONE_OF_OP || OpCodeHdr->OpCode == EFI_IFR_NUMERIC_OP || OpCodeHdr->OpCode == EFI_IFR_CHECKBOX_OP) {\r
583 RetVal = KEYWORD_HANDLER_INCOMPATIBLE_VALUE_DETECTED;\r
584 goto Done;\r
585 }\r
586 break;\r
587\r
588 case EFI_KEYWORD_FILTER_NUMERIC:\r
589 if (OpCodeHdr->OpCode != EFI_IFR_ONE_OF_OP && OpCodeHdr->OpCode != EFI_IFR_NUMERIC_OP && OpCodeHdr->OpCode != EFI_IFR_CHECKBOX_OP) {\r
590 RetVal = KEYWORD_HANDLER_INCOMPATIBLE_VALUE_DETECTED;\r
591 goto Done;\r
592 }\r
593 break;\r
594\r
595 case EFI_KEYWORD_FILTER_NUMERIC_1:\r
596 case EFI_KEYWORD_FILTER_NUMERIC_2:\r
597 case EFI_KEYWORD_FILTER_NUMERIC_4:\r
598 case EFI_KEYWORD_FILTER_NUMERIC_8:\r
599 if (OpCodeHdr->OpCode != EFI_IFR_ONE_OF_OP && OpCodeHdr->OpCode != EFI_IFR_NUMERIC_OP && OpCodeHdr->OpCode != EFI_IFR_CHECKBOX_OP) {\r
600 RetVal = KEYWORD_HANDLER_INCOMPATIBLE_VALUE_DETECTED;\r
601 goto Done;\r
602 }\r
603\r
604 //\r
605 // For numeric and oneof, it has flags field to specify the detail numeric type.\r
606 //\r
607 if (OpCodeHdr->OpCode == EFI_IFR_ONE_OF_OP || OpCodeHdr->OpCode == EFI_IFR_NUMERIC_OP) {\r
608 switch (Flags & EFI_IFR_NUMERIC_SIZE) {\r
609 case EFI_IFR_NUMERIC_SIZE_1:\r
610 if (FilterFlags != EFI_KEYWORD_FILTER_NUMERIC_1) {\r
611 RetVal = KEYWORD_HANDLER_INCOMPATIBLE_VALUE_DETECTED;\r
612 goto Done;\r
613 }\r
614 break;\r
615\r
616 case EFI_IFR_NUMERIC_SIZE_2:\r
617 if (FilterFlags != EFI_KEYWORD_FILTER_NUMERIC_2) {\r
618 RetVal = KEYWORD_HANDLER_INCOMPATIBLE_VALUE_DETECTED;\r
619 goto Done;\r
620 }\r
621 break;\r
622\r
623 case EFI_IFR_NUMERIC_SIZE_4:\r
624 if (FilterFlags != EFI_KEYWORD_FILTER_NUMERIC_4) {\r
625 RetVal = KEYWORD_HANDLER_INCOMPATIBLE_VALUE_DETECTED;\r
626 goto Done;\r
627 }\r
628 break;\r
629\r
630 case EFI_IFR_NUMERIC_SIZE_8:\r
631 if (FilterFlags != EFI_KEYWORD_FILTER_NUMERIC_8) {\r
632 RetVal = KEYWORD_HANDLER_INCOMPATIBLE_VALUE_DETECTED;\r
633 goto Done;\r
634 }\r
635 break;\r
636\r
637 default:\r
638 ASSERT (FALSE);\r
639 break;\r
640 }\r
641 }\r
642 break;\r
643\r
644 default:\r
645 ASSERT (FALSE);\r
646 break;\r
647 }\r
648\r
649 //\r
650 // Jump to the next filter.\r
651 //\r
652 StringPtr = NextFilter;\r
653 }\r
654 \r
655Done:\r
656 //\r
657 // The current filter which is processing.\r
658 //\r
659 *NextString = StringPtr;\r
660\r
661 return RetVal;\r
662}\r
663\r
664/**\r
665 Get HII_DATABASE_RECORD from the input device path info.\r
666\r
667 This is a internal function.\r
668\r
669 @param DevicePath UEFI device path protocol.\r
670\r
671 @retval Internal data base record.\r
672\r
673**/\r
674HII_DATABASE_RECORD *\r
675GetRecordFromDevicePath (\r
676 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
677 )\r
678{\r
679 LIST_ENTRY *Link;\r
680 UINT8 *DevicePathPkg;\r
681 UINT8 *CurrentDevicePath;\r
682 UINTN DevicePathSize;\r
683 HII_DATABASE_RECORD *TempDatabase;\r
684\r
685 ASSERT (DevicePath != NULL);\r
686\r
687 for (Link = mPrivate.DatabaseList.ForwardLink; Link != &mPrivate.DatabaseList; Link = Link->ForwardLink) {\r
688 TempDatabase = CR (Link, HII_DATABASE_RECORD, DatabaseEntry, HII_DATABASE_RECORD_SIGNATURE);\r
689 DevicePathPkg = TempDatabase->PackageList->DevicePathPkg;\r
690 if (DevicePathPkg != NULL) {\r
691 CurrentDevicePath = DevicePathPkg + sizeof (EFI_HII_PACKAGE_HEADER);\r
692 DevicePathSize = GetDevicePathSize ((EFI_DEVICE_PATH_PROTOCOL *) CurrentDevicePath);\r
693 if ((CompareMem (DevicePath, CurrentDevicePath, DevicePathSize) == 0)) {\r
694 return TempDatabase;\r
695 }\r
696 }\r
697 }\r
698\r
699 return NULL;\r
700}\r
701\r
702/**\r
703 Calculate the size of StringSrc and output it. Also copy string text from src \r
704 to dest.\r
705\r
706 This is a internal function.\r
707\r
708 @param StringSrc Points to current null-terminated string.\r
709 @param BufferSize Length of the buffer.\r
710 @param StringDest Buffer to store the string text. \r
711\r
712 @retval EFI_SUCCESS The string text was outputed successfully.\r
713 @retval EFI_OUT_OF_RESOURCES Out of resource.\r
714\r
715**/\r
716EFI_STATUS\r
717GetUnicodeStringTextAndSize (\r
718 IN UINT8 *StringSrc,\r
719 OUT UINTN *BufferSize,\r
720 OUT EFI_STRING *StringDest\r
721 )\r
722{\r
723 UINTN StringSize;\r
724 UINT8 *StringPtr;\r
725\r
726 ASSERT (StringSrc != NULL && BufferSize != NULL && StringDest != NULL);\r
727\r
728 StringSize = sizeof (CHAR16);\r
729 StringPtr = StringSrc;\r
730 while (ReadUnaligned16 ((UINT16 *) StringPtr) != 0) {\r
731 StringSize += sizeof (CHAR16);\r
732 StringPtr += sizeof (CHAR16);\r
733 }\r
734\r
735 *StringDest = AllocatePool (StringSize);\r
736 if (*StringDest == NULL) {\r
737 return EFI_OUT_OF_RESOURCES;\r
738 }\r
739 \r
740 CopyMem (*StringDest, StringSrc, StringSize);\r
741\r
742 *BufferSize = StringSize;\r
743 return EFI_SUCCESS;\r
744}\r
745\r
746/**\r
747 Find the string id for the input keyword.\r
748\r
749 @param StringPackage Hii string package instance.\r
750 @param KeywordValue Input keyword value.\r
751 @param StringId The string's id, which is unique within PackageList.\r
752\r
753\r
754 @retval EFI_SUCCESS The string text and font is retrieved\r
755 successfully.\r
756 @retval EFI_NOT_FOUND The specified text or font info can not be found\r
757 out.\r
758 @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the\r
759 task.\r
760**/\r
761EFI_STATUS\r
762GetStringIdFromString (\r
763 IN HII_STRING_PACKAGE_INSTANCE *StringPackage,\r
764 IN CHAR16 *KeywordValue,\r
765 OUT EFI_STRING_ID *StringId\r
766 )\r
767{\r
768 UINT8 *BlockHdr;\r
769 EFI_STRING_ID CurrentStringId;\r
770 UINTN BlockSize;\r
771 UINTN Index;\r
772 UINT8 *StringTextPtr;\r
773 UINTN Offset;\r
774 UINT16 StringCount;\r
775 UINT16 SkipCount;\r
776 UINT8 Length8;\r
777 EFI_HII_SIBT_EXT2_BLOCK Ext2;\r
778 UINT32 Length32;\r
779 UINTN StringSize;\r
780 CHAR16 *String;\r
781 CHAR8 *AsciiKeywordValue;\r
782 EFI_STATUS Status;\r
783\r
784 ASSERT (StringPackage != NULL && KeywordValue != NULL && StringId != NULL);\r
785 ASSERT (StringPackage->Signature == HII_STRING_PACKAGE_SIGNATURE);\r
786\r
787 CurrentStringId = 1;\r
788 Status = EFI_SUCCESS;\r
789 String = NULL;\r
790 BlockHdr = StringPackage->StringBlock;\r
791 BlockSize = 0;\r
792 Offset = 0;\r
793\r
794 //\r
795 // Make a ascii keyword value for later use.\r
796 //\r
797 AsciiKeywordValue = AllocatePool (StrLen (KeywordValue) + 1);\r
798 if (AsciiKeywordValue == NULL) {\r
799 return EFI_OUT_OF_RESOURCES;\r
800 }\r
801 UnicodeStrToAsciiStr(KeywordValue, AsciiKeywordValue);\r
802\r
803 while (*BlockHdr != EFI_HII_SIBT_END) {\r
804 switch (*BlockHdr) {\r
805 case EFI_HII_SIBT_STRING_SCSU:\r
806 Offset = sizeof (EFI_HII_STRING_BLOCK);\r
807 StringTextPtr = BlockHdr + Offset;\r
808 BlockSize += Offset + AsciiStrSize ((CHAR8 *) StringTextPtr);\r
c2400145 809 if (AsciiStrCmp(AsciiKeywordValue, (CHAR8 *) StringTextPtr) == 0) {\r
87bfeb11
ED		 810 *StringId = CurrentStringId;\r
811 goto Done;\r
812 }\r
813 CurrentStringId++;\r
814 break;\r
815\r
816 case EFI_HII_SIBT_STRING_SCSU_FONT:\r
817 Offset = sizeof (EFI_HII_SIBT_STRING_SCSU_FONT_BLOCK) - sizeof (UINT8);\r
818 StringTextPtr = BlockHdr + Offset;\r
c2400145 819 if (AsciiStrCmp(AsciiKeywordValue, (CHAR8 *) StringTextPtr) == 0) {\r
87bfeb11
ED		 820 *StringId = CurrentStringId;\r
821 goto Done;\r
822 }\r
823 BlockSize += Offset + AsciiStrSize ((CHAR8 *) StringTextPtr);\r
824 CurrentStringId++;\r
825 break;\r
826\r
827 case EFI_HII_SIBT_STRINGS_SCSU:\r
828 CopyMem (&StringCount, BlockHdr + sizeof (EFI_HII_STRING_BLOCK), sizeof (UINT16));\r
829 StringTextPtr = (UINT8*)((UINTN)BlockHdr + sizeof (EFI_HII_SIBT_STRINGS_SCSU_BLOCK) - sizeof (UINT8));\r
830 BlockSize += StringTextPtr - BlockHdr;\r
831\r
832 for (Index = 0; Index < StringCount; Index++) {\r
833 BlockSize += AsciiStrSize ((CHAR8 *) StringTextPtr);\r
c2400145 834 if (AsciiStrCmp(AsciiKeywordValue, (CHAR8 *) StringTextPtr) == 0) {\r
87bfeb11
ED		 835 *StringId = CurrentStringId;\r
836 goto Done;\r
837 }\r
838 StringTextPtr = StringTextPtr + AsciiStrSize ((CHAR8 *) StringTextPtr);\r
839 CurrentStringId++;\r
840 }\r
841 break;\r
842\r
843 case EFI_HII_SIBT_STRINGS_SCSU_FONT:\r
844 CopyMem (\r
845 &StringCount,\r
846 (UINT8*)((UINTN)BlockHdr + sizeof (EFI_HII_STRING_BLOCK) + sizeof (UINT8)),\r
847 sizeof (UINT16)\r
848 );\r
849 StringTextPtr = (UINT8*)((UINTN)BlockHdr + sizeof (EFI_HII_SIBT_STRINGS_SCSU_FONT_BLOCK) - sizeof (UINT8));\r
850 BlockSize += StringTextPtr - BlockHdr;\r
851\r
852 for (Index = 0; Index < StringCount; Index++) {\r
853 BlockSize += AsciiStrSize ((CHAR8 *) StringTextPtr);\r
c2400145 854 if (AsciiStrCmp(AsciiKeywordValue, (CHAR8 *) StringTextPtr) == 0) {\r
87bfeb11
ED		 855 *StringId = CurrentStringId;\r
856 goto Done;\r
857 }\r
858 StringTextPtr = StringTextPtr + AsciiStrSize ((CHAR8 *) StringTextPtr);\r
859 CurrentStringId++;\r
860 }\r
861 break;\r
862\r
863 case EFI_HII_SIBT_STRING_UCS2:\r
864 Offset = sizeof (EFI_HII_STRING_BLOCK);\r
865 StringTextPtr = BlockHdr + Offset;\r
866 //\r
867 // Use StringSize to store the size of the specified string, including the NULL\r
868 // terminator.\r
869 //\r
870 Status = GetUnicodeStringTextAndSize (StringTextPtr, &StringSize, &String);\r
871 if (EFI_ERROR (Status)) {\r
872 goto Done;\r
873 }\r
874 \r
875 if (StrCmp(KeywordValue, String) == 0) {\r
876 *StringId = CurrentStringId;\r
877 goto Done;\r
878 }\r
879 BlockSize += Offset + StringSize;\r
880 CurrentStringId++;\r
881 break;\r
882\r
883 case EFI_HII_SIBT_STRING_UCS2_FONT:\r
884 Offset = sizeof (EFI_HII_SIBT_STRING_UCS2_FONT_BLOCK) - sizeof (CHAR16);\r
885 StringTextPtr = BlockHdr + Offset;\r
886 //\r
887 // Use StringSize to store the size of the specified string, including the NULL\r
888 // terminator.\r
889 //\r
890 Status = GetUnicodeStringTextAndSize (StringTextPtr, &StringSize, &String);\r
891 if (EFI_ERROR (Status)) {\r
892 goto Done;\r
893 }\r
894 \r
895 if (StrCmp(KeywordValue, String) == 0) {\r
896 *StringId = CurrentStringId;\r
897 goto Done;\r
898 }\r
899 BlockSize += Offset + StringSize;\r
900 CurrentStringId++;\r
901 break;\r
902\r
903 case EFI_HII_SIBT_STRINGS_UCS2:\r
904 Offset = sizeof (EFI_HII_SIBT_STRINGS_UCS2_BLOCK) - sizeof (CHAR16);\r
905 StringTextPtr = BlockHdr + Offset;\r
906 BlockSize += Offset;\r
907 CopyMem (&StringCount, BlockHdr + sizeof (EFI_HII_STRING_BLOCK), sizeof (UINT16));\r
908 for (Index = 0; Index < StringCount; Index++) {\r
909 Status = GetUnicodeStringTextAndSize (StringTextPtr, &StringSize, &String);\r
910 if (EFI_ERROR (Status)) {\r
911 goto Done;\r
912 }\r
913\r
914 BlockSize += StringSize;\r
915 if (StrCmp(KeywordValue, String) == 0) {\r
916 *StringId = CurrentStringId;\r
917 goto Done;\r
918 }\r
919 StringTextPtr = StringTextPtr + StringSize;\r
920 CurrentStringId++;\r
921 }\r
922 break;\r
923\r
924 case EFI_HII_SIBT_STRINGS_UCS2_FONT:\r
925 Offset = sizeof (EFI_HII_SIBT_STRINGS_UCS2_FONT_BLOCK) - sizeof (CHAR16);\r
926 StringTextPtr = BlockHdr + Offset;\r
927 BlockSize += Offset;\r
928 CopyMem (\r
929 &StringCount,\r
930 (UINT8*)((UINTN)BlockHdr + sizeof (EFI_HII_STRING_BLOCK) + sizeof (UINT8)),\r
931 sizeof (UINT16)\r
932 );\r
933 for (Index = 0; Index < StringCount; Index++) {\r
934 Status = GetUnicodeStringTextAndSize (StringTextPtr, &StringSize, &String);\r
935 if (EFI_ERROR (Status)) {\r
936 goto Done;\r
937 }\r
938\r
939 BlockSize += StringSize;\r
940 if (StrCmp(KeywordValue, String) == 0) {\r
941 *StringId = CurrentStringId;\r
942 goto Done;\r
943 }\r
944 StringTextPtr = StringTextPtr + StringSize;\r
945 CurrentStringId++;\r
946 }\r
947 break;\r
948\r
949 case EFI_HII_SIBT_DUPLICATE:\r
950 BlockSize += sizeof (EFI_HII_SIBT_DUPLICATE_BLOCK);\r
951 CurrentStringId++;\r
952 break;\r
953\r
954 case EFI_HII_SIBT_SKIP1:\r
955 SkipCount = (UINT16) (*(UINT8*)((UINTN)BlockHdr + sizeof (EFI_HII_STRING_BLOCK)));\r
956 CurrentStringId = (UINT16) (CurrentStringId + SkipCount);\r
957 BlockSize += sizeof (EFI_HII_SIBT_SKIP1_BLOCK);\r
958 break;\r
959\r
960 case EFI_HII_SIBT_SKIP2:\r
961 CopyMem (&SkipCount, BlockHdr + sizeof (EFI_HII_STRING_BLOCK), sizeof (UINT16));\r
962 CurrentStringId = (UINT16) (CurrentStringId + SkipCount);\r
963 BlockSize += sizeof (EFI_HII_SIBT_SKIP2_BLOCK);\r
964 break;\r
965\r
966 case EFI_HII_SIBT_EXT1:\r
967 CopyMem (\r
968 &Length8,\r
969 (UINT8*)((UINTN)BlockHdr + sizeof (EFI_HII_STRING_BLOCK) + sizeof (UINT8)),\r
970 sizeof (UINT8)\r
971 );\r
972 BlockSize += Length8;\r
973 break;\r
974\r
975 case EFI_HII_SIBT_EXT2:\r
976 CopyMem (&Ext2, BlockHdr, sizeof (EFI_HII_SIBT_EXT2_BLOCK));\r
977 BlockSize += Ext2.Length;\r
978 break;\r
979\r
980 case EFI_HII_SIBT_EXT4:\r
981 CopyMem (\r
982 &Length32,\r
983 (UINT8*)((UINTN)BlockHdr + sizeof (EFI_HII_STRING_BLOCK) + sizeof (UINT8)),\r
984 sizeof (UINT32)\r
985 );\r
986\r
987 BlockSize += Length32;\r
988 break;\r
989\r
990 default:\r
991 break;\r
992 }\r
993\r
994 if (String != NULL) {\r
995 FreePool (String);\r
996 String = NULL;\r
997 }\r
998\r
999 BlockHdr = StringPackage->StringBlock + BlockSize;\r
1000 }\r
1001\r
1002 Status = EFI_NOT_FOUND;\r
1003\r
1004Done:\r
1005 if (AsciiKeywordValue != NULL) {\r
1006 FreePool (AsciiKeywordValue);\r
1007 }\r
1008 if (String != NULL) {\r
1009 FreePool (String);\r
1010 }\r
1011 return Status;\r
1012}\r
1013\r
1014/**\r
1015 Find the next valid string id for the input string id.\r
1016\r
1017 @param StringPackage Hii string package instance.\r
1018 @param StringId The current string id which is already got.\r
1019 1 means just begin to get the string id.\r
1020 @param KeywordValue Return the string for the next string id.\r
1021\r
1022\r
1023 @retval EFI_STRING_ID Not 0 means a valid stringid found.\r
1024 0 means not found a valid string id.\r
1025**/\r
1026EFI_STRING_ID\r
1027GetNextStringId (\r
1028 IN HII_STRING_PACKAGE_INSTANCE *StringPackage,\r
1029 IN EFI_STRING_ID StringId,\r
1030 OUT EFI_STRING *KeywordValue\r
1031 )\r
1032{\r
1033 UINT8 *BlockHdr;\r
1034 EFI_STRING_ID CurrentStringId;\r
1035 UINTN BlockSize;\r
1036 UINTN Index;\r
1037 UINT8 *StringTextPtr;\r
1038 UINTN Offset;\r
1039 UINT16 StringCount;\r
1040 UINT16 SkipCount;\r
1041 UINT8 Length8;\r
1042 EFI_HII_SIBT_EXT2_BLOCK Ext2;\r
1043 UINT32 Length32;\r
1044 BOOLEAN FindString;\r
1045 UINTN StringSize;\r
1046 CHAR16 *String;\r
1047\r
1048 ASSERT (StringPackage != NULL);\r
1049 ASSERT (StringPackage->Signature == HII_STRING_PACKAGE_SIGNATURE);\r
1050\r
1051 CurrentStringId = 1;\r
1052 FindString = FALSE;\r
1053 String = NULL;\r
1054\r
1055 //\r
1056 // Parse the string blocks to get the string text and font.\r
1057 //\r
1058 BlockHdr = StringPackage->StringBlock;\r
1059 BlockSize = 0;\r
1060 Offset = 0;\r
1061 while (*BlockHdr != EFI_HII_SIBT_END) {\r
1062 switch (*BlockHdr) {\r
1063 case EFI_HII_SIBT_STRING_SCSU:\r
1064 Offset = sizeof (EFI_HII_STRING_BLOCK);\r
1065 StringTextPtr = BlockHdr + Offset;\r
1066 \r
1067 if (FindString) {\r
1068 *KeywordValue = AllocatePool (AsciiStrSize ((CHAR8 *) StringTextPtr) * sizeof (CHAR16));\r
1069 if (*KeywordValue == NULL) {\r
1070 return 0;\r
1071 }\r
c2400145 1072 AsciiStrToUnicodeStr ((CHAR8 *) StringTextPtr, *KeywordValue);\r
87bfeb11
ED		 1073 return CurrentStringId;\r
1074 } else if (CurrentStringId == StringId) {\r
1075 FindString = TRUE;\r
1076 }\r
1077\r
1078 BlockSize += Offset + AsciiStrSize ((CHAR8 *) StringTextPtr);\r
1079 CurrentStringId++;\r
1080 break;\r
1081\r
1082 case EFI_HII_SIBT_STRING_SCSU_FONT:\r
1083 Offset = sizeof (EFI_HII_SIBT_STRING_SCSU_FONT_BLOCK) - sizeof (UINT8);\r
1084 StringTextPtr = BlockHdr + Offset;\r
1085 \r
1086 if (FindString) {\r
1087 *KeywordValue = AllocatePool (AsciiStrSize ((CHAR8 *) StringTextPtr) * sizeof (CHAR16));\r
1088 if (*KeywordValue == NULL) {\r
1089 return 0;\r
1090 }\r
c2400145 1091 AsciiStrToUnicodeStr ((CHAR8 *) StringTextPtr, *KeywordValue);\r
87bfeb11
ED		 1092 return CurrentStringId;\r
1093 } else if (CurrentStringId == StringId) {\r
1094 FindString = TRUE;\r
1095 }\r
1096\r
1097 BlockSize += Offset + AsciiStrSize ((CHAR8 *) StringTextPtr);\r
1098 CurrentStringId++;\r
1099 break;\r
1100\r
1101 case EFI_HII_SIBT_STRINGS_SCSU:\r
1102 CopyMem (&StringCount, BlockHdr + sizeof (EFI_HII_STRING_BLOCK), sizeof (UINT16));\r
1103 StringTextPtr = (UINT8*)((UINTN)BlockHdr + sizeof (EFI_HII_SIBT_STRINGS_SCSU_BLOCK) - sizeof (UINT8));\r
1104 BlockSize += StringTextPtr - BlockHdr;\r
1105\r
1106 for (Index = 0; Index < StringCount; Index++) {\r
1107 if (FindString) {\r
1108 *KeywordValue = AllocatePool (AsciiStrSize ((CHAR8 *) StringTextPtr) * sizeof (CHAR16));\r
1109 if (*KeywordValue == NULL) {\r
1110 return 0;\r
1111 }\r
c2400145 1112 AsciiStrToUnicodeStr ((CHAR8 *) StringTextPtr, *KeywordValue);\r
87bfeb11
ED		 1113 return CurrentStringId;\r
1114 } else if (CurrentStringId == StringId) {\r
1115 FindString = TRUE;\r
1116 }\r
1117\r
1118 BlockSize += AsciiStrSize ((CHAR8 *) StringTextPtr);\r
1119 StringTextPtr = StringTextPtr + AsciiStrSize ((CHAR8 *) StringTextPtr);\r
1120 CurrentStringId++;\r
1121 }\r
1122 break;\r
1123\r
1124 case EFI_HII_SIBT_STRINGS_SCSU_FONT:\r
1125 CopyMem (\r
1126 &StringCount,\r
1127 (UINT8*)((UINTN)BlockHdr + sizeof (EFI_HII_STRING_BLOCK) + sizeof (UINT8)),\r
1128 sizeof (UINT16)\r
1129 );\r
1130 StringTextPtr = (UINT8*)((UINTN)BlockHdr + sizeof (EFI_HII_SIBT_STRINGS_SCSU_FONT_BLOCK) - sizeof (UINT8));\r
1131 BlockSize += StringTextPtr - BlockHdr;\r
1132\r
1133 for (Index = 0; Index < StringCount; Index++) {\r
1134 if (FindString) {\r
1135 *KeywordValue = AllocatePool (AsciiStrSize ((CHAR8 *) StringTextPtr) * sizeof (CHAR16));\r
1136 if (*KeywordValue == NULL) {\r
1137 return 0;\r
1138 }\r
c2400145 1139 AsciiStrToUnicodeStr ((CHAR8 *) StringTextPtr, *KeywordValue);\r
87bfeb11
ED		 1140 return CurrentStringId;\r
1141 } else if (CurrentStringId == StringId) {\r
1142 FindString = TRUE;\r
1143 }\r
1144\r
1145 BlockSize += AsciiStrSize ((CHAR8 *) StringTextPtr);\r
1146 StringTextPtr = StringTextPtr + AsciiStrSize ((CHAR8 *) StringTextPtr);\r
1147 CurrentStringId++;\r
1148 }\r
1149 break;\r
1150\r
1151 case EFI_HII_SIBT_STRING_UCS2:\r
1152 Offset = sizeof (EFI_HII_STRING_BLOCK);\r
1153 StringTextPtr = BlockHdr + Offset;\r
1154 //\r
1155 // Use StringSize to store the size of the specified string, including the NULL\r
1156 // terminator.\r
1157 //\r
1158 GetUnicodeStringTextAndSize (StringTextPtr, &StringSize, &String);\r
1159 if (FindString && (String != NULL) && (*String != L'\0')) {\r
1160 //\r
1161 // String protocol use this type for the string id which has value for other package.\r
1162 // It will allocate an empty string block for this string id. so here we also check\r
1163 // *String != L'\0' to prohibit this case.\r
1164 //\r
1165 *KeywordValue = String;\r
1166 return CurrentStringId;\r
1167 } else if (CurrentStringId == StringId) {\r
1168 FindString = TRUE;\r
1169 }\r
1170\r
1171 BlockSize += Offset + StringSize;\r
1172 CurrentStringId++;\r
1173 break;\r
1174\r
1175 case EFI_HII_SIBT_STRING_UCS2_FONT:\r
1176 Offset = sizeof (EFI_HII_SIBT_STRING_UCS2_FONT_BLOCK) - sizeof (CHAR16);\r
1177 StringTextPtr = BlockHdr + Offset;\r
1178 //\r
1179 // Use StringSize to store the size of the specified string, including the NULL\r
1180 // terminator.\r
1181 //\r
1182 GetUnicodeStringTextAndSize (StringTextPtr, &StringSize, &String);\r
1183 if (FindString) {\r
1184 *KeywordValue = String;\r
1185 return CurrentStringId;\r
1186 } else if (CurrentStringId == StringId) {\r
1187 FindString = TRUE;\r
1188 }\r
1189\r
1190 BlockSize += Offset + StringSize;\r
1191 CurrentStringId++;\r
1192 break;\r
1193\r
1194 case EFI_HII_SIBT_STRINGS_UCS2:\r
1195 Offset = sizeof (EFI_HII_SIBT_STRINGS_UCS2_BLOCK) - sizeof (CHAR16);\r
1196 StringTextPtr = BlockHdr + Offset;\r
1197 BlockSize += Offset;\r
1198 CopyMem (&StringCount, BlockHdr + sizeof (EFI_HII_STRING_BLOCK), sizeof (UINT16));\r
1199 for (Index = 0; Index < StringCount; Index++) {\r
1200 GetUnicodeStringTextAndSize (StringTextPtr, &StringSize, &String); \r
1201\r
1202 if (FindString) {\r
1203 *KeywordValue = String;\r
1204 return CurrentStringId;\r
1205 } else if (CurrentStringId == StringId) {\r
1206 FindString = TRUE;\r
1207 }\r
1208\r
1209 BlockSize += StringSize;\r
1210 StringTextPtr = StringTextPtr + StringSize;\r
1211 CurrentStringId++;\r
1212 }\r
1213 break;\r
1214\r
1215 case EFI_HII_SIBT_STRINGS_UCS2_FONT:\r
1216 Offset = sizeof (EFI_HII_SIBT_STRINGS_UCS2_FONT_BLOCK) - sizeof (CHAR16);\r
1217 StringTextPtr = BlockHdr + Offset;\r
1218 BlockSize += Offset;\r
1219 CopyMem (\r
1220 &StringCount,\r
1221 (UINT8*)((UINTN)BlockHdr + sizeof (EFI_HII_STRING_BLOCK) + sizeof (UINT8)),\r
1222 sizeof (UINT16)\r
1223 );\r
1224 for (Index = 0; Index < StringCount; Index++) {\r
1225 GetUnicodeStringTextAndSize (StringTextPtr, &StringSize, &String);\r
1226 if (FindString) {\r
1227 *KeywordValue = String;\r
1228 return CurrentStringId;\r
1229 } else if (CurrentStringId == StringId) {\r
1230 FindString = TRUE;\r
1231 }\r
1232\r
1233 BlockSize += StringSize;\r
1234 StringTextPtr = StringTextPtr + StringSize;\r
1235 CurrentStringId++;\r
1236 }\r
1237 break;\r
1238\r
1239 case EFI_HII_SIBT_DUPLICATE:\r
1240 BlockSize += sizeof (EFI_HII_SIBT_DUPLICATE_BLOCK);\r
1241 CurrentStringId++;\r
1242 break;\r
1243\r
1244 case EFI_HII_SIBT_SKIP1:\r
1245 SkipCount = (UINT16) (*(UINT8*)((UINTN)BlockHdr + sizeof (EFI_HII_STRING_BLOCK)));\r
1246 CurrentStringId = (UINT16) (CurrentStringId + SkipCount);\r
1247 BlockSize += sizeof (EFI_HII_SIBT_SKIP1_BLOCK);\r
1248 break;\r
1249\r
1250 case EFI_HII_SIBT_SKIP2:\r
1251 CopyMem (&SkipCount, BlockHdr + sizeof (EFI_HII_STRING_BLOCK), sizeof (UINT16));\r
1252 CurrentStringId = (UINT16) (CurrentStringId + SkipCount);\r
1253 BlockSize += sizeof (EFI_HII_SIBT_SKIP2_BLOCK);\r
1254 break;\r
1255\r
1256 case EFI_HII_SIBT_EXT1:\r
1257 CopyMem (\r
1258 &Length8,\r
1259 (UINT8*)((UINTN)BlockHdr + sizeof (EFI_HII_STRING_BLOCK) + sizeof (UINT8)),\r
1260 sizeof (UINT8)\r
1261 );\r
1262 BlockSize += Length8;\r
1263 break;\r
1264\r
1265 case EFI_HII_SIBT_EXT2:\r
1266 CopyMem (&Ext2, BlockHdr, sizeof (EFI_HII_SIBT_EXT2_BLOCK));\r
1267 BlockSize += Ext2.Length;\r
1268 break;\r
1269\r
1270 case EFI_HII_SIBT_EXT4:\r
1271 CopyMem (\r
1272 &Length32,\r
1273 (UINT8*)((UINTN)BlockHdr + sizeof (EFI_HII_STRING_BLOCK) + sizeof (UINT8)),\r
1274 sizeof (UINT32)\r
1275 );\r
1276\r
1277 BlockSize += Length32;\r
1278 break;\r
1279\r
1280 default:\r
1281 break;\r
1282 }\r
1283\r
1284 if (String != NULL) {\r
1285 FreePool (String);\r
1286 String = NULL;\r
1287 }\r
1288\r
1289 BlockHdr = StringPackage->StringBlock + BlockSize;\r
1290 }\r
1291\r
1292 return 0;\r
1293}\r
1294\r
1295/**\r
1296 Get string package from the input NameSpace string.\r
1297\r
1298 This is a internal function.\r
1299\r
1300 @param DatabaseRecord HII_DATABASE_RECORD format string.\r
1301 @param NameSpace NameSpace format string.\r
1302 @param KeywordValue Keyword value.\r
1303 @param StringId String Id for this keyword.\r
1304\r
1305 @retval KEYWORD_HANDLER_NO_ERROR Get String id succes.\r
1306 @retval KEYWORD_HANDLER_KEYWORD_NOT_FOUND Not found the string id in the string package.\r
1307 @retval KEYWORD_HANDLER_NAMESPACE_ID_NOT_FOUND Not found the string package for this namespace.\r
1308 @retval KEYWORD_HANDLER_UNDEFINED_PROCESSING_ERROR Out of resource error.\r
1309\r
1310**/\r
1311UINT32\r
1312GetStringIdFromRecord (\r
1313 IN HII_DATABASE_RECORD *DatabaseRecord,\r
1314 IN CHAR8 **NameSpace,\r
1315 IN CHAR16 *KeywordValue,\r
1316 OUT EFI_STRING_ID *StringId\r
1317 )\r
1318{\r
1319 LIST_ENTRY *Link;\r
1320 HII_DATABASE_PACKAGE_LIST_INSTANCE *PackageListNode;\r
1321 HII_STRING_PACKAGE_INSTANCE *StringPackage;\r
1322 EFI_STATUS Status;\r
1323 CHAR8 *Name;\r
5f25ead9 1324 UINT32 RetVal;\r
87bfeb11
ED		 1325\r
1326 ASSERT (DatabaseRecord != NULL && NameSpace != NULL && KeywordValue != NULL);\r
1327\r
1328 PackageListNode = DatabaseRecord->PackageList;\r
5f25ead9 1329 RetVal = KEYWORD_HANDLER_NAMESPACE_ID_NOT_FOUND;\r
87bfeb11
ED		 1330\r
1331 if (*NameSpace != NULL) {\r
1332 Name = *NameSpace;\r
1333 } else {\r
1334 Name = UEFI_CONFIG_LANG;\r
1335 }\r
1336\r
1337 for (Link = PackageListNode->StringPkgHdr.ForwardLink; Link != &PackageListNode->StringPkgHdr; Link = Link->ForwardLink) {\r
1338 StringPackage = CR (Link, HII_STRING_PACKAGE_INSTANCE, StringEntry, HII_STRING_PACKAGE_SIGNATURE);\r
1339\r
1340 if (AsciiStrnCmp(Name, StringPackage->StringPkgHdr->Language, AsciiStrLen (Name)) == 0) {\r
1341 Status = GetStringIdFromString (StringPackage, KeywordValue, StringId); \r
1342 if (EFI_ERROR (Status)) {\r
5f25ead9
ED		 1343 RetVal = KEYWORD_HANDLER_KEYWORD_NOT_FOUND;\r
1344 continue;\r
87bfeb11
ED		 1345 } else {\r
1346 if (*NameSpace == NULL) {\r
1347 *NameSpace = AllocateCopyPool (AsciiStrSize (StringPackage->StringPkgHdr->Language), StringPackage->StringPkgHdr->Language);\r
1348 if (*NameSpace == NULL) {\r
1349 return KEYWORD_HANDLER_UNDEFINED_PROCESSING_ERROR;\r
1350 }\r
1351 }\r
1352 return KEYWORD_HANDLER_NO_ERROR;\r
1353 }\r
1354 }\r
1355 }\r
1356\r
5f25ead9 1357 return RetVal;\r
87bfeb11
ED		 1358}\r
1359\r
1360/**\r
1361 Tell whether this Operand is an Statement OpCode.\r
1362\r
1363 @param Operand Operand of an IFR OpCode.\r
1364\r
1365 @retval TRUE This is an Statement OpCode.\r
1366 @retval FALSE Not an Statement OpCode.\r
1367\r
1368**/\r
1369BOOLEAN\r
1370IsStatementOpCode (\r
1371 IN UINT8 Operand\r
1372 )\r
1373{\r
1374 if ((Operand == EFI_IFR_SUBTITLE_OP) ||\r
1375 (Operand == EFI_IFR_TEXT_OP) ||\r
1376 (Operand == EFI_IFR_RESET_BUTTON_OP) ||\r
1377 (Operand == EFI_IFR_REF_OP) ||\r
1378 (Operand == EFI_IFR_ACTION_OP) ||\r
1379 (Operand == EFI_IFR_NUMERIC_OP) ||\r
1380 (Operand == EFI_IFR_ORDERED_LIST_OP) ||\r
1381 (Operand == EFI_IFR_CHECKBOX_OP) ||\r
1382 (Operand == EFI_IFR_STRING_OP) ||\r
1383 (Operand == EFI_IFR_PASSWORD_OP) ||\r
1384 (Operand == EFI_IFR_DATE_OP) ||\r
1385 (Operand == EFI_IFR_TIME_OP) ||\r
1386 (Operand == EFI_IFR_GUID_OP) ||\r
1387 (Operand == EFI_IFR_ONE_OF_OP)) {\r
1388 return TRUE;\r
1389 }\r
1390\r
1391 return FALSE;\r
1392}\r
1393\r
1394/**\r
1395 Tell whether this Operand is an Statement OpCode.\r
1396\r
1397 @param Operand Operand of an IFR OpCode.\r
1398\r
1399 @retval TRUE This is an Statement OpCode.\r
1400 @retval FALSE Not an Statement OpCode.\r
1401\r
1402**/\r
1403BOOLEAN\r
1404IsStorageOpCode (\r
1405 IN UINT8 Operand\r
1406 )\r
1407{\r
1408 if ((Operand == EFI_IFR_VARSTORE_OP) ||\r
1409 (Operand == EFI_IFR_VARSTORE_NAME_VALUE_OP) ||\r
1410 (Operand == EFI_IFR_VARSTORE_EFI_OP)) {\r
1411 return TRUE;\r
1412 }\r
1413\r
1414 return FALSE;\r
1415}\r
1416\r
1417/**\r
1418 Base on the prompt string id to find the question.\r
1419\r
1420 @param FormPackage The input form package.\r
1421 @param KeywordStrId The input prompt string id for one question.\r
1422\r
1423 @retval the opcode for the question.\r
1424\r
1425**/\r
1426UINT8 * \r
1427FindQuestionFromStringId (\r
1428 IN HII_IFR_PACKAGE_INSTANCE *FormPackage,\r
1429 IN EFI_STRING_ID KeywordStrId \r
1430 )\r
1431{\r
1432 UINT8 *OpCodeData;\r
1433 UINT32 Offset;\r
1434 EFI_IFR_STATEMENT_HEADER *StatementHeader;\r
1435 EFI_IFR_OP_HEADER *OpCodeHeader;\r
1436 UINT32 FormDataLen;\r
1437\r
1438 ASSERT (FormPackage != NULL);\r
1439\r
1440 FormDataLen = FormPackage->FormPkgHdr.Length - sizeof (EFI_HII_PACKAGE_HEADER);\r
1441 Offset = 0;\r
1442 while (Offset < FormDataLen) {\r
1443 OpCodeData = FormPackage->IfrData + Offset;\r
1444 OpCodeHeader = (EFI_IFR_OP_HEADER *) OpCodeData;\r
1445\r
1446 if (IsStatementOpCode(OpCodeHeader->OpCode)) {\r
1447 StatementHeader = (EFI_IFR_STATEMENT_HEADER *) (OpCodeData + sizeof (EFI_IFR_OP_HEADER));\r
1448 if (StatementHeader->Prompt == KeywordStrId) {\r
1449 return OpCodeData;\r
1450 }\r
1451 }\r
1452\r
1453 Offset += OpCodeHeader->Length;\r
1454 }\r
1455\r
1456 return NULL;\r
1457}\r
1458\r
1459/**\r
1460 Base on the varstore id to find the storage info.\r
1461\r
1462 @param FormPackage The input form package.\r
1463 @param VarStoreId The input storage id.\r
1464\r
1465 @retval the opcode for the storage.\r
1466\r
1467**/\r
1468UINT8 *\r
1469FindStorageFromVarId (\r
1470 IN HII_IFR_PACKAGE_INSTANCE *FormPackage,\r
1471 IN EFI_VARSTORE_ID VarStoreId\r
1472 )\r
1473{\r
1474 UINT8 *OpCodeData;\r
1475 UINT32 Offset;\r
1476 EFI_IFR_OP_HEADER *OpCodeHeader;\r
1477 UINT32 FormDataLen;\r
1478\r
1479 ASSERT (FormPackage != NULL);\r
1480\r
1481 FormDataLen = FormPackage->FormPkgHdr.Length - sizeof (EFI_HII_PACKAGE_HEADER);\r
1482 Offset = 0;\r
1483 while (Offset < FormDataLen) {\r
1484 OpCodeData = FormPackage->IfrData + Offset;\r
1485 OpCodeHeader = (EFI_IFR_OP_HEADER *) OpCodeData;\r
1486\r
1487 if (IsStorageOpCode(OpCodeHeader->OpCode)) {\r
1488 switch (OpCodeHeader->OpCode) {\r
1489 case EFI_IFR_VARSTORE_OP:\r
1490 if (VarStoreId == ((EFI_IFR_VARSTORE *) OpCodeData)->VarStoreId) {\r
1491 return OpCodeData;\r
1492 }\r
1493 break;\r
1494\r
1495 case EFI_IFR_VARSTORE_NAME_VALUE_OP:\r
1496 if (VarStoreId == ((EFI_IFR_VARSTORE_NAME_VALUE *) OpCodeData)->VarStoreId) {\r
1497 return OpCodeData;\r
1498 }\r
1499 break;\r
1500\r
1501 case EFI_IFR_VARSTORE_EFI_OP:\r
1502 if (VarStoreId == ((EFI_IFR_VARSTORE_EFI *) OpCodeData)->VarStoreId) {\r
1503 return OpCodeData;\r
1504 }\r
1505 break;\r
1506\r
1507 default:\r
1508 break;\r
1509 }\r
1510 }\r
1511\r
1512 Offset += OpCodeHeader->Length;\r
1513 }\r
1514\r
1515 return NULL;\r
1516}\r
1517\r
1518/**\r
1519 Get width info for one question.\r
1520\r
1521 @param OpCodeData The input opcode for one question.\r
1522\r
1523 @retval the width info for one question.\r
1524\r
1525**/\r
1526UINT16 \r
1527GetWidth (\r
1528 IN UINT8 *OpCodeData\r
1529 )\r
1530{\r
1531 UINT8 *NextOpCodeData;\r
1532\r
1533 ASSERT (OpCodeData != NULL);\r
1534\r
1535 switch (((EFI_IFR_OP_HEADER *) OpCodeData)->OpCode) {\r
1536 case EFI_IFR_REF_OP:\r
1537 return (UINT16) sizeof (EFI_HII_REF);\r
1538\r
1539 case EFI_IFR_ONE_OF_OP:\r
1540 case EFI_IFR_NUMERIC_OP:\r
1541 switch (((EFI_IFR_ONE_OF *) OpCodeData)->Flags & EFI_IFR_NUMERIC_SIZE) {\r
1542 case EFI_IFR_NUMERIC_SIZE_1:\r
1543 return (UINT16) sizeof (UINT8);\r
1544 \r
1545 case EFI_IFR_NUMERIC_SIZE_2:\r
1546 return (UINT16) sizeof (UINT16);\r
1547 \r
1548 case EFI_IFR_NUMERIC_SIZE_4:\r
1549 return (UINT16) sizeof (UINT32);\r
1550 \r
1551 case EFI_IFR_NUMERIC_SIZE_8:\r
1552 return (UINT16) sizeof (UINT64);\r
1553 \r
1554 default:\r
1555 ASSERT (FALSE);\r
1556 return 0;\r
1557 }\r
1558\r
1559 case EFI_IFR_ORDERED_LIST_OP:\r
1560 NextOpCodeData = OpCodeData + ((EFI_IFR_ORDERED_LIST *) OpCodeData)->Header.Length;\r
1561 //\r
1562 // OneOfOption must follow the orderedlist opcode.\r
1563 //\r
1564 ASSERT (((EFI_IFR_OP_HEADER *) NextOpCodeData)->OpCode == EFI_IFR_ONE_OF_OPTION_OP);\r
1565 switch (((EFI_IFR_ONE_OF_OPTION *) NextOpCodeData)->Type) {\r
1566 case EFI_IFR_TYPE_NUM_SIZE_8:\r
1567 return (UINT16) sizeof (UINT8) * ((EFI_IFR_ORDERED_LIST *) OpCodeData)->MaxContainers;\r
1568 \r
1569 case EFI_IFR_TYPE_NUM_SIZE_16:\r
1570 return (UINT16) sizeof (UINT16) * ((EFI_IFR_ORDERED_LIST *) OpCodeData)->MaxContainers ;\r
1571 \r
1572 case EFI_IFR_TYPE_NUM_SIZE_32:\r
1573 return (UINT16) sizeof (UINT32) * ((EFI_IFR_ORDERED_LIST *) OpCodeData)->MaxContainers;\r
1574 \r
1575 case EFI_IFR_TYPE_NUM_SIZE_64:\r
1576 return (UINT16) sizeof (UINT64) * ((EFI_IFR_ORDERED_LIST *) OpCodeData)->MaxContainers;\r
87bfeb11
ED		 1577 \r
1578 default:\r
1579 ASSERT (FALSE);\r
1580 return 0;\r
1581 }\r
1582\r
1583 case EFI_IFR_CHECKBOX_OP:\r
1584 return (UINT16) sizeof (BOOLEAN);\r
1585 \r
1586 case EFI_IFR_PASSWORD_OP:\r
1587 case EFI_IFR_STRING_OP:\r
1588 return (UINT16)((UINTN) ((EFI_IFR_STRING *) OpCodeData)->MaxSize * sizeof (CHAR16));\r
1589\r
1590 case EFI_IFR_DATE_OP:\r
1591 return (UINT16) sizeof (EFI_HII_DATE);\r
1592\r
1593 case EFI_IFR_TIME_OP:\r
1594 return (UINT16) sizeof (EFI_HII_TIME);\r
1595\r
1596 default:\r
1597 ASSERT (FALSE);\r
1598 return 0;\r
1599 }\r
1600}\r
1601\r
1602/**\r
1603 Converts all hex dtring characters in range ['A'..'F'] to ['a'..'f'] for \r
1604 hex digits that appear between a '=' and a '&' in a config string.\r
1605\r
1606 If ConfigString is NULL, then ASSERT().\r
1607\r
1608 @param[in] ConfigString Pointer to a Null-terminated Unicode string.\r
1609\r
1610 @return Pointer to the Null-terminated Unicode result string.\r
1611\r
1612**/\r
1613EFI_STRING\r
1614EFIAPI\r
1615InternalLowerConfigString (\r
1616 IN EFI_STRING ConfigString\r
1617 )\r
1618{\r
1619 EFI_STRING String;\r
1620 BOOLEAN Lower;\r
1621\r
1622 ASSERT (ConfigString != NULL);\r
1623\r
1624 //\r
1625 // Convert all hex digits in range [A-F] in the configuration header to [a-f]\r
1626 //\r
1627 for (String = ConfigString, Lower = FALSE; *String != L'\0'; String++) {\r
1628 if (*String == L'=') {\r
1629 Lower = TRUE;\r
1630 } else if (*String == L'&') {\r
1631 Lower = FALSE;\r
1632 } else if (Lower && *String >= L'A' && *String <= L'F') {\r
1633 *String = (CHAR16) (*String - L'A' + L'a');\r
1634 }\r
1635 }\r
1636\r
1637 return ConfigString;\r
1638}\r
1639\r
1640/**\r
1641 Allocates and returns a Null-terminated Unicode <ConfigHdr> string.\r
1642 \r
1643 The format of a <ConfigHdr> is as follows:\r
1644\r
1645 GUID=<HexCh>32&NAME=<Char>NameLength&PATH=<HexChar>DevicePathSize<Null>\r
1646\r
1647 @param[in] OpCodeData The opcode for the storage. \r
1648 @param[in] DriverHandle The driver handle which supports a Device Path Protocol\r
1649 that is the routing information PATH. Each byte of\r
1650 the Device Path associated with DriverHandle is converted\r
1651 to a 2 Unicode character hexidecimal string.\r
1652\r
1653 @retval NULL DriverHandle does not support the Device Path Protocol.\r
1654 @retval Other A pointer to the Null-terminate Unicode <ConfigHdr> string\r
1655\r
1656**/\r
1657EFI_STRING\r
1658ConstructConfigHdr (\r
1659 IN UINT8 *OpCodeData,\r
1660 IN EFI_HANDLE DriverHandle\r
1661 )\r
1662{\r
1663 UINTN NameLength;\r
1664 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
1665 UINTN DevicePathSize;\r
1666 CHAR16 *String;\r
1667 CHAR16 *ReturnString;\r
1668 UINTN Index;\r
1669 UINT8 *Buffer;\r
1670 CHAR16 *Name;\r
1671 CHAR8 *AsciiName;\r
1672 EFI_GUID *Guid;\r
5ad66ec6 1673 UINTN MaxLen;\r
87bfeb11
ED		 1674\r
1675 ASSERT (OpCodeData != NULL);\r
1676\r
1677 switch (((EFI_IFR_OP_HEADER *)OpCodeData)->OpCode) {\r
1678 case EFI_IFR_VARSTORE_OP:\r
1679 Guid = (EFI_GUID *)(UINTN *)&((EFI_IFR_VARSTORE *) OpCodeData)->Guid;\r
c2400145 1680 AsciiName = (CHAR8 *) ((EFI_IFR_VARSTORE *) OpCodeData)->Name;\r
87bfeb11
ED		 1681 break;\r
1682 \r
1683 case EFI_IFR_VARSTORE_NAME_VALUE_OP:\r
1684 Guid = (EFI_GUID *)(UINTN *)&((EFI_IFR_VARSTORE_NAME_VALUE *) OpCodeData)->Guid;\r
1685 AsciiName = NULL;\r
1686 break;\r
1687 \r
1688 case EFI_IFR_VARSTORE_EFI_OP:\r
1689 Guid = (EFI_GUID *)(UINTN *)&((EFI_IFR_VARSTORE_EFI *) OpCodeData)->Guid;\r
c2400145 1690 AsciiName = (CHAR8 *) ((EFI_IFR_VARSTORE_EFI *) OpCodeData)->Name;\r
87bfeb11
ED		 1691 break;\r
1692 \r
1693 default:\r
1694 ASSERT (FALSE);\r
1695 Guid = NULL;\r
1696 AsciiName = NULL;\r
1697 break;\r
1698 }\r
1699\r
1700 if (AsciiName != NULL) {\r
1701 Name = AllocateZeroPool (AsciiStrSize (AsciiName) * 2);\r
1702 ASSERT (Name != NULL);\r
1703 AsciiStrToUnicodeStr(AsciiName, Name);\r
1704 } else {\r
1705 Name = NULL;\r
1706 }\r
1707\r
1708 //\r
1709 // Compute the length of Name in Unicode characters. \r
1710 // If Name is NULL, then the length is 0.\r
1711 //\r
1712 NameLength = 0;\r
1713 if (Name != NULL) {\r
1714 NameLength = StrLen (Name);\r
1715 }\r
1716\r
1717 DevicePath = NULL;\r
1718 DevicePathSize = 0;\r
1719 //\r
1720 // Retrieve DevicePath Protocol associated with DriverHandle\r
1721 //\r
1722 if (DriverHandle != NULL) {\r
1723 DevicePath = DevicePathFromHandle (DriverHandle);\r
1724 if (DevicePath == NULL) {\r
1725 return NULL;\r
1726 }\r
1727 //\r
1728 // Compute the size of the device path in bytes\r
1729 //\r
1730 DevicePathSize = GetDevicePathSize (DevicePath);\r
1731 }\r
1732\r
1733 //\r
1734 // GUID=<HexCh>32&NAME=<Char>NameLength&PATH=<HexChar>DevicePathSize <Null>\r
1735 // | 5 | sizeof (EFI_GUID) * 2 | 6 | NameStrLen*4 | 6 | DevicePathSize * 2 | 1 |\r
1736 //\r
5ad66ec6
DB		 1737 MaxLen = 5 + sizeof (EFI_GUID) * 2 + 6 + NameLength * 4 + 6 + DevicePathSize * 2 + 1;\r
1738 String = AllocateZeroPool (MaxLen * sizeof (CHAR16));\r
87bfeb11
ED		 1739 if (String == NULL) {\r
1740 return NULL;\r
1741 }\r
1742\r
1743 //\r
1744 // Start with L"GUID="\r
1745 //\r
5ad66ec6
DB		 1746 StrCpyS (String, MaxLen, L"GUID=");\r
1747 ReturnString = String;\r
87bfeb11
ED		 1748 String += StrLen (String);\r
1749\r
1750 if (Guid != NULL) {\r
1751 //\r
1752 // Append Guid converted to <HexCh>32\r
1753 //\r
1754 for (Index = 0, Buffer = (UINT8 *)Guid; Index < sizeof (EFI_GUID); Index++) {\r
1755 String += UnicodeValueToString (String, PREFIX_ZERO | RADIX_HEX, *(Buffer++), 2);\r
1756 }\r
1757 }\r
1758 \r
1759 //\r
1760 // Append L"&NAME="\r
1761 //\r
5ad66ec6 1762 StrCpyS (String, MaxLen, L"&NAME=");\r
87bfeb11
ED		 1763 String += StrLen (String);\r
1764\r
1765 if (Name != NULL) {\r
1766 //\r
1767 // Append Name converted to <Char>NameLength\r
1768 //\r
1769 for (; *Name != L'\0'; Name++) {\r
1770 String += UnicodeValueToString (String, PREFIX_ZERO | RADIX_HEX, *Name, 4);\r
1771 }\r
1772 }\r
1773\r
1774 //\r
1775 // Append L"&PATH="\r
1776 //\r
5ad66ec6 1777 StrCpyS (String, MaxLen, L"&PATH=");\r
87bfeb11
ED		 1778 String += StrLen (String);\r
1779\r
1780 //\r
1781 // Append the device path associated with DriverHandle converted to <HexChar>DevicePathSize\r
1782 //\r
1783 for (Index = 0, Buffer = (UINT8 *)DevicePath; Index < DevicePathSize; Index++) {\r
1784 String += UnicodeValueToString (String, PREFIX_ZERO | RADIX_HEX, *(Buffer++), 2);\r
1785 }\r
1786\r
1787 //\r
1788 // Null terminate the Unicode string\r
1789 //\r
1790 *String = L'\0';\r
1791\r
1792 //\r
1793 // Convert all hex digits in range [A-F] in the configuration header to [a-f]\r
1794 //\r
1795 return InternalLowerConfigString (ReturnString);\r
1796}\r
1797\r
1798/**\r
1799 Generate the Config request element for one question.\r
1800\r
1801 @param Name The name info for one question.\r
1802 @param Offset The offset info for one question.\r
1803 @param Width The width info for one question.\r
1804\r
1805 @return Pointer to the Null-terminated Unicode request element string.\r
1806\r
1807**/\r
1808EFI_STRING\r
1809ConstructRequestElement (\r
1810 IN CHAR16 *Name,\r
1811 IN UINT16 Offset,\r
1812 IN UINT16 Width \r
1813 )\r
1814{\r
1815 CHAR16 *StringPtr;\r
1816 UINTN Length;\r
1817 \r
1818 if (Name != NULL) {\r
1819 //\r
1820 // Add <BlockName> length for each Name\r
1821 //\r
1822 // <BlockName> ::= Name + \0\r
1823 // StrLen(Name) | 1\r
1824 //\r
1825 Length = StrLen (Name) + 1;\r
1826 } else {\r
1827 //\r
1828 // Add <BlockName> length for each Offset/Width pair\r
1829 //\r
1830 // <BlockName> ::= OFFSET=1234&WIDTH=1234 + \0\r
1831 // | 7 | 4 | 7 | 4 | 1\r
1832 //\r
1833 Length = (7 + 4 + 7 + 4 + 1);\r
1834 }\r
1835\r
1836 //\r
1837 // Allocate buffer for the entire <ConfigRequest>\r
1838 //\r
1839 StringPtr = AllocateZeroPool (Length * sizeof (CHAR16));\r
1840 ASSERT (StringPtr != NULL);\r
1841\r
1842 if (Name != NULL) {\r
1843 //\r
1844 // Append Name\0\r
1845 //\r
1846 UnicodeSPrint (\r
1847 StringPtr,\r
1848 (StrLen (Name) + 1) * sizeof (CHAR16),\r
1849 L"%s",\r
1850 Name\r
1851 );\r
1852 } else {\r
1853 //\r
1854 // Append OFFSET=XXXX&WIDTH=YYYY\0\r
1855 //\r
1856 UnicodeSPrint (\r
1857 StringPtr, \r
1858 (7 + 4 + 7 + 4 + 1) * sizeof (CHAR16), \r
1859 L"OFFSET=%04X&WIDTH=%04X", \r
1860 Offset, \r
1861 Width\r
1862 );\r
1863 }\r
1864\r
1865 return StringPtr;\r
1866}\r
1867\r
1868/**\r
1869 Get string value for question's name field.\r
1870\r
1871 @param DatabaseRecord HII_DATABASE_RECORD format string.\r
1872 @param NameId The string id for the name field.\r
1873\r
1874 @retval Name string.\r
1875\r
1876**/\r
1877CHAR16 *\r
1878GetNameFromId (\r
1879 IN HII_DATABASE_RECORD *DatabaseRecord,\r
1880 IN EFI_STRING_ID NameId\r
1881 )\r
1882{\r
1883 CHAR16 *Name;\r
1884 CHAR8 *PlatformLanguage;\r
1885 CHAR8 *SupportedLanguages;\r
1886 CHAR8 *BestLanguage;\r
1887 UINTN StringSize;\r
1888 CHAR16 TempString;\r
1889 EFI_STATUS Status;\r
1890\r
1891 Name = NULL;\r
1892 BestLanguage = NULL;\r
1893 PlatformLanguage = NULL; \r
1894 SupportedLanguages = NULL;\r
1895\r
1896 GetEfiGlobalVariable2 (L"PlatformLang", (VOID**)&PlatformLanguage, NULL);\r
1897 SupportedLanguages = GetSupportedLanguages(DatabaseRecord->Handle);\r
1898\r
1899 //\r
1900 // Get the best matching language from SupportedLanguages\r
1901 //\r
1902 BestLanguage = GetBestLanguage (\r
1903 SupportedLanguages, \r
1904 FALSE, // RFC 4646 mode\r
1905 PlatformLanguage != NULL ? PlatformLanguage : "", // Highest priority\r
1906 SupportedLanguages, // Lowest priority \r
1907 NULL\r
1908 );\r
1909 if (BestLanguage == NULL) {\r
1910 BestLanguage = AllocateCopyPool (AsciiStrLen ("en-US"), "en-US");\r
1911 ASSERT (BestLanguage != NULL);\r
1912 }\r
1913\r
1914 StringSize = 0;\r
1915 Status = mPrivate.HiiString.GetString (\r
1916 &mPrivate.HiiString,\r
1917 BestLanguage,\r
1918 DatabaseRecord->Handle,\r
1919 NameId,\r
1920 &TempString,\r
1921 &StringSize,\r
1922 NULL\r
1923 );\r
1924 if (Status != EFI_BUFFER_TOO_SMALL) {\r
1925 goto Done;\r
1926 }\r
1927\r
1928 Name = AllocateZeroPool (StringSize);\r
1929 if (Name == NULL) {\r
1930 goto Done;\r
1931 }\r
1932\r
1933 Status = mPrivate.HiiString.GetString (\r
1934 &mPrivate.HiiString,\r
1935 BestLanguage,\r
1936 DatabaseRecord->Handle,\r
1937 NameId,\r
1938 Name,\r
1939 &StringSize,\r
1940 NULL\r
1941 );\r
1942\r
1943 if (EFI_ERROR (Status)) {\r
1944 FreePool (Name);\r
1945 Name = NULL;\r
1946 goto Done;\r
1947 }\r
1948\r
1949Done:\r
1950 if (SupportedLanguages != NULL) {\r
1951 FreePool(SupportedLanguages);\r
1952 }\r
1953 if (BestLanguage != NULL) {\r
1954 FreePool (BestLanguage);\r
1955 }\r
1956 if (PlatformLanguage != NULL) {\r
1957 FreePool (PlatformLanguage);\r
1958 }\r
1959\r
1960 return Name;\r
1961}\r
1962\r
1963/**\r
1964 Base on the input parameter to generate the ConfigRequest string.\r
1965\r
1966 This is a internal function.\r
1967\r
1968 @param DatabaseRecord HII_DATABASE_RECORD format string.\r
1969 @param KeywordStrId Keyword string id.\r
1970 @param OpCodeData The IFR data for this question.\r
1971 @param ConfigRequest Return the generate ConfigRequest string.\r
1972\r
1973 @retval EFI_SUCCESS Generate ConfigResp string success.\r
1974 @retval EFI_OUT_OF_RESOURCES System out of memory resource error.\r
1975 @retval EFI_NOT_FOUND Not found the question which use this string id\r
1976 as the prompt string id.\r
1977**/\r
1978EFI_STATUS\r
1979ExtractConfigRequest (\r
1980 IN HII_DATABASE_RECORD *DatabaseRecord,\r
1981 IN EFI_STRING_ID KeywordStrId,\r
1982 OUT UINT8 **OpCodeData,\r
1983 OUT EFI_STRING *ConfigRequest\r
1984 ) \r
1985{\r
1986 LIST_ENTRY *Link;\r
1987 HII_DATABASE_PACKAGE_LIST_INSTANCE *PackageListNode;\r
1988 HII_IFR_PACKAGE_INSTANCE *FormPackage;\r
1989 EFI_IFR_QUESTION_HEADER *Header;\r
1990 UINT8 *Storage;\r
1991 UINT8 *OpCode;\r
1992 CHAR16 *Name;\r
1993 UINT16 Offset;\r
1994 UINT16 Width;\r
1995 CHAR16 *ConfigHdr;\r
1996 CHAR16 *RequestElement;\r
5ad66ec6 1997 UINTN MaxLen;\r
87bfeb11
ED		 1998 CHAR16 *StringPtr;\r
1999\r
2000 ASSERT (DatabaseRecord != NULL && OpCodeData != NULL && ConfigRequest != NULL);\r
2001\r
2002 OpCode = NULL;\r
2003 Name = NULL;\r
2004 Width = 0;\r
2005 Offset = 0;\r
2006\r
2007 PackageListNode = DatabaseRecord->PackageList;\r
2008\r
2009 //\r
2010 // Search the languages in the specified packagelist.\r
2011 //\r
2012 for (Link = PackageListNode->FormPkgHdr.ForwardLink; Link != &PackageListNode->FormPkgHdr; Link = Link->ForwardLink) {\r
2013 FormPackage = CR (Link, HII_IFR_PACKAGE_INSTANCE, IfrEntry, HII_IFR_PACKAGE_SIGNATURE);\r
2014\r
2015 OpCode = FindQuestionFromStringId (FormPackage, KeywordStrId);\r
2016 if (OpCode != NULL) {\r
2017 *OpCodeData = OpCode;\r
2018 Header = (EFI_IFR_QUESTION_HEADER *) (OpCode + sizeof (EFI_IFR_OP_HEADER));\r
2019 //\r
2020 // Header->VarStoreId == 0 means no storage for this question.\r
2021 //\r
2022 ASSERT (Header->VarStoreId != 0);\r
2023 DEBUG ((EFI_D_INFO, "Varstore Id: 0x%x\n", Header->VarStoreId));\r
2024 \r
2025 Storage = FindStorageFromVarId (FormPackage, Header->VarStoreId);\r
2026 ASSERT (Storage != NULL);\r
2027\r
2028 if (((EFI_IFR_OP_HEADER *) Storage)->OpCode == EFI_IFR_VARSTORE_NAME_VALUE_OP) {\r
2029 Name = GetNameFromId (DatabaseRecord, Header->VarStoreInfo.VarName);\r
2030 } else {\r
2031 Offset = Header->VarStoreInfo.VarOffset;\r
2032 Width = GetWidth (OpCode);\r
2033 }\r
2034 RequestElement = ConstructRequestElement(Name, Offset, Width);\r
2035 ConfigHdr = ConstructConfigHdr(Storage, DatabaseRecord->DriverHandle);\r
cbbc454b 2036 ASSERT (ConfigHdr != NULL);\r
87bfeb11 2037\r
5ad66ec6
DB		 2038 MaxLen = StrLen (ConfigHdr) + 1 + StrLen(RequestElement) + 1;\r
2039 *ConfigRequest = AllocatePool (MaxLen * sizeof (CHAR16));\r
87bfeb11
ED		 2040 if (*ConfigRequest == NULL) {\r
2041 FreePool (ConfigHdr);\r
2042 FreePool (RequestElement);\r
2043 return EFI_OUT_OF_RESOURCES;\r
2044 }\r
2045 StringPtr = *ConfigRequest;\r
2046\r
5ad66ec6 2047 StrCpyS (StringPtr, MaxLen, ConfigHdr);\r
87bfeb11
ED		 2048 StringPtr += StrLen (StringPtr);\r
2049\r
2050 *StringPtr = L'&';\r
2051 StringPtr++;\r
2052\r
5ad66ec6 2053 StrCpyS (StringPtr, MaxLen, RequestElement);\r
87bfeb11
ED		 2054 StringPtr += StrLen (StringPtr);\r
2055 *StringPtr = L'\0';\r
2056\r
2057 FreePool (ConfigHdr);\r
2058 FreePool (RequestElement);\r
2059\r
2060 return EFI_SUCCESS;\r
2061 }\r
2062 }\r
2063\r
2064 return EFI_NOT_FOUND;\r
2065}\r
2066\r
2067/**\r
2068 Base on the input parameter to generate the ConfigResp string.\r
2069\r
2070 This is a internal function.\r
2071\r
2072 @param DatabaseRecord HII_DATABASE_RECORD format string.\r
2073 @param KeywordStrId Keyword string id.\r
2074 @param ValueElement The value for the question which use keyword string id\r
2075 as the prompt string id.\r
2076 @param OpCodeData The IFR data for this question.\r
2077 @param ConfigResp Return the generate ConfigResp string.\r
2078\r
2079 @retval EFI_SUCCESS Generate ConfigResp string success.\r
2080 @retval EFI_OUT_OF_RESOURCES System out of memory resource error.\r
2081 @retval EFI_NOT_FOUND Not found the question which use this string id\r
2082 as the prompt string id.\r
2083**/\r
2084EFI_STATUS\r
2085ExtractConfigResp (\r
2086 IN HII_DATABASE_RECORD *DatabaseRecord,\r
2087 IN EFI_STRING_ID KeywordStrId,\r
2088 IN EFI_STRING ValueElement,\r
2089 OUT UINT8 **OpCodeData,\r
2090 OUT EFI_STRING *ConfigResp\r
2091 ) \r
2092{\r
2093 LIST_ENTRY *Link;\r
2094 HII_DATABASE_PACKAGE_LIST_INSTANCE *PackageListNode;\r
2095 HII_IFR_PACKAGE_INSTANCE *FormPackage;\r
2096 EFI_IFR_QUESTION_HEADER *Header;\r
2097 UINT8 *Storage;\r
2098 UINT8 *OpCode;\r
2099 CHAR16 *Name;\r
2100 UINT16 Offset;\r
2101 UINT16 Width;\r
2102 CHAR16 *ConfigHdr;\r
2103 CHAR16 *RequestElement;\r
5ad66ec6 2104 UINTN MaxLen;\r
87bfeb11
ED		 2105 CHAR16 *StringPtr;\r
2106\r
2107 ASSERT ((DatabaseRecord != NULL) && (OpCodeData != NULL) && (ConfigResp != NULL) && (ValueElement != NULL));\r
2108\r
2109 OpCode = NULL;\r
2110 Name = NULL;\r
2111 Width = 0;\r
2112 Offset = 0;\r
2113\r
2114 PackageListNode = DatabaseRecord->PackageList;\r
2115\r
2116 //\r
2117 // Search the languages in the specified packagelist.\r
2118 //\r
2119 for (Link = PackageListNode->FormPkgHdr.ForwardLink; Link != &PackageListNode->FormPkgHdr; Link = Link->ForwardLink) {\r
2120 FormPackage = CR (Link, HII_IFR_PACKAGE_INSTANCE, IfrEntry, HII_IFR_PACKAGE_SIGNATURE);\r
2121\r
2122 OpCode = FindQuestionFromStringId (FormPackage, KeywordStrId);\r
2123 if (OpCode != NULL) {\r
2124 *OpCodeData = OpCode;\r
2125 Header = (EFI_IFR_QUESTION_HEADER *) (OpCode + sizeof (EFI_IFR_OP_HEADER));\r
2126 //\r
2127 // Header->VarStoreId == 0 means no storage for this question.\r
2128 //\r
2129 ASSERT (Header->VarStoreId != 0);\r
2130 DEBUG ((EFI_D_INFO, "Varstore Id: 0x%x\n", Header->VarStoreId));\r
2131 \r
2132 Storage = FindStorageFromVarId (FormPackage, Header->VarStoreId);\r
2133 ASSERT (Storage != NULL);\r
2134\r
2135 if (((EFI_IFR_OP_HEADER *) Storage)->OpCode == EFI_IFR_VARSTORE_NAME_VALUE_OP) {\r
2136 Name = GetNameFromId (DatabaseRecord, Header->VarStoreInfo.VarName);\r
2137 } else {\r
2138 Offset = Header->VarStoreInfo.VarOffset;\r
2139 Width = GetWidth (OpCode);\r
2140 }\r
2141 RequestElement = ConstructRequestElement(Name, Offset, Width);\r
2142\r
2143 ConfigHdr = ConstructConfigHdr(Storage, DatabaseRecord->DriverHandle);\r
cbbc454b 2144 ASSERT (ConfigHdr != NULL);\r
87bfeb11 2145\r
5ad66ec6
DB		 2146 MaxLen = StrLen (ConfigHdr) + 1 + StrLen(RequestElement) + 1 + StrLen (L"VALUE=") + StrLen(ValueElement) + 1;\r
2147 *ConfigResp = AllocatePool (MaxLen * sizeof (CHAR16));\r
87bfeb11
ED		 2148 if (*ConfigResp == NULL) {\r
2149 FreePool (ConfigHdr);\r
2150 FreePool (RequestElement);\r
2151 return EFI_OUT_OF_RESOURCES;\r
2152 }\r
2153 StringPtr = *ConfigResp;\r
2154\r
5ad66ec6 2155 StrCpyS (StringPtr, MaxLen, ConfigHdr);\r
87bfeb11
ED		 2156 StringPtr += StrLen (StringPtr);\r
2157\r
2158 *StringPtr = L'&';\r
2159 StringPtr++;\r
2160\r
5ad66ec6 2161 StrCpyS (StringPtr, MaxLen, RequestElement);\r
87bfeb11
ED		 2162 StringPtr += StrLen (StringPtr);\r
2163 \r
2164 *StringPtr = L'&';\r
2165 StringPtr++;\r
2166\r
5ad66ec6 2167 StrCpyS (StringPtr, MaxLen, L"VALUE=");\r
87bfeb11
ED		 2168 StringPtr += StrLen (StringPtr);\r
2169\r
5ad66ec6 2170 StrCpyS (StringPtr, MaxLen, ValueElement);\r
87bfeb11
ED		 2171 StringPtr += StrLen (StringPtr);\r
2172 *StringPtr = L'\0';\r
2173\r
2174 FreePool (ConfigHdr);\r
2175 FreePool (RequestElement);\r
2176\r
2177 return EFI_SUCCESS;\r
2178 }\r
2179 }\r
2180\r
2181 return EFI_NOT_FOUND;\r
2182}\r
2183\r
2184/**\r
2185 Get the Value section from the Hii driver.\r
2186\r
2187 This is a internal function.\r
2188\r
2189 @param ConfigRequest The input ConfigRequest string.\r
2190 @param ValueElement The respond Value section from the hii driver.\r
2191\r
2192 @retval Misc value The error status return from ExtractConfig function.\r
2193 @retval EFI_OUT_OF_RESOURCES The memory can't be allocated\r
2194 @retval EFI_SUCCESS Get the value section success.\r
2195\r
2196**/\r
2197EFI_STATUS\r
2198ExtractValueFromDriver (\r
2199 IN CHAR16 *ConfigRequest,\r
2200 OUT CHAR16 **ValueElement\r
2201 )\r
2202{\r
2203 EFI_STATUS Status;\r
2204 EFI_STRING Result;\r
2205 EFI_STRING Progress;\r
2206 CHAR16 *StringPtr;\r
2207 CHAR16 *StringEnd;\r
2208\r
2209 ASSERT ((ConfigRequest != NULL) && (ValueElement != NULL));\r
2210\r
2211 Status = mPrivate.ConfigRouting.ExtractConfig (\r
2212 &mPrivate.ConfigRouting,\r
2213 (EFI_STRING) ConfigRequest,\r
2214 &Progress,\r
2215 &Result\r
2216 );\r
2217 if (EFI_ERROR (Status)) {\r
2218 return Status;\r
2219 }\r
2220\r
2221 //\r
2222 // Find Value Section and return it.\r
2223 //\r
2224 StringPtr = StrStr (Result, L"&VALUE=");\r
2225 ASSERT (StringPtr != NULL);\r
2226 StringEnd = StrStr (StringPtr + 1, L"&");\r
2227 if (StringEnd != NULL) {\r
2228 *StringEnd = L'\0';\r
2229 }\r
2230\r
2231 *ValueElement = AllocateCopyPool (StrSize (StringPtr), StringPtr);\r
2232 if (*ValueElement == NULL) {\r
2233 return EFI_OUT_OF_RESOURCES;\r
2234 }\r
2235\r
2236 if (StringEnd != NULL) {\r
2237 *StringEnd = L'&';\r
2238 }\r
2239 FreePool (Result);\r
2240\r
2241 return EFI_SUCCESS;\r
2242}\r
2243\r
2244/**\r
2245 Get EFI_STRING_ID info from the input device path, namespace and keyword.\r
2246\r
2247 This is a internal function.\r
2248\r
2249 @param DevicePath Input device path info.\r
2250 @param NameSpace NameSpace format string.\r
2251 @param KeywordData Keyword used to get string id.\r
2252 @param ProgressErr Return extra error type.\r
2253 @param KeywordStringId Return EFI_STRING_ID.\r
2254 @param DataBaseRecord DataBase record data for this driver.\r
2255\r
2256 @retval EFI_INVALID_PARAMETER Can't find the database record base on the input device path or namespace.\r
2257 @retval EFI_NOT_FOUND Can't find the EFI_STRING_ID for the keyword.\r
2258 @retval EFI_SUCCESS Find the EFI_STRING_ID.\r
2259\r
2260**/\r
2261EFI_STATUS\r
2262GetStringIdFromDatabase (\r
2263 IN EFI_DEVICE_PATH_PROTOCOL **DevicePath,\r
2264 IN CHAR8 **NameSpace,\r
2265 IN CHAR16 *KeywordData,\r
2266 OUT UINT32 *ProgressErr,\r
2267 OUT EFI_STRING_ID *KeywordStringId,\r
2268 OUT HII_DATABASE_RECORD **DataBaseRecord\r
2269 )\r
2270{\r
2271 HII_DATABASE_RECORD *Record;\r
2272 LIST_ENTRY *Link;\r
2273 BOOLEAN FindNameSpace;\r
2274 EFI_DEVICE_PATH_PROTOCOL *DestDevicePath;\r
2275 UINT8 *DevicePathPkg;\r
2276 UINTN DevicePathSize;\r
2277\r
2278 ASSERT ((NameSpace != NULL) && (KeywordData != NULL) && (ProgressErr != NULL) && (KeywordStringId != NULL) && (DataBaseRecord != NULL));\r
2279\r
2280 FindNameSpace = FALSE;\r
2281\r
2282 if (*DevicePath != NULL) {\r
2283 //\r
2284 // Get DataBaseRecord from device path protocol.\r
2285 //\r
2286 Record = GetRecordFromDevicePath(*DevicePath);\r
2287 if (Record == NULL) {\r
2288 //\r
2289 // Can't find the DatabaseRecord base on the input device path info.\r
2290 // NEED TO CONFIRM the return ProgressErr.\r
2291 //\r
2292 *ProgressErr = KEYWORD_HANDLER_MALFORMED_STRING;\r
2293 return EFI_INVALID_PARAMETER;\r
2294 }\r
2295\r
2296 //\r
2297 // Get string id from the record.\r
2298 //\r
2299 *ProgressErr = GetStringIdFromRecord (Record, NameSpace, KeywordData, KeywordStringId);\r
2300 switch (*ProgressErr) {\r
2301 case KEYWORD_HANDLER_NO_ERROR:\r
2302 *DataBaseRecord = Record;\r
2303 return EFI_SUCCESS;\r
2304\r
2305 case KEYWORD_HANDLER_NAMESPACE_ID_NOT_FOUND:\r
2306 return EFI_INVALID_PARAMETER;\r
2307\r
2308 default:\r
2309 ASSERT (*ProgressErr == KEYWORD_HANDLER_KEYWORD_NOT_FOUND);\r
2310 return EFI_NOT_FOUND;\r
2311 }\r
2312 } else {\r
2313 //\r
2314 // Find driver which matches the routing data.\r
2315 //\r
2316 for (Link = mPrivate.DatabaseList.ForwardLink; Link != &mPrivate.DatabaseList; Link = Link->ForwardLink) {\r
2317 Record = CR (Link, HII_DATABASE_RECORD, DatabaseEntry, HII_DATABASE_RECORD_SIGNATURE);\r
2318\r
2319 *ProgressErr = GetStringIdFromRecord (Record, NameSpace, KeywordData, KeywordStringId);\r
2320 if (*ProgressErr == KEYWORD_HANDLER_NO_ERROR) {\r
2321 *DataBaseRecord = Record;\r
2322 \r
2323 if ((DevicePathPkg = Record->PackageList->DevicePathPkg) != NULL) {\r
2324 DestDevicePath = (EFI_DEVICE_PATH_PROTOCOL *) (DevicePathPkg + sizeof (EFI_HII_PACKAGE_HEADER));\r
2325 DevicePathSize = GetDevicePathSize ((EFI_DEVICE_PATH_PROTOCOL *) DestDevicePath);\r
2326 *DevicePath = AllocateCopyPool (DevicePathSize, DestDevicePath);\r
2327 if (*DevicePath == NULL) {\r
2328 return EFI_OUT_OF_RESOURCES;\r
2329 }\r
2330 } else {\r
2331 //\r
2332 // Need to verify this ASSERT.\r
2333 //\r
2334 ASSERT (FALSE);\r
2335 }\r
2336\r
2337 return EFI_SUCCESS;\r
2338 } else if (*ProgressErr == KEYWORD_HANDLER_UNDEFINED_PROCESSING_ERROR) {\r
2339 return EFI_OUT_OF_RESOURCES;\r
2340 } else if (*ProgressErr == KEYWORD_HANDLER_KEYWORD_NOT_FOUND) {\r
2341 FindNameSpace = TRUE;\r
2342 } \r
2343 }\r
2344\r
2345 //\r
2346 // When PathHdr not input, if ever find the namespace, will return KEYWORD_HANDLER_KEYWORD_NOT_FOUND.\r
2347 // This is a bit more progress than KEYWORD_HANDLER_NAMESPACE_ID_NOT_FOUND.\r
2348 //\r
2349 if (FindNameSpace) {\r
2350 return EFI_NOT_FOUND;\r
2351 } else {\r
2352 return EFI_INVALID_PARAMETER;\r
2353 }\r
2354 }\r
2355}\r
2356\r
2357/**\r
2358 Genereate the KeywordResp String.\r
2359\r
2360 <KeywordResp> ::= <NameSpaceId><PathHdr>'&'<Keyword>'&VALUE='<Number>['&READONLY']\r
2361\r
2362 @param NameSpace NameSpace format string.\r
2363 @param DevicePath Input device path info.\r
2364 @param KeywordData Keyword used to get string id.\r
2365 @param ValueStr The value section for the keyword.\r
2366 @param ReadOnly Whether this value is readonly.\r
2367 @param KeywordResp Return the point to the KeywordResp string.\r
2368\r
2369 @retval EFI_OUT_OF_RESOURCES The memory can't be allocated.\r
2370 @retval EFI_SUCCESS Generate the KeywordResp string.\r
2371\r
2372**/\r
2373EFI_STATUS\r
2374GenerateKeywordResp (\r
2375 IN CHAR8 *NameSpace, \r
2376 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r
2377 IN EFI_STRING KeywordData,\r
2378 IN EFI_STRING ValueStr,\r
2379 IN BOOLEAN ReadOnly,\r
2380 OUT EFI_STRING *KeywordResp\r
2381 )\r
2382{\r
2383 UINTN RespStrLen;\r
2384 CHAR16 *RespStr;\r
2385 CHAR16 *PathHdr;\r
2386 CHAR16 *UnicodeNameSpace;\r
2387\r
2388 ASSERT ((NameSpace != NULL) && (DevicePath != NULL) && (KeywordData != NULL) && (ValueStr != NULL) && (KeywordResp != NULL));\r
2389\r
2390 //\r
2391 // 1. Calculate the string length.\r
2392 //\r
2393 //\r
2394 // 1.1 NameSpaceId size.\r
2395 // 'NAMESPACE='<String>\r
2396 //\r
2397 RespStrLen = 10 + AsciiStrLen (NameSpace);\r
2398 UnicodeNameSpace = AllocatePool ((AsciiStrLen (NameSpace) + 1) * sizeof (CHAR16));\r
2399 if (UnicodeNameSpace == NULL) {\r
2400 return EFI_OUT_OF_RESOURCES;\r
2401 }\r
2402 AsciiStrToUnicodeStr(NameSpace, UnicodeNameSpace);\r
2403\r
2404 //\r
2405 // 1.2 PathHdr size.\r
2406 // PATH=<UEFI binary Device Path represented as hex number>'&'\r
2407 // Attention: The output include the '&' at the end.\r
2408 //\r
2409 GenerateSubStr (\r
2410 L"&PATH=",\r
2411 GetDevicePathSize ((EFI_DEVICE_PATH_PROTOCOL *) DevicePath),\r
2412 (VOID *) DevicePath,\r
2413 1,\r
2414 &PathHdr\r
2415 );\r
2416 RespStrLen += StrLen (PathHdr);\r
2417\r
2418 //\r
2419 // 1.3 Keyword setion.\r
2420 // 'KEYWORD='<String>[':'<DecCh>(1/4)]\r
2421 //\r
2422 RespStrLen += 8 + StrLen (KeywordData);\r
2423\r
2424 //\r
2425 // 1.4 Value section.\r
2426 // ValueStr = '&VALUE='<Number>\r
2427 //\r
2428 RespStrLen += StrLen (ValueStr);\r
2429\r
2430 //\r
2431 // 1.5 ReadOnly Section.\r
2432 // '&READONLY'\r
2433 //\r
2434 if (ReadOnly) {\r
2435 RespStrLen += 9;\r
2436 }\r
2437\r
2438 //\r
5ad66ec6 2439 // 2. Allocate the buffer and create the KeywordResp string include '\0'.\r
87bfeb11 2440 //\r
5ad66ec6
DB		 2441 RespStrLen += 1;\r
2442 *KeywordResp = AllocatePool (RespStrLen * sizeof (CHAR16));\r
87bfeb11
ED		 2443 if (*KeywordResp == NULL) {\r
2444 if (UnicodeNameSpace != NULL) {\r
2445 FreePool (UnicodeNameSpace);\r
2446 }\r
2447\r
2448 return EFI_OUT_OF_RESOURCES;\r
2449 }\r
2450 RespStr = *KeywordResp;\r
2451\r
2452 //\r
2453 // 2.1 Copy NameSpaceId section.\r
2454 //\r
5ad66ec6 2455 StrCpyS (RespStr, RespStrLen, L"NAMESPACE=");\r
87bfeb11 2456 RespStr += StrLen (RespStr);\r
5ad66ec6 2457 StrCpyS (RespStr, RespStrLen, UnicodeNameSpace);\r
87bfeb11
ED		 2458 RespStr += StrLen (RespStr);\r
2459\r
2460 //\r
2461 // 2.2 Copy PathHdr section.\r
2462 //\r
5ad66ec6 2463 StrCpyS (RespStr, RespStrLen, PathHdr);\r
87bfeb11
ED		 2464 RespStr += StrLen (RespStr);\r
2465\r
2466 //\r
2467 // 2.3 Copy Keyword section.\r
2468 //\r
5ad66ec6 2469 StrCpyS (RespStr, RespStrLen, L"KEYWORD=");\r
87bfeb11 2470 RespStr += StrLen (RespStr);\r
5ad66ec6 2471 StrCpyS (RespStr, RespStrLen, KeywordData);\r
87bfeb11
ED		 2472 RespStr += StrLen (RespStr);\r
2473\r
2474 //\r
2475 // 2.4 Copy the Value section.\r
2476 //\r
5ad66ec6 2477 StrCpyS (RespStr, RespStrLen, ValueStr);\r
87bfeb11
ED		 2478 RespStr += StrLen (RespStr);\r
2479\r
2480 //\r
2481 // 2.5 Copy ReadOnly section if exist.\r
2482 //\r
2483 if (ReadOnly) {\r
5ad66ec6 2484 StrCpyS (RespStr, RespStrLen, L"&READONLY");\r
87bfeb11
ED		 2485 RespStr += StrLen (RespStr);\r
2486 }\r
2487\r
2488 //\r
2489 // 2.6 Add the end.\r
2490 //\r
2491 *RespStr = L'\0';\r
2492\r
2493 if (UnicodeNameSpace != NULL) {\r
2494 FreePool (UnicodeNameSpace);\r
2495 }\r
2496 if (PathHdr != NULL) {\r
2497 FreePool (PathHdr);\r
2498 }\r
2499 \r
2500 return EFI_SUCCESS;\r
2501}\r
2502\r
2503/**\r
2504 Merge the KeywordResp String to MultiKeywordResp string.\r
2505\r
2506 This is a internal function.\r
2507\r
2508 @param MultiKeywordResp The existed multikeywordresp string.\r
2509 @param KeywordResp The input keywordResp string.\r
2510\r
2511 @retval EFI_OUT_OF_RESOURCES The memory can't be allocated.\r
2512 @retval EFI_SUCCESS Generate the MultiKeywordResp string.\r
2513\r
2514**/\r
2515EFI_STATUS\r
2516MergeToMultiKeywordResp (\r
2517 IN OUT EFI_STRING *MultiKeywordResp,\r
2518 IN EFI_STRING *KeywordResp\r
2519 )\r
2520{\r
2521 UINTN MultiKeywordRespLen;\r
2522 EFI_STRING StringPtr;\r
2523\r
2524 if (*MultiKeywordResp == NULL) {\r
2525 *MultiKeywordResp = *KeywordResp;\r
2526 *KeywordResp = NULL;\r
2527 return EFI_SUCCESS;\r
2528 }\r
2529\r
2530 MultiKeywordRespLen = (StrLen (*MultiKeywordResp) + 1 + StrLen (*KeywordResp) + 1) * sizeof (CHAR16);\r
2531\r
2532 StringPtr = AllocateCopyPool (MultiKeywordRespLen, *MultiKeywordResp);\r
2533 if (StringPtr == NULL) {\r
2534 return EFI_OUT_OF_RESOURCES;\r
2535 }\r
2536 \r
2537 FreePool (*MultiKeywordResp);\r
2538 *MultiKeywordResp = StringPtr;\r
2539\r
2540 StringPtr += StrLen (StringPtr);\r
2541\r
2542 *StringPtr = L'&';\r
2543 StringPtr++;\r
2544\r
5ad66ec6 2545 StrCpyS (StringPtr, MultiKeywordRespLen / sizeof (CHAR16), *KeywordResp);\r
87bfeb11
ED		 2546\r
2547 return EFI_SUCCESS;\r
2548}\r
2549\r
2550/**\r
2551 Enumerate all keyword in the system. \r
2552 \r
2553 If error occur when parse one keyword, just skip it and parse the next one. \r
2554\r
2555 This is a internal function.\r
2556\r
2557 @param NameSpace The namespace used to search the string.\r
2558 @param MultiResp Return the MultiKeywordResp string for the system.\r
2559\r
2560 @retval EFI_OUT_OF_RESOURCES The memory can't be allocated.\r
2561 @retval EFI_SUCCESS Generate the MultiKeywordResp string.\r
2562 @retval EFI_NOT_FOUND No keyword found.\r
2563\r
2564**/\r
2565EFI_STATUS\r
2566EnumerateAllKeywords (\r
2567 IN CHAR8 *NameSpace,\r
2568 OUT EFI_STRING *MultiResp\r
2569 )\r
2570{\r
2571 LIST_ENTRY *Link;\r
2572 LIST_ENTRY *StringLink;\r
2573 UINT8 *DevicePathPkg;\r
2574 UINT8 *DevicePath;\r
2575 HII_DATABASE_RECORD *DataBaseRecord;\r
87bfeb11
ED		 2576 HII_DATABASE_PACKAGE_LIST_INSTANCE *PackageListNode;\r
2577 HII_STRING_PACKAGE_INSTANCE *StringPackage;\r
2578 CHAR8 *LocalNameSpace;\r
2579 EFI_STRING_ID NextStringId;\r
2580 EFI_STATUS Status;\r
c2400145 2581 UINT8 *OpCode;\r
87bfeb11
ED		 2582 CHAR16 *ConfigRequest;\r
2583 CHAR16 *ValueElement;\r
2584 CHAR16 *KeywordResp;\r
2585 CHAR16 *MultiKeywordResp;\r
2586 CHAR16 *KeywordData;\r
2587 BOOLEAN ReadOnly;\r
2588\r
2589 DataBaseRecord = NULL;\r
87bfeb11
ED		 2590 Status = EFI_SUCCESS;\r
2591 MultiKeywordResp = NULL;\r
2592 DevicePath = NULL;\r
2593 LocalNameSpace = NULL;\r
2594 ConfigRequest = NULL;\r
2595 ValueElement = NULL;\r
2596 KeywordResp = NULL;\r
2597\r
2598 if (NameSpace == NULL) {\r
2599 NameSpace = UEFI_CONFIG_LANG;\r
2600 }\r
2601\r
2602 //\r
2603 // Find driver which matches the routing data.\r
2604 //\r
2605 for (Link = mPrivate.DatabaseList.ForwardLink; Link != &mPrivate.DatabaseList; Link = Link->ForwardLink) {\r
2606 DataBaseRecord = CR (Link, HII_DATABASE_RECORD, DatabaseEntry, HII_DATABASE_RECORD_SIGNATURE);\r
2607 if ((DevicePathPkg = DataBaseRecord->PackageList->DevicePathPkg) != NULL) {\r
2608 DevicePath = DevicePathPkg + sizeof (EFI_HII_PACKAGE_HEADER);\r
87bfeb11
ED		 2609 }\r
2610 PackageListNode = DataBaseRecord->PackageList;\r
2611\r
2612 for (StringLink = PackageListNode->StringPkgHdr.ForwardLink; StringLink != &PackageListNode->StringPkgHdr; StringLink = StringLink->ForwardLink) {\r
2613 StringPackage = CR (StringLink, HII_STRING_PACKAGE_INSTANCE, StringEntry, HII_STRING_PACKAGE_SIGNATURE);\r
2614\r
2615 //\r
2616 // Check whether has keyword string package.\r
2617 //\r
2618 if (AsciiStrnCmp(NameSpace, StringPackage->StringPkgHdr->Language, AsciiStrLen (NameSpace)) == 0) {\r
2619 //\r
2620 // Keep the NameSpace string.\r
2621 //\r
2622 LocalNameSpace = AllocateCopyPool (AsciiStrSize (StringPackage->StringPkgHdr->Language), StringPackage->StringPkgHdr->Language);\r
2623 if (LocalNameSpace == NULL) {\r
2624 return EFI_OUT_OF_RESOURCES;\r
2625 }\r
2626\r
2627 //\r
2628 // 1 means just begin the enumerate the valid string ids.\r
2629 // StringId == 1 is always used to save the language for this string package.\r
2630 // Any valid string start from 2. so here initial it to 1.\r
2631 //\r
2632 NextStringId = 1;\r
2633 \r
2634 //\r
2635 // Enumerate all valid stringid in the package.\r
2636 //\r
2637 while ((NextStringId = GetNextStringId (StringPackage, NextStringId, &KeywordData)) != 0) {\r
2638 //\r
2639 // 3.3 Construct the ConfigRequest string.\r
2640 //\r
2641 Status = ExtractConfigRequest (DataBaseRecord, NextStringId, &OpCode, &ConfigRequest);\r
2642 if (EFI_ERROR (Status)) {\r
2643 //\r
2644 // If can't generate ConfigRequest for this question, skip it and start the next.\r
2645 //\r
2646 goto Error;\r
2647 }\r
2648 \r
2649 //\r
2650 // 3.4 Extract Value for the input keyword.\r
2651 //\r
2652 Status = ExtractValueFromDriver(ConfigRequest, &ValueElement);\r
2653 if (EFI_ERROR (Status)) {\r
2654 if (Status != EFI_OUT_OF_RESOURCES) {\r
2655 //\r
2656 // If can't generate ConfigRequest for this question, skip it and start the next.\r
2657 //\r
2658 goto Error;\r
2659 }\r
2660 //\r
2661 // If EFI_OUT_OF_RESOURCES error occur, no need to continue.\r
2662 //\r
2663 goto Done;\r
2664 }\r
2665\r
2666 //\r
2667 // Extract readonly flag from opcode.\r
2668 //\r
2669 ReadOnly = ExtractReadOnlyFromOpCode(OpCode);\r
2670\r
2671 //\r
2672 // 5. Generate KeywordResp string.\r
2673 //\r
2674 ASSERT (DevicePath != NULL);\r
2675 Status = GenerateKeywordResp(LocalNameSpace, (EFI_DEVICE_PATH_PROTOCOL *)DevicePath, KeywordData, ValueElement, ReadOnly, &KeywordResp);\r
2676 if (Status != EFI_SUCCESS) {\r
2677 //\r
2678 // If EFI_OUT_OF_RESOURCES error occur, no need to continue.\r
2679 //\r
2680 goto Done;\r
2681 }\r
2682 \r
2683 //\r
2684 // 6. Merge to the MultiKeywordResp string.\r
2685 //\r
2686 Status = MergeToMultiKeywordResp(&MultiKeywordResp, &KeywordResp);\r
2687 if (EFI_ERROR (Status)) {\r
2688 goto Done;\r
2689 }\r
2690Error:\r
2691 //\r
2692 // Clean the temp buffer to later use again.\r
2693 //\r
2694 if (ConfigRequest != NULL) {\r
2695 FreePool (ConfigRequest);\r
2696 ConfigRequest = NULL;\r
2697 }\r
2698 if (ValueElement != NULL) {\r
2699 FreePool (ValueElement);\r
2700 ValueElement = NULL;\r
2701 }\r
2702 if (KeywordResp != NULL) {\r
2703 FreePool (KeywordResp);\r
2704 KeywordResp = NULL;\r
2705 } \r
2706 }\r
2707\r
2708 if (LocalNameSpace != NULL) {\r
2709 FreePool (LocalNameSpace);\r
2710 LocalNameSpace = NULL;\r
2711 }\r
2712 }\r
2713 } \r
2714 }\r
2715\r
2716 //\r
2717 // return the already get MultiKeywordString even error occured.\r
2718 //\r
2719 if (MultiKeywordResp == NULL) {\r
2720 Status = EFI_NOT_FOUND;\r
2721 } else {\r
2722 Status = EFI_SUCCESS;\r
2723 }\r
2724 *MultiResp = MultiKeywordResp;\r
2725 \r
2726Done:\r
2727 if (LocalNameSpace != NULL) {\r
2728 FreePool (LocalNameSpace);\r
2729 }\r
2730 if (ConfigRequest != NULL) {\r
2731 FreePool (ConfigRequest);\r
2732 }\r
2733 if (ValueElement != NULL) {\r
2734 FreePool (ValueElement);\r
2735 }\r
2736\r
2737 return Status;\r
2738}\r
2739\r
2740/**\r
2741\r
2742 This function accepts a <MultiKeywordResp> formatted string, finds the associated\r
2743 keyword owners, creates a <MultiConfigResp> string from it and forwards it to the\r
2744 EFI_HII_ROUTING_PROTOCOL.RouteConfig function.\r
2745 \r
2746 If there is an issue in resolving the contents of the KeywordString, then the \r
2747 function returns an error and also sets the Progress and ProgressErr with the \r
2748 appropriate information about where the issue occurred and additional data about\r
2749 the nature of the issue. \r
2750 \r
2751 In the case when KeywordString containing multiple keywords, when an EFI_NOT_FOUND\r
2752 error is generated during processing the second or later keyword element, the system\r
2753 storage associated with earlier keywords is not modified. All elements of the \r
2754 KeywordString must successfully pass all tests for format and access prior to making\r
2755 any modifications to storage.\r
2756 \r
2757 In the case when EFI_DEVICE_ERROR is returned from the processing of a KeywordString\r
2758 containing multiple keywords, the state of storage associated with earlier keywords\r
2759 is undefined.\r
2760\r
2761\r
2762 @param This Pointer to the EFI_KEYWORD_HANDLER _PROTOCOL instance.\r
2763\r
2764 @param KeywordString A null-terminated string in <MultiKeywordResp> format. \r
2765\r
2766 @param Progress On return, points to a character in the KeywordString. \r
2767 Points to the string's NULL terminator if the request \r
2768 was successful. Points to the most recent '&' before \r
2769 the first failing string element if the request was \r
2770 not successful.\r
2771\r
2772 @param ProgressErr If during the processing of the KeywordString there was\r
2773 a failure, this parameter gives additional information \r
2774 about the possible source of the problem. The various \r
2775 errors are defined in "Related Definitions" below.\r
2776\r
2777\r
2778 @retval EFI_SUCCESS The specified action was completed successfully.\r
2779\r
2780 @retval EFI_INVALID_PARAMETER One or more of the following are TRUE:\r
2781 1. KeywordString is NULL.\r
2782 2. Parsing of the KeywordString resulted in an \r
2783 error. See Progress and ProgressErr for more data.\r
2784\r
2785 @retval EFI_NOT_FOUND An element of the KeywordString was not found. \r
2786 See ProgressErr for more data.\r
2787\r
2788 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. \r
2789 See ProgressErr for more data.\r
2790 \r
2791 @retval EFI_ACCESS_DENIED The action violated system policy. See ProgressErr \r
2792 for more data.\r
2793\r
2794 @retval EFI_DEVICE_ERROR An unexpected system error occurred. See ProgressErr\r
2795 for more data.\r
2796\r
2797**/\r
2798EFI_STATUS\r
2799EFIAPI \r
2800EfiConfigKeywordHandlerSetData (\r
2801 IN EFI_CONFIG_KEYWORD_HANDLER_PROTOCOL *This,\r
2802 IN CONST EFI_STRING KeywordString,\r
2803 OUT EFI_STRING *Progress,\r
2804 OUT UINT32 *ProgressErr\r
2805 )\r
2806{\r
2807 CHAR8 *NameSpace;\r
2808 EFI_STATUS Status;\r
2809 CHAR16 *StringPtr;\r
2810 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
9946c0a9 2811 CHAR16 *NextStringPtr;\r
87bfeb11
ED		 2812 CHAR16 *KeywordData;\r
2813 EFI_STRING_ID KeywordStringId;\r
2814 UINT32 RetVal;\r
2815 HII_DATABASE_RECORD *DataBaseRecord;\r
2816 UINT8 *OpCode;\r
2817 CHAR16 *ConfigResp;\r
2818 CHAR16 *MultiConfigResp;\r
2819 CHAR16 *ValueElement;\r
2820 BOOLEAN ReadOnly;\r
2821 EFI_STRING InternalProgress;\r
9946c0a9 2822 CHAR16 *TempString;\r
87bfeb11
ED		 2823\r
2824 if (This == NULL || Progress == NULL || ProgressErr == NULL || KeywordString == NULL) {\r
2825 return EFI_INVALID_PARAMETER;\r
2826 }\r
2827\r
2828 *Progress = KeywordString;\r
2829 *ProgressErr = KEYWORD_HANDLER_UNDEFINED_PROCESSING_ERROR;\r
2830 Status = EFI_SUCCESS;\r
87bfeb11
ED		 2831 MultiConfigResp = NULL;\r
2832 NameSpace = NULL;\r
2833 DevicePath = NULL;\r
2834 KeywordData = NULL;\r
2835 ValueElement = NULL;\r
2836 ConfigResp = NULL;\r
2837 KeywordStringId = 0;\r
2838\r
9946c0a9
ED		 2839 //\r
2840 // Use temp string to avoid changing input string buffer.\r
2841 //\r
2842 TempString = AllocateCopyPool (StrSize (KeywordString), KeywordString);\r
2843 ASSERT (TempString != NULL);\r
2844 StringPtr = TempString;\r
2845\r
87bfeb11
ED		 2846 while ((StringPtr != NULL) && (*StringPtr != L'\0')) {\r
2847 //\r
2848 // 1. Get NameSpace from NameSpaceId keyword.\r
2849 //\r
2850 Status = ExtractNameSpace (StringPtr, &NameSpace, &NextStringPtr);\r
2851 if (EFI_ERROR (Status)) {\r
2852 *ProgressErr = KEYWORD_HANDLER_MALFORMED_STRING;\r
e74c4279 2853 goto Done;\r
87bfeb11 2854 }\r
22950757 2855 ASSERT (NameSpace != NULL);\r
e74c4279
ED		 2856 //\r
2857 // 1.1 Check whether the input namespace is valid.\r
2858 //\r
2859 if (AsciiStrnCmp(NameSpace, UEFI_CONFIG_LANG, AsciiStrLen (UEFI_CONFIG_LANG)) != 0) {\r
2860 *ProgressErr = KEYWORD_HANDLER_UNDEFINED_PROCESSING_ERROR;\r
2861 Status = EFI_INVALID_PARAMETER;\r
2862 goto Done;\r
2863 }\r
2864\r
87bfeb11
ED		 2865 StringPtr = NextStringPtr;\r
2866\r
2867 //\r
2868 // 2. Get possible Device Path info from KeywordString.\r
2869 //\r
2870 Status = ExtractDevicePath (StringPtr, (UINT8 **)&DevicePath, &NextStringPtr);\r
2871 if (EFI_ERROR (Status)) {\r
2872 *ProgressErr = KEYWORD_HANDLER_MALFORMED_STRING;\r
2873 goto Done;\r
2874 }\r
2875 StringPtr = NextStringPtr;\r
2876\r
2877 //\r
2878 // 3. Extract keyword from the KeywordRequest string.\r
2879 //\r
2880 Status = ExtractKeyword(StringPtr, &KeywordData, &NextStringPtr);\r
2881 if (EFI_ERROR (Status)) {\r
2882 //\r
2883 // Can't find Keyword base on the input device path info.\r
2884 //\r
2885 *ProgressErr = KEYWORD_HANDLER_MALFORMED_STRING;\r
2886 Status = EFI_INVALID_PARAMETER;\r
2887 goto Done;\r
2888 }\r
2889 StringPtr = NextStringPtr;\r
2890\r
2891 //\r
2892 // 4. Extract Value from the KeywordRequest string.\r
2893 //\r
2894 Status = ExtractValue (StringPtr, &ValueElement, &NextStringPtr);\r
2895 if (EFI_ERROR (Status)) {\r
2896 //\r
2897 // Can't find Value base on the input device path info.\r
2898 //\r
2899 *ProgressErr = KEYWORD_HANDLER_MALFORMED_STRING;\r
2900 Status = EFI_INVALID_PARAMETER;\r
2901 goto Done;\r
2902 }\r
2903 StringPtr = NextStringPtr;\r
2904\r
2905 //\r
2906 // 5. Find ReadOnly filter.\r
2907 //\r
2908 if ((StringPtr != NULL) && StrnCmp (StringPtr, L"&ReadOnly", StrLen (L"&ReadOnly")) == 0) {\r
2909 ReadOnly = TRUE;\r
2910 StringPtr += StrLen (L"&ReadOnly");\r
2911 } else {\r
2912 ReadOnly = FALSE;\r
2913 }\r
2914\r
2915 //\r
2916 // 6. Get EFI_STRING_ID for the input keyword.\r
2917 //\r
2918 Status = GetStringIdFromDatabase (&DevicePath, &NameSpace, KeywordData, &RetVal, &KeywordStringId, &DataBaseRecord);\r
2919 if (EFI_ERROR (Status)) {\r
2920 *ProgressErr = RetVal;\r
2921 goto Done;\r
2922 }\r
2923\r
2924 //\r
2925 // 7. Construct the ConfigRequest string.\r
2926 //\r
2927 Status = ExtractConfigResp (DataBaseRecord, KeywordStringId, ValueElement, &OpCode, &ConfigResp);\r
2928 if (EFI_ERROR (Status)) {\r
2929 goto Done;\r
2930 }\r
2931\r
2932 //\r
2933 // 8. Check the readonly flag.\r
2934 //\r
2935 if (ExtractReadOnlyFromOpCode (OpCode) != ReadOnly) {\r
2936 *ProgressErr = KEYWORD_HANDLER_INCOMPATIBLE_VALUE_DETECTED;\r
2937 Status = EFI_INVALID_PARAMETER;\r
2938 goto Done; \r
2939 }\r
2940 \r
2941 //\r
2942 // 9. Merge to the MultiKeywordResp string.\r
2943 //\r
2944 Status = MergeToMultiKeywordResp(&MultiConfigResp, &ConfigResp);\r
2945 if (EFI_ERROR (Status)) {\r
2946 goto Done;\r
2947 }\r
2948\r
2949 //\r
2950 // 10. Clean the temp buffer point.\r
2951 //\r
2952 FreePool (NameSpace);\r
2953 FreePool (DevicePath);\r
2954 FreePool (KeywordData);\r
2955 FreePool (ValueElement);\r
2956 NameSpace = NULL;\r
2957 DevicePath = NULL; \r
2958 KeywordData = NULL;\r
2959 ValueElement = NULL;\r
2960 if (ConfigResp != NULL) {\r
2961 FreePool (ConfigResp);\r
2962 ConfigResp = NULL;\r
2963 }\r
2964 }\r
2965\r
2966 //\r
2967 // 11. Set value to driver.\r
2968 //\r
2969 Status = mPrivate.ConfigRouting.RouteConfig(\r
2970 &mPrivate.ConfigRouting,\r
2971 (EFI_STRING) MultiConfigResp,\r
2972 &InternalProgress\r
2973 );\r
2974 if (EFI_ERROR (Status)) {\r
2975 Status = EFI_DEVICE_ERROR;\r
2976 goto Done;\r
2977 }\r
2978 \r
2979 *ProgressErr = KEYWORD_HANDLER_NO_ERROR;\r
2980\r
2981Done:\r
9946c0a9
ED		 2982 ASSERT (TempString != NULL);\r
2983 FreePool (TempString);\r
87bfeb11
ED		 2984 if (NameSpace != NULL) {\r
2985 FreePool (NameSpace);\r
2986 }\r
2987 if (DevicePath != NULL) {\r
2988 FreePool (DevicePath);\r
2989 }\r
2990 if (KeywordData != NULL) {\r
2991 FreePool (KeywordData);\r
2992 }\r
2993 if (ValueElement != NULL) {\r
2994 FreePool (ValueElement);\r
2995 }\r
2996 if (ConfigResp != NULL) {\r
2997 FreePool (ConfigResp);\r
2998 }\r
2999 if (MultiConfigResp != NULL && MultiConfigResp != ConfigResp) {\r
3000 FreePool (MultiConfigResp);\r
3001 } \r
3002 *Progress = StringPtr;\r
3003 return Status;\r
3004}\r
3005\r
3006/**\r
3007\r
3008 This function accepts a <MultiKeywordRequest> formatted string, finds the underlying \r
3009 keyword owners, creates a <MultiConfigRequest> string from it and forwards it to the\r
3010 EFI_HII_ROUTING_PROTOCOL.ExtractConfig function.\r
3011 \r
3012 If there is an issue in resolving the contents of the KeywordString, then the function\r
3013 returns an EFI_INVALID_PARAMETER and also set the Progress and ProgressErr with the\r
3014 appropriate information about where the issue occurred and additional data about the\r
3015 nature of the issue.\r
3016 \r
3017 In the case when KeywordString is NULL, or contains multiple keywords, or when\r
3018 EFI_NOT_FOUND is generated while processing the keyword elements, the Results string\r
3019 contains values returned for all keywords processed prior to the keyword generating the \r
3020 error but no values for the keyword with error or any following keywords.\r
3021\r
3022 \r
3023 @param This Pointer to the EFI_KEYWORD_HANDLER _PROTOCOL instance.\r
3024 \r
3025 @param NameSpaceId A null-terminated string containing the platform configuration\r
3026 language to search through in the system. If a NULL is passed\r
3027 in, then it is assumed that any platform configuration language\r
3028 with the prefix of "x-UEFI-" are searched.\r
3029 \r
3030 @param KeywordString A null-terminated string in <MultiKeywordRequest> format. If a\r
3031 NULL is passed in the KeywordString field, all of the known \r
3032 keywords in the system for the NameSpaceId specified are \r
3033 returned in the Results field.\r
3034 \r
3035 @param Progress On return, points to a character in the KeywordString. Points\r
3036 to the string's NULL terminator if the request was successful. \r
3037 Points to the most recent '&' before the first failing string\r
3038 element if the request was not successful.\r
3039 \r
3040 @param ProgressErr If during the processing of the KeywordString there was a\r
3041 failure, this parameter gives additional information about the \r
3042 possible source of the problem. See the definitions in SetData()\r
3043 for valid value definitions.\r
3044 \r
3045 @param Results A null-terminated string in <MultiKeywordResp> format is returned\r
3046 which has all the values filled in for the keywords in the \r
3047 KeywordString. This is a callee-allocated field, and must be freed\r
3048 by the caller after being used. \r
3049\r
3050 @retval EFI_SUCCESS The specified action was completed successfully.\r
3051 \r
3052 @retval EFI_INVALID_PARAMETER One or more of the following are TRUE:\r
3053 1.Progress, ProgressErr, or Resuts is NULL.\r
3054 2.Parsing of the KeywordString resulted in an error. See\r
3055 Progress and ProgressErr for more data.\r
3056 \r
3057\r
3058 @retval EFI_NOT_FOUND An element of the KeywordString was not found. See\r
3059 ProgressErr for more data.\r
3060\r
3061 @retval EFI_NOT_FOUND The NamespaceId specified was not found. See ProgressErr\r
3062 for more data.\r
3063\r
3064 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. See\r
3065 ProgressErr for more data.\r
3066 \r
3067 @retval EFI_ACCESS_DENIED The action violated system policy. See ProgressErr for\r
3068 more data.\r
3069\r
3070 @retval EFI_DEVICE_ERROR An unexpected system error occurred. See ProgressErr\r
3071 for more data.\r
3072\r
3073**/\r
3074EFI_STATUS\r
3075EFIAPI \r
3076EfiConfigKeywordHandlerGetData (\r
3077 IN EFI_CONFIG_KEYWORD_HANDLER_PROTOCOL *This,\r
3078 IN CONST EFI_STRING NameSpaceId, OPTIONAL\r
3079 IN CONST EFI_STRING KeywordString, OPTIONAL\r
3080 OUT EFI_STRING *Progress, \r
3081 OUT UINT32 *ProgressErr,\r
3082 OUT EFI_STRING *Results\r
3083 )\r
3084{\r
3085 CHAR8 *NameSpace;\r
3086 EFI_STATUS Status;\r
3087 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
3088 HII_DATABASE_RECORD *DataBaseRecord;\r
3089 CHAR16 *StringPtr;\r
3090 CHAR16 *NextStringPtr; \r
3091 CHAR16 *KeywordData;\r
3092 EFI_STRING_ID KeywordStringId;\r
3093 UINT8 *OpCode;\r
3094 CHAR16 *ConfigRequest;\r
3095 CHAR16 *ValueElement;\r
3096 UINT32 RetVal;\r
3097 BOOLEAN ReadOnly;\r
3098 CHAR16 *KeywordResp;\r
3099 CHAR16 *MultiKeywordResp;\r
9946c0a9 3100 CHAR16 *TempString;\r
87bfeb11
ED		 3101\r
3102 if (This == NULL || Progress == NULL || ProgressErr == NULL || Results == NULL) {\r
3103 return EFI_INVALID_PARAMETER;\r
3104 }\r
3105\r
3106 *ProgressErr = KEYWORD_HANDLER_UNDEFINED_PROCESSING_ERROR;\r
3107 Status = EFI_SUCCESS;\r
3108 DevicePath = NULL;\r
3109 NameSpace = NULL;\r
3110 KeywordData = NULL;\r
3111 ConfigRequest= NULL;\r
3112 StringPtr = KeywordString;\r
3113 ReadOnly = FALSE;\r
3114 MultiKeywordResp = NULL;\r
3115 KeywordStringId = 0;\r
9946c0a9 3116 TempString = NULL;\r
87bfeb11 3117\r
9946c0a9
ED		 3118 //\r
3119 // Use temp string to avoid changing input string buffer.\r
3120 //\r
3121 if (NameSpaceId != NULL) {\r
3122 TempString = AllocateCopyPool (StrSize (NameSpaceId), NameSpaceId);\r
3123 ASSERT (TempString != NULL);\r
3124 }\r
87bfeb11
ED		 3125 //\r
3126 // 1. Get NameSpace from NameSpaceId keyword.\r
3127 //\r
9946c0a9
ED		 3128 Status = ExtractNameSpace (TempString, &NameSpace, NULL);\r
3129 if (TempString != NULL) {\r
3130 FreePool (TempString);\r
3131 TempString = NULL;\r
3132 }\r
87bfeb11
ED		 3133 if (EFI_ERROR (Status)) {\r
3134 *ProgressErr = KEYWORD_HANDLER_NAMESPACE_ID_NOT_FOUND;\r
3135 return Status;\r
3136 }\r
e74c4279
ED		 3137 //\r
3138 // 1.1 Check whether the input namespace is valid.\r
3139 //\r
22950757
DB		 3140 if (NameSpace != NULL){\r
3141 if (AsciiStrnCmp(NameSpace, UEFI_CONFIG_LANG, AsciiStrLen (UEFI_CONFIG_LANG)) != 0) {\r
3142 *ProgressErr = KEYWORD_HANDLER_UNDEFINED_PROCESSING_ERROR;\r
3143 return EFI_INVALID_PARAMETER;\r
3144 }\r
e74c4279
ED		 3145 }\r
3146 \r
87bfeb11 3147 if (KeywordString != NULL) {\r
9946c0a9
ED		 3148 //\r
3149 // Use temp string to avoid changing input string buffer.\r
3150 //\r
3151 TempString = AllocateCopyPool (StrSize (KeywordString), KeywordString);\r
3152 ASSERT (TempString != NULL);\r
3153 StringPtr = TempString;\r
87bfeb11
ED		 3154\r
3155 while (*StringPtr != L'\0') {\r
3156 //\r
3157 // 2. Get possible Device Path info from KeywordString.\r
3158 //\r
3159 Status = ExtractDevicePath (StringPtr, (UINT8 **)&DevicePath, &NextStringPtr);\r
3160 if (EFI_ERROR (Status)) {\r
3161 *ProgressErr = KEYWORD_HANDLER_MALFORMED_STRING;\r
3162 goto Done;\r
3163 }\r
3164 StringPtr = NextStringPtr;\r
3165\r
3166 \r
3167 //\r
3168 // 3. Process Keyword section from the input keywordRequest string.\r
3169 //\r
3170 // 3.1 Extract keyword from the KeywordRequest string.\r
3171 //\r
3172 Status = ExtractKeyword(StringPtr, &KeywordData, &NextStringPtr);\r
3173 if (EFI_ERROR (Status)) {\r
3174 //\r
3175 // Can't find Keyword base on the input device path info.\r
3176 //\r
3177 *ProgressErr = KEYWORD_HANDLER_MALFORMED_STRING;\r
3178 Status = EFI_INVALID_PARAMETER;\r
3179 goto Done;\r
3180 }\r
3181\r
3182 //\r
3183 // 3.2 Get EFI_STRING_ID for the input keyword.\r
3184 //\r
3185 Status = GetStringIdFromDatabase (&DevicePath, &NameSpace, KeywordData, &RetVal, &KeywordStringId, &DataBaseRecord);\r
3186 if (EFI_ERROR (Status)) {\r
3187 *ProgressErr = RetVal;\r
3188 goto Done;\r
3189 }\r
3190\r
3191 //\r
3192 // 3.3 Construct the ConfigRequest string.\r
3193 //\r
3194 Status = ExtractConfigRequest (DataBaseRecord, KeywordStringId, &OpCode, &ConfigRequest);\r
3195 if (EFI_ERROR (Status)) {\r
3196 goto Done;\r
3197 }\r
3198 \r
3199 //\r
3200 // 3.4 Extract Value for the input keyword.\r
3201 //\r
3202 Status = ExtractValueFromDriver(ConfigRequest, &ValueElement);\r
3203 if (EFI_ERROR (Status)) {\r
3204 if (Status != EFI_OUT_OF_RESOURCES) {\r
3205 Status = EFI_DEVICE_ERROR;\r
3206 }\r
3207 goto Done;\r
3208 }\r
3209 StringPtr = NextStringPtr;\r
3210\r
3211 //\r
3212 // 4. Process the possible filter section.\r
3213 //\r
3214 RetVal = ValidateFilter (OpCode, StringPtr, &NextStringPtr, &ReadOnly);\r
3215 if (RetVal != KEYWORD_HANDLER_NO_ERROR) {\r
3216 *ProgressErr = RetVal;\r
3217 Status = EFI_INVALID_PARAMETER;\r
3218 goto Done;\r
3219 }\r
3220 StringPtr = NextStringPtr;\r
3221\r
3222\r
3223 //\r
3224 // 5. Generate KeywordResp string.\r
3225 //\r
3226 Status = GenerateKeywordResp(NameSpace, DevicePath, KeywordData, ValueElement, ReadOnly, &KeywordResp);\r
3227 if (Status != EFI_SUCCESS) {\r
3228 goto Done;\r
3229 }\r
3230\r
3231 //\r
3232 // 6. Merge to the MultiKeywordResp string.\r
3233 //\r
3234 Status = MergeToMultiKeywordResp(&MultiKeywordResp, &KeywordResp);\r
3235 if (EFI_ERROR (Status)) {\r
3236 goto Done;\r
3237 }\r
3238\r
3239 //\r
3240 // 7. Update return value.\r
3241 //\r
3242 *Results = MultiKeywordResp;\r
3243\r
3244 //\r
3245 // 8. Clean the temp buffer.\r
3246 //\r
3247 FreePool (DevicePath);\r
3248 FreePool (KeywordData);\r
3249 FreePool (ValueElement);\r
3250 FreePool (ConfigRequest);\r
3251 DevicePath = NULL; \r
3252 KeywordData = NULL;\r
3253 ValueElement = NULL;\r
3254 ConfigRequest = NULL;\r
3255 if (KeywordResp != NULL) {\r
3256 FreePool (KeywordResp);\r
3257 KeywordResp = NULL;\r
3258 }\r
3259 }\r
3260 } else {\r
3261 //\r
3262 // Enumerate all keyword in the system.\r
3263 //\r
3264 Status = EnumerateAllKeywords(NameSpace, &MultiKeywordResp);\r
3265 if (EFI_ERROR (Status)) {\r
3266 goto Done;\r
3267 }\r
3268 *Results = MultiKeywordResp;\r
3269 }\r
3270\r
3271 *ProgressErr = KEYWORD_HANDLER_NO_ERROR;\r
3272\r
3273Done:\r
9946c0a9
ED		 3274 if (TempString != NULL) {\r
3275 FreePool (TempString);\r
3276 }\r
87bfeb11
ED		 3277 if (NameSpace != NULL) {\r
3278 FreePool (NameSpace);\r
3279 }\r
3280 if (DevicePath != NULL) {\r
3281 FreePool (DevicePath);\r
3282 }\r
3283 if (KeywordData != NULL) {\r
3284 FreePool (KeywordData);\r
3285 }\r
3286 *Progress = StringPtr;\r
3287 return Status;\r
3288}\r
EFI Development Kit II mirror for PVE