]> git.proxmox.com Git - mirror_edk2.git/blame - IntelFrameworkModulePkg/Library/GenericBdsLib/BdsBoot.c
Fixed one possible array out of bounds issue.
[mirror_edk2.git] / IntelFrameworkModulePkg / Library / GenericBdsLib / BdsBoot.c
CommitLineData
5c08e117 1/** @file\r
2 BDS Lib functions which relate with create or process the boot option.\r
3\r
69fc8f08 4Copyright (c) 2004 - 2014, Intel Corporation. All rights reserved.<BR>\r
180a5a35 5This program and the accompanying materials\r
5c08e117 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#include "InternalBdsLib.h"\r
9aa7ba01 16#include "String.h"\r
5c08e117 17\r
18BOOLEAN mEnumBootDevice = FALSE;\r
9aa7ba01 19EFI_HII_HANDLE gBdsLibStringPackHandle = NULL;\r
5c08e117 20\r
9aa7ba01 21/**\r
22 The constructor function register UNI strings into imageHandle.\r
23 \r
24 It will ASSERT() if that operation fails and it will always return EFI_SUCCESS. \r
25\r
26 @param ImageHandle The firmware allocated handle for the EFI image.\r
27 @param SystemTable A pointer to the EFI System Table.\r
28 \r
29 @retval EFI_SUCCESS The constructor successfully added string package.\r
30 @retval Other value The constructor can't add string package.\r
31\r
32**/\r
33EFI_STATUS\r
34EFIAPI\r
35GenericBdsLibConstructor (\r
36 IN EFI_HANDLE ImageHandle,\r
37 IN EFI_SYSTEM_TABLE *SystemTable\r
38 )\r
39{\r
40\r
41 gBdsLibStringPackHandle = HiiAddPackages (\r
e24fc103 42 &gBdsLibStringPackageGuid,\r
09363eca 43 ImageHandle,\r
9aa7ba01 44 GenericBdsLibStrings,\r
45 NULL\r
46 );\r
47\r
48 ASSERT (gBdsLibStringPackHandle != NULL);\r
49\r
50 return EFI_SUCCESS;\r
51}\r
52\r
16e5944a
RN
53/**\r
54 Deletete the Boot Option from EFI Variable. The Boot Order Arrray\r
55 is also updated.\r
56\r
57 @param OptionNumber The number of Boot option want to be deleted.\r
58 @param BootOrder The Boot Order array.\r
59 @param BootOrderSize The size of the Boot Order Array.\r
60\r
61 @retval EFI_SUCCESS The Boot Option Variable was found and removed\r
62 @retval EFI_UNSUPPORTED The Boot Option Variable store was inaccessible\r
63 @retval EFI_NOT_FOUND The Boot Option Variable was not found\r
64**/\r
65EFI_STATUS\r
66EFIAPI\r
67BdsDeleteBootOption (\r
68 IN UINTN OptionNumber,\r
69 IN OUT UINT16 *BootOrder,\r
70 IN OUT UINTN *BootOrderSize\r
71 )\r
72{\r
73 CHAR16 BootOption[9];\r
74 UINTN Index;\r
75 EFI_STATUS Status;\r
76\r
77 UnicodeSPrint (BootOption, sizeof (BootOption), L"Boot%04x", OptionNumber);\r
78 Status = gRT->SetVariable (\r
79 BootOption,\r
80 &gEfiGlobalVariableGuid,\r
81 0,\r
82 0,\r
83 NULL\r
84 );\r
69fc8f08
RN
85 //\r
86 // Deleting variable with existing variable implementation shouldn't fail.\r
87 //\r
88 ASSERT_EFI_ERROR (Status);\r
16e5944a
RN
89\r
90 //\r
91 // adjust boot order array\r
92 //\r
93 for (Index = 0; Index < *BootOrderSize / sizeof (UINT16); Index++) {\r
94 if (BootOrder[Index] == OptionNumber) {\r
95 CopyMem (&BootOrder[Index], &BootOrder[Index+1], *BootOrderSize - (Index+1) * sizeof (UINT16));\r
96 *BootOrderSize -= sizeof (UINT16);\r
97 break;\r
98 }\r
99 }\r
100\r
101 return Status;\r
102}\r
103/**\r
104\r
105 Translate the first n characters of an Ascii string to\r
106 Unicode characters. The count n is indicated by parameter\r
107 Size. If Size is greater than the length of string, then\r
108 the entire string is translated.\r
109\r
110\r
111 @param AStr Pointer to input Ascii string.\r
112 @param Size The number of characters to translate.\r
113 @param UStr Pointer to output Unicode string buffer.\r
114\r
115**/\r
116VOID\r
117AsciiToUnicodeSize (\r
118 IN UINT8 *AStr,\r
119 IN UINTN Size,\r
120 OUT UINT16 *UStr\r
121 )\r
122{\r
123 UINTN Idx;\r
124\r
125 Idx = 0;\r
126 while (AStr[Idx] != 0) {\r
127 UStr[Idx] = (CHAR16) AStr[Idx];\r
128 if (Idx == Size) {\r
129 break;\r
130 }\r
131\r
132 Idx++;\r
133 }\r
134 UStr[Idx] = 0;\r
135}\r
136\r
137/**\r
138 Build Legacy Device Name String according.\r
139\r
140 @param CurBBSEntry BBS Table.\r
141 @param Index Index.\r
142 @param BufSize The buffer size.\r
143 @param BootString The output string.\r
144\r
145**/\r
146VOID\r
147BdsBuildLegacyDevNameString (\r
148 IN BBS_TABLE *CurBBSEntry,\r
149 IN UINTN Index,\r
150 IN UINTN BufSize,\r
151 OUT CHAR16 *BootString\r
152 )\r
153{\r
154 CHAR16 *Fmt;\r
155 CHAR16 *Type;\r
156 UINT8 *StringDesc;\r
157 CHAR16 Temp[80];\r
158\r
159 switch (Index) {\r
160 //\r
161 // Primary Master\r
162 //\r
163 case 1:\r
164 Fmt = L"Primary Master %s";\r
165 break;\r
166\r
167 //\r
168 // Primary Slave\r
169 //\r
170 case 2:\r
171 Fmt = L"Primary Slave %s";\r
172 break;\r
173\r
174 //\r
175 // Secondary Master\r
176 //\r
177 case 3:\r
178 Fmt = L"Secondary Master %s";\r
179 break;\r
180\r
181 //\r
182 // Secondary Slave\r
183 //\r
184 case 4:\r
185 Fmt = L"Secondary Slave %s";\r
186 break;\r
187\r
188 default:\r
189 Fmt = L"%s";\r
190 break;\r
191 }\r
192\r
193 switch (CurBBSEntry->DeviceType) {\r
194 case BBS_FLOPPY:\r
195 Type = L"Floppy";\r
196 break;\r
197\r
198 case BBS_HARDDISK:\r
199 Type = L"Harddisk";\r
200 break;\r
201\r
202 case BBS_CDROM:\r
203 Type = L"CDROM";\r
204 break;\r
205\r
206 case BBS_PCMCIA:\r
207 Type = L"PCMCIAe";\r
208 break;\r
209\r
210 case BBS_USB:\r
211 Type = L"USB";\r
212 break;\r
213\r
214 case BBS_EMBED_NETWORK:\r
215 Type = L"Network";\r
216 break;\r
217\r
218 case BBS_BEV_DEVICE:\r
219 Type = L"BEVe";\r
220 break;\r
221\r
222 case BBS_UNKNOWN:\r
223 default:\r
224 Type = L"Unknown";\r
225 break;\r
226 }\r
227 //\r
228 // If current BBS entry has its description then use it.\r
229 //\r
230 StringDesc = (UINT8 *) (UINTN) ((CurBBSEntry->DescStringSegment << 4) + CurBBSEntry->DescStringOffset);\r
231 if (NULL != StringDesc) {\r
232 //\r
233 // Only get fisrt 32 characters, this is suggested by BBS spec\r
234 //\r
235 AsciiToUnicodeSize (StringDesc, 32, Temp);\r
236 Fmt = L"%s";\r
237 Type = Temp;\r
238 }\r
239\r
240 //\r
241 // BbsTable 16 entries are for onboard IDE.\r
242 // Set description string for SATA harddisks, Harddisk 0 ~ Harddisk 11\r
243 //\r
244 if (Index >= 5 && Index <= 16 && (CurBBSEntry->DeviceType == BBS_HARDDISK || CurBBSEntry->DeviceType == BBS_CDROM)) {\r
245 Fmt = L"%s %d";\r
246 UnicodeSPrint (BootString, BufSize, Fmt, Type, Index - 5);\r
247 } else {\r
248 UnicodeSPrint (BootString, BufSize, Fmt, Type);\r
249 }\r
250}\r
251\r
252/**\r
253\r
254 Create a legacy boot option for the specified entry of\r
255 BBS table, save it as variable, and append it to the boot\r
256 order list.\r
257\r
258\r
259 @param CurrentBbsEntry Pointer to current BBS table.\r
260 @param CurrentBbsDevPath Pointer to the Device Path Protocol instance of BBS\r
261 @param Index Index of the specified entry in BBS table.\r
262 @param BootOrderList On input, the original boot order list.\r
263 On output, the new boot order list attached with the\r
264 created node.\r
265 @param BootOrderListSize On input, the original size of boot order list.\r
266 On output, the size of new boot order list.\r
267\r
268 @retval EFI_SUCCESS Boot Option successfully created.\r
269 @retval EFI_OUT_OF_RESOURCES Fail to allocate necessary memory.\r
270 @retval Other Error occurs while setting variable.\r
271\r
272**/\r
273EFI_STATUS\r
274BdsCreateLegacyBootOption (\r
275 IN BBS_TABLE *CurrentBbsEntry,\r
276 IN EFI_DEVICE_PATH_PROTOCOL *CurrentBbsDevPath,\r
277 IN UINTN Index,\r
278 IN OUT UINT16 **BootOrderList,\r
279 IN OUT UINTN *BootOrderListSize\r
280 )\r
281{\r
282 EFI_STATUS Status;\r
283 UINT16 CurrentBootOptionNo;\r
284 UINT16 BootString[10];\r
285 CHAR16 BootDesc[100];\r
286 CHAR8 HelpString[100];\r
287 UINT16 *NewBootOrderList;\r
288 UINTN BufferSize;\r
289 UINTN StringLen;\r
290 VOID *Buffer;\r
291 UINT8 *Ptr;\r
292 UINT16 CurrentBbsDevPathSize;\r
293 UINTN BootOrderIndex;\r
294 UINTN BootOrderLastIndex;\r
295 UINTN ArrayIndex;\r
296 BOOLEAN IndexNotFound;\r
297 BBS_BBS_DEVICE_PATH *NewBbsDevPathNode;\r
298\r
299 if ((*BootOrderList) == NULL) {\r
300 CurrentBootOptionNo = 0;\r
301 } else {\r
302 for (ArrayIndex = 0; ArrayIndex < (UINTN) (*BootOrderListSize / sizeof (UINT16)); ArrayIndex++) {\r
303 IndexNotFound = TRUE;\r
304 for (BootOrderIndex = 0; BootOrderIndex < (UINTN) (*BootOrderListSize / sizeof (UINT16)); BootOrderIndex++) {\r
305 if ((*BootOrderList)[BootOrderIndex] == ArrayIndex) {\r
306 IndexNotFound = FALSE;\r
307 break;\r
308 }\r
309 }\r
310\r
311 if (!IndexNotFound) {\r
312 continue;\r
313 } else {\r
314 break;\r
315 }\r
316 }\r
317\r
318 CurrentBootOptionNo = (UINT16) ArrayIndex;\r
319 }\r
320\r
321 UnicodeSPrint (\r
322 BootString,\r
323 sizeof (BootString),\r
324 L"Boot%04x",\r
325 CurrentBootOptionNo\r
326 );\r
327\r
328 BdsBuildLegacyDevNameString (CurrentBbsEntry, Index, sizeof (BootDesc), BootDesc);\r
329\r
330 //\r
331 // Create new BBS device path node with description string\r
332 //\r
333 UnicodeStrToAsciiStr (BootDesc, HelpString);\r
334\r
335 StringLen = AsciiStrLen (HelpString);\r
336 NewBbsDevPathNode = AllocateZeroPool (sizeof (BBS_BBS_DEVICE_PATH) + StringLen);\r
337 if (NewBbsDevPathNode == NULL) {\r
338 return EFI_OUT_OF_RESOURCES;\r
339 }\r
340 CopyMem (NewBbsDevPathNode, CurrentBbsDevPath, sizeof (BBS_BBS_DEVICE_PATH));\r
341 CopyMem (NewBbsDevPathNode->String, HelpString, StringLen + 1);\r
342 SetDevicePathNodeLength (&(NewBbsDevPathNode->Header), sizeof (BBS_BBS_DEVICE_PATH) + StringLen);\r
343\r
344 //\r
345 // Create entire new CurrentBbsDevPath with end node\r
346 //\r
347 CurrentBbsDevPath = AppendDevicePathNode (\r
348 NULL,\r
349 (EFI_DEVICE_PATH_PROTOCOL *) NewBbsDevPathNode\r
350 );\r
351 if (CurrentBbsDevPath == NULL) {\r
352 FreePool (NewBbsDevPathNode);\r
353 return EFI_OUT_OF_RESOURCES;\r
354 }\r
355\r
356 CurrentBbsDevPathSize = (UINT16) (GetDevicePathSize (CurrentBbsDevPath));\r
357\r
358 BufferSize = sizeof (UINT32) +\r
359 sizeof (UINT16) +\r
360 StrSize (BootDesc) +\r
361 CurrentBbsDevPathSize +\r
362 sizeof (BBS_TABLE) +\r
363 sizeof (UINT16);\r
364\r
365 Buffer = AllocateZeroPool (BufferSize);\r
366 if (Buffer == NULL) {\r
367 FreePool (NewBbsDevPathNode);\r
368 FreePool (CurrentBbsDevPath);\r
369 return EFI_OUT_OF_RESOURCES;\r
370 }\r
371\r
372 Ptr = (UINT8 *) Buffer;\r
373\r
374 *((UINT32 *) Ptr) = LOAD_OPTION_ACTIVE;\r
375 Ptr += sizeof (UINT32);\r
376\r
377 *((UINT16 *) Ptr) = CurrentBbsDevPathSize;\r
378 Ptr += sizeof (UINT16);\r
379\r
380 CopyMem (\r
381 Ptr,\r
382 BootDesc,\r
383 StrSize (BootDesc)\r
384 );\r
385 Ptr += StrSize (BootDesc);\r
386\r
387 CopyMem (\r
388 Ptr,\r
389 CurrentBbsDevPath,\r
390 CurrentBbsDevPathSize\r
391 );\r
392 Ptr += CurrentBbsDevPathSize;\r
393\r
394 CopyMem (\r
395 Ptr,\r
396 CurrentBbsEntry,\r
397 sizeof (BBS_TABLE)\r
398 );\r
399\r
400 Ptr += sizeof (BBS_TABLE);\r
401 *((UINT16 *) Ptr) = (UINT16) Index;\r
402\r
403 Status = gRT->SetVariable (\r
404 BootString,\r
405 &gEfiGlobalVariableGuid,\r
406 EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r
407 BufferSize,\r
408 Buffer\r
409 );\r
5c08e117 410\r
16e5944a
RN
411 FreePool (Buffer);\r
412 \r
413 Buffer = NULL;\r
414\r
415 NewBootOrderList = AllocateZeroPool (*BootOrderListSize + sizeof (UINT16));\r
416 if (NULL == NewBootOrderList) {\r
417 FreePool (NewBbsDevPathNode);\r
418 FreePool (CurrentBbsDevPath);\r
419 return EFI_OUT_OF_RESOURCES;\r
420 }\r
421\r
422 if (*BootOrderList != NULL) {\r
423 CopyMem (NewBootOrderList, *BootOrderList, *BootOrderListSize);\r
424 FreePool (*BootOrderList);\r
425 }\r
426\r
427 BootOrderLastIndex = (UINTN) (*BootOrderListSize / sizeof (UINT16));\r
428 NewBootOrderList[BootOrderLastIndex] = CurrentBootOptionNo;\r
429 *BootOrderListSize += sizeof (UINT16);\r
430 *BootOrderList = NewBootOrderList;\r
431\r
432 FreePool (NewBbsDevPathNode);\r
433 FreePool (CurrentBbsDevPath);\r
434 return Status;\r
435}\r
436\r
437/**\r
438 Check if the boot option is a legacy one.\r
439\r
440 @param BootOptionVar The boot option data payload.\r
441 @param BbsEntry The BBS Table.\r
442 @param BbsIndex The table index.\r
443\r
444 @retval TRUE It is a legacy boot option.\r
445 @retval FALSE It is not a legacy boot option.\r
446\r
447**/\r
448BOOLEAN\r
449BdsIsLegacyBootOption (\r
450 IN UINT8 *BootOptionVar,\r
451 OUT BBS_TABLE **BbsEntry,\r
452 OUT UINT16 *BbsIndex\r
453 )\r
454{\r
455 UINT8 *Ptr;\r
456 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
457 BOOLEAN Ret;\r
458 UINT16 DevPathLen;\r
459\r
460 Ptr = BootOptionVar;\r
461 Ptr += sizeof (UINT32);\r
462 DevPathLen = *(UINT16 *) Ptr;\r
463 Ptr += sizeof (UINT16);\r
464 Ptr += StrSize ((UINT16 *) Ptr);\r
465 DevicePath = (EFI_DEVICE_PATH_PROTOCOL *) Ptr;\r
466 if ((BBS_DEVICE_PATH == DevicePath->Type) && (BBS_BBS_DP == DevicePath->SubType)) {\r
467 Ptr += DevPathLen;\r
468 *BbsEntry = (BBS_TABLE *) Ptr;\r
469 Ptr += sizeof (BBS_TABLE);\r
470 *BbsIndex = *(UINT16 *) Ptr;\r
471 Ret = TRUE;\r
472 } else {\r
473 *BbsEntry = NULL;\r
474 Ret = FALSE;\r
475 }\r
476\r
477 return Ret;\r
478}\r
479\r
480/**\r
481 Delete all the invalid legacy boot options.\r
482\r
483 @retval EFI_SUCCESS All invalide legacy boot options are deleted.\r
484 @retval EFI_OUT_OF_RESOURCES Fail to allocate necessary memory.\r
485 @retval EFI_NOT_FOUND Fail to retrive variable of boot order.\r
486**/\r
487EFI_STATUS\r
488EFIAPI\r
489BdsDeleteAllInvalidLegacyBootOptions (\r
490 VOID\r
491 )\r
492{\r
493 UINT16 *BootOrder;\r
494 UINT8 *BootOptionVar;\r
495 UINTN BootOrderSize;\r
496 UINTN BootOptionSize;\r
497 EFI_STATUS Status;\r
498 UINT16 HddCount;\r
499 UINT16 BbsCount;\r
500 HDD_INFO *LocalHddInfo;\r
501 BBS_TABLE *LocalBbsTable;\r
502 BBS_TABLE *BbsEntry;\r
503 UINT16 BbsIndex;\r
504 EFI_LEGACY_BIOS_PROTOCOL *LegacyBios;\r
505 UINTN Index;\r
506 UINT16 BootOption[10];\r
507 UINT16 BootDesc[100];\r
508 BOOLEAN DescStringMatch;\r
509\r
510 Status = EFI_SUCCESS;\r
511 BootOrder = NULL;\r
512 BootOrderSize = 0;\r
513 HddCount = 0;\r
514 BbsCount = 0;\r
515 LocalHddInfo = NULL;\r
516 LocalBbsTable = NULL;\r
517 BbsEntry = NULL;\r
518\r
519 Status = gBS->LocateProtocol (&gEfiLegacyBiosProtocolGuid, NULL, (VOID **) &LegacyBios);\r
520 if (EFI_ERROR (Status)) {\r
521 return Status;\r
522 }\r
523\r
16e5944a
RN
524 BootOrder = BdsLibGetVariableAndSize (\r
525 L"BootOrder",\r
526 &gEfiGlobalVariableGuid,\r
527 &BootOrderSize\r
528 );\r
529 if (BootOrder == NULL) {\r
1187b10f 530 return EFI_NOT_FOUND;\r
16e5944a
RN
531 }\r
532\r
1187b10f
RN
533 LegacyBios->GetBbsInfo (\r
534 LegacyBios,\r
535 &HddCount,\r
536 &LocalHddInfo,\r
537 &BbsCount,\r
538 &LocalBbsTable\r
539 );\r
540\r
16e5944a
RN
541 Index = 0;\r
542 while (Index < BootOrderSize / sizeof (UINT16)) {\r
543 UnicodeSPrint (BootOption, sizeof (BootOption), L"Boot%04x", BootOrder[Index]);\r
544 BootOptionVar = BdsLibGetVariableAndSize (\r
545 BootOption,\r
546 &gEfiGlobalVariableGuid,\r
547 &BootOptionSize\r
548 );\r
549 if (NULL == BootOptionVar) {\r
550 BootOptionSize = 0;\r
551 Status = gRT->GetVariable (\r
552 BootOption,\r
553 &gEfiGlobalVariableGuid,\r
554 NULL,\r
555 &BootOptionSize,\r
556 BootOptionVar\r
557 );\r
558 if (Status == EFI_NOT_FOUND) {\r
559 //\r
560 // Update BootOrder\r
561 //\r
562 BdsDeleteBootOption (\r
563 BootOrder[Index],\r
564 BootOrder,\r
565 &BootOrderSize\r
566 );\r
567 continue;\r
568 } else {\r
569 FreePool (BootOrder);\r
570 return EFI_OUT_OF_RESOURCES;\r
571 }\r
572 }\r
573 \r
574 //\r
575 // Skip Non-Legacy boot option\r
576 // \r
577 if (!BdsIsLegacyBootOption (BootOptionVar, &BbsEntry, &BbsIndex)) {\r
578 if (BootOptionVar!= NULL) {\r
579 FreePool (BootOptionVar);\r
580 }\r
581 Index++;\r
582 continue;\r
583 }\r
584\r
585 if (BbsIndex < BbsCount) {\r
586 //\r
587 // Check if BBS Description String is changed\r
588 //\r
589 DescStringMatch = FALSE;\r
590 BdsBuildLegacyDevNameString (\r
591 &LocalBbsTable[BbsIndex],\r
592 BbsIndex,\r
593 sizeof (BootDesc),\r
594 BootDesc\r
595 );\r
596\r
597 if (StrCmp (BootDesc, (UINT16*)(BootOptionVar + sizeof (UINT32) + sizeof (UINT16))) == 0) {\r
598 DescStringMatch = TRUE;\r
599 }\r
600\r
601 if (!((LocalBbsTable[BbsIndex].BootPriority == BBS_IGNORE_ENTRY) ||\r
602 (LocalBbsTable[BbsIndex].BootPriority == BBS_DO_NOT_BOOT_FROM)) &&\r
603 (LocalBbsTable[BbsIndex].DeviceType == BbsEntry->DeviceType) &&\r
604 DescStringMatch) {\r
605 Index++;\r
606 continue;\r
607 }\r
608 }\r
609\r
610 if (BootOptionVar != NULL) {\r
611 FreePool (BootOptionVar);\r
612 }\r
613 //\r
614 // should delete\r
615 //\r
616 BdsDeleteBootOption (\r
617 BootOrder[Index],\r
618 BootOrder,\r
619 &BootOrderSize\r
620 );\r
621 }\r
622\r
623 //\r
624 // Adjust the number of boot options.\r
625 //\r
626 Status = gRT->SetVariable (\r
627 L"BootOrder",\r
628 &gEfiGlobalVariableGuid,\r
629 EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r
630 BootOrderSize,\r
631 BootOrder\r
632 );\r
69fc8f08
RN
633 //\r
634 // Shrinking variable with existing variable implementation shouldn't fail.\r
635 //\r
636 ASSERT_EFI_ERROR (Status);\r
1187b10f 637 FreePool (BootOrder);\r
16e5944a
RN
638\r
639 return Status;\r
640}\r
641\r
642/**\r
643 Find all legacy boot option by device type.\r
644\r
645 @param BootOrder The boot order array.\r
646 @param BootOptionNum The number of boot option.\r
647 @param DevType Device type.\r
648 @param DevName Device name.\r
649 @param Attribute The boot option attribute.\r
650 @param BbsIndex The BBS table index.\r
651 @param OptionNumber The boot option index.\r
652\r
653 @retval TRUE The Legacy boot option is found.\r
654 @retval FALSE The legacy boot option is not found.\r
655\r
656**/\r
657BOOLEAN\r
658BdsFindLegacyBootOptionByDevTypeAndName (\r
659 IN UINT16 *BootOrder,\r
660 IN UINTN BootOptionNum,\r
661 IN UINT16 DevType,\r
662 IN CHAR16 *DevName,\r
663 OUT UINT32 *Attribute,\r
664 OUT UINT16 *BbsIndex,\r
665 OUT UINT16 *OptionNumber\r
666 )\r
667{\r
668 UINTN Index;\r
669 CHAR16 BootOption[9];\r
670 UINTN BootOptionSize;\r
671 UINT8 *BootOptionVar;\r
672 BBS_TABLE *BbsEntry;\r
673 BOOLEAN Found;\r
674\r
675 BbsEntry = NULL;\r
676 Found = FALSE;\r
677\r
678 if (NULL == BootOrder) {\r
679 return Found;\r
680 }\r
681\r
682 //\r
683 // Loop all boot option from variable\r
684 //\r
685 for (Index = 0; Index < BootOptionNum; Index++) {\r
686 UnicodeSPrint (BootOption, sizeof (BootOption), L"Boot%04x", (UINTN) BootOrder[Index]);\r
687 BootOptionVar = BdsLibGetVariableAndSize (\r
688 BootOption,\r
689 &gEfiGlobalVariableGuid,\r
690 &BootOptionSize\r
691 );\r
692 if (NULL == BootOptionVar) {\r
693 continue;\r
694 }\r
695\r
696 //\r
697 // Skip Non-legacy boot option\r
698 //\r
699 if (!BdsIsLegacyBootOption (BootOptionVar, &BbsEntry, BbsIndex)) {\r
700 FreePool (BootOptionVar);\r
701 continue;\r
702 }\r
703\r
704 if (\r
705 (BbsEntry->DeviceType != DevType) ||\r
706 (StrCmp (DevName, (CHAR16*)(BootOptionVar + sizeof (UINT32) + sizeof (UINT16))) != 0)\r
707 ) {\r
708 FreePool (BootOptionVar);\r
709 continue;\r
710 }\r
711\r
712 *Attribute = *(UINT32 *) BootOptionVar;\r
713 *OptionNumber = BootOrder[Index];\r
714 Found = TRUE;\r
715 FreePool (BootOptionVar);\r
716 break;\r
717 }\r
718\r
719 return Found;\r
720}\r
721\r
722/**\r
723 Create a legacy boot option.\r
724\r
725 @param BbsItem The BBS Table entry.\r
726 @param Index Index of the specified entry in BBS table.\r
727 @param BootOrderList The boot order list.\r
728 @param BootOrderListSize The size of boot order list.\r
729\r
730 @retval EFI_OUT_OF_RESOURCE No enough memory.\r
731 @retval EFI_SUCCESS The function complete successfully.\r
732 @return Other value if the legacy boot option is not created.\r
733\r
734**/\r
735EFI_STATUS\r
736BdsCreateOneLegacyBootOption (\r
737 IN BBS_TABLE *BbsItem,\r
738 IN UINTN Index,\r
739 IN OUT UINT16 **BootOrderList,\r
740 IN OUT UINTN *BootOrderListSize\r
741 )\r
742{\r
743 BBS_BBS_DEVICE_PATH BbsDevPathNode;\r
744 EFI_STATUS Status;\r
745 EFI_DEVICE_PATH_PROTOCOL *DevPath;\r
746\r
747 DevPath = NULL;\r
748\r
749 //\r
750 // Create device path node.\r
751 //\r
752 BbsDevPathNode.Header.Type = BBS_DEVICE_PATH;\r
753 BbsDevPathNode.Header.SubType = BBS_BBS_DP;\r
754 SetDevicePathNodeLength (&BbsDevPathNode.Header, sizeof (BBS_BBS_DEVICE_PATH));\r
755 BbsDevPathNode.DeviceType = BbsItem->DeviceType;\r
756 CopyMem (&BbsDevPathNode.StatusFlag, &BbsItem->StatusFlags, sizeof (UINT16));\r
757\r
758 DevPath = AppendDevicePathNode (\r
759 NULL,\r
760 (EFI_DEVICE_PATH_PROTOCOL *) &BbsDevPathNode\r
761 );\r
762 if (NULL == DevPath) {\r
763 return EFI_OUT_OF_RESOURCES;\r
764 }\r
765\r
766 Status = BdsCreateLegacyBootOption (\r
767 BbsItem,\r
768 DevPath,\r
769 Index,\r
770 BootOrderList,\r
771 BootOrderListSize\r
772 );\r
773 BbsItem->BootPriority = 0x00;\r
774\r
775 FreePool (DevPath);\r
776\r
777 return Status;\r
778}\r
779\r
780/**\r
781 Add the legacy boot options from BBS table if they do not exist.\r
782\r
783 @retval EFI_SUCCESS The boot options are added successfully \r
784 or they are already in boot options.\r
785 @retval EFI_NOT_FOUND No legacy boot options is found.\r
786 @retval EFI_OUT_OF_RESOURCE No enough memory.\r
787 @return Other value LegacyBoot options are not added.\r
788**/\r
789EFI_STATUS\r
790EFIAPI\r
791BdsAddNonExistingLegacyBootOptions (\r
792 VOID\r
793 )\r
794{\r
795 UINT16 *BootOrder;\r
796 UINTN BootOrderSize;\r
797 EFI_STATUS Status;\r
798 CHAR16 Desc[100];\r
799 UINT16 HddCount;\r
800 UINT16 BbsCount;\r
801 HDD_INFO *LocalHddInfo;\r
802 BBS_TABLE *LocalBbsTable;\r
803 UINT16 BbsIndex;\r
804 EFI_LEGACY_BIOS_PROTOCOL *LegacyBios;\r
805 UINT16 Index;\r
806 UINT32 Attribute;\r
807 UINT16 OptionNumber;\r
808 BOOLEAN Exist;\r
809\r
810 HddCount = 0;\r
811 BbsCount = 0;\r
812 LocalHddInfo = NULL;\r
813 LocalBbsTable = NULL;\r
814\r
815 Status = gBS->LocateProtocol (&gEfiLegacyBiosProtocolGuid, NULL, (VOID **) &LegacyBios);\r
816 if (EFI_ERROR (Status)) {\r
817 return Status;\r
818 }\r
819\r
820 LegacyBios->GetBbsInfo (\r
821 LegacyBios,\r
822 &HddCount,\r
823 &LocalHddInfo,\r
824 &BbsCount,\r
825 &LocalBbsTable\r
826 );\r
827\r
828 BootOrder = BdsLibGetVariableAndSize (\r
829 L"BootOrder",\r
830 &gEfiGlobalVariableGuid,\r
831 &BootOrderSize\r
832 );\r
833 if (BootOrder == NULL) {\r
834 BootOrderSize = 0;\r
835 }\r
836\r
837 for (Index = 0; Index < BbsCount; Index++) {\r
838 if ((LocalBbsTable[Index].BootPriority == BBS_IGNORE_ENTRY) ||\r
839 (LocalBbsTable[Index].BootPriority == BBS_DO_NOT_BOOT_FROM)\r
840 ) {\r
841 continue;\r
842 }\r
843\r
844 BdsBuildLegacyDevNameString (&LocalBbsTable[Index], Index, sizeof (Desc), Desc);\r
845\r
846 Exist = BdsFindLegacyBootOptionByDevTypeAndName (\r
847 BootOrder,\r
848 BootOrderSize / sizeof (UINT16),\r
849 LocalBbsTable[Index].DeviceType,\r
850 Desc,\r
851 &Attribute,\r
852 &BbsIndex,\r
853 &OptionNumber\r
854 );\r
855 if (!Exist) {\r
856 //\r
857 // Not found such type of legacy device in boot options or we found but it's disabled\r
858 // so we have to create one and put it to the tail of boot order list\r
859 //\r
860 Status = BdsCreateOneLegacyBootOption (\r
861 &LocalBbsTable[Index],\r
862 Index,\r
863 &BootOrder,\r
864 &BootOrderSize\r
865 );\r
69fc8f08 866 if (!EFI_ERROR (Status)) {\r
45295cf5 867 ASSERT (BootOrder != NULL);\r
69fc8f08
RN
868 BbsIndex = Index;\r
869 OptionNumber = BootOrder[BootOrderSize / sizeof (UINT16) - 1];\r
16e5944a 870 }\r
16e5944a
RN
871 }\r
872\r
873 ASSERT (BbsIndex == Index);\r
874 }\r
875\r
876 Status = gRT->SetVariable (\r
877 L"BootOrder",\r
878 &gEfiGlobalVariableGuid,\r
879 EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r
880 BootOrderSize,\r
881 BootOrder\r
882 );\r
883 if (BootOrder != NULL) {\r
884 FreePool (BootOrder);\r
885 }\r
886\r
887 return Status;\r
888}\r
889\r
890/**\r
891 Fill the device order buffer.\r
892\r
893 @param BbsTable The BBS table.\r
894 @param BbsType The BBS Type.\r
895 @param BbsCount The BBS Count.\r
896 @param Buf device order buffer.\r
897\r
898 @return The device order buffer.\r
899\r
900**/\r
901UINT16 *\r
902BdsFillDevOrderBuf (\r
903 IN BBS_TABLE *BbsTable,\r
904 IN BBS_TYPE BbsType,\r
905 IN UINTN BbsCount,\r
906 OUT UINT16 *Buf\r
907 )\r
908{\r
909 UINTN Index;\r
910\r
911 for (Index = 0; Index < BbsCount; Index++) {\r
912 if (BbsTable[Index].BootPriority == BBS_IGNORE_ENTRY) {\r
913 continue;\r
914 }\r
915\r
916 if (BbsTable[Index].DeviceType != BbsType) {\r
917 continue;\r
918 }\r
919\r
920 *Buf = (UINT16) (Index & 0xFF);\r
921 Buf++;\r
922 }\r
923\r
924 return Buf;\r
925}\r
926\r
927/**\r
928 Create the device order buffer.\r
929\r
930 @param BbsTable The BBS table.\r
931 @param BbsCount The BBS Count.\r
932\r
933 @retval EFI_SUCCES The buffer is created and the EFI variable named \r
934 VAR_LEGACY_DEV_ORDER and gEfiLegacyDevOrderVariableGuid is\r
935 set correctly.\r
936 @retval EFI_OUT_OF_RESOURCES Memmory or storage is not enough.\r
937 @retval EFI_DEVICE_ERROR Fail to add the device order into EFI variable fail\r
938 because of hardware error.\r
939**/\r
940EFI_STATUS\r
941BdsCreateDevOrder (\r
942 IN BBS_TABLE *BbsTable,\r
943 IN UINT16 BbsCount\r
944 )\r
945{\r
946 UINTN Index;\r
947 UINTN FDCount;\r
948 UINTN HDCount;\r
949 UINTN CDCount;\r
950 UINTN NETCount;\r
951 UINTN BEVCount;\r
952 UINTN TotalSize;\r
953 UINTN HeaderSize;\r
954 LEGACY_DEV_ORDER_ENTRY *DevOrder;\r
955 LEGACY_DEV_ORDER_ENTRY *DevOrderPtr;\r
956 EFI_STATUS Status;\r
957\r
958 FDCount = 0;\r
959 HDCount = 0;\r
960 CDCount = 0;\r
961 NETCount = 0;\r
962 BEVCount = 0;\r
963 TotalSize = 0;\r
964 HeaderSize = sizeof (BBS_TYPE) + sizeof (UINT16);\r
965 DevOrder = NULL;\r
966 Status = EFI_SUCCESS;\r
967\r
968 //\r
969 // Count all boot devices\r
970 //\r
971 for (Index = 0; Index < BbsCount; Index++) {\r
972 if (BbsTable[Index].BootPriority == BBS_IGNORE_ENTRY) {\r
973 continue;\r
974 }\r
975\r
976 switch (BbsTable[Index].DeviceType) {\r
977 case BBS_FLOPPY:\r
978 FDCount++;\r
979 break;\r
980\r
981 case BBS_HARDDISK:\r
982 HDCount++;\r
983 break;\r
984\r
985 case BBS_CDROM:\r
986 CDCount++;\r
987 break;\r
988\r
989 case BBS_EMBED_NETWORK:\r
990 NETCount++;\r
991 break;\r
992\r
993 case BBS_BEV_DEVICE:\r
994 BEVCount++;\r
995 break;\r
996\r
997 default:\r
998 break;\r
999 }\r
1000 }\r
1001\r
1002 TotalSize += (HeaderSize + sizeof (UINT16) * FDCount);\r
1003 TotalSize += (HeaderSize + sizeof (UINT16) * HDCount);\r
1004 TotalSize += (HeaderSize + sizeof (UINT16) * CDCount);\r
1005 TotalSize += (HeaderSize + sizeof (UINT16) * NETCount);\r
1006 TotalSize += (HeaderSize + sizeof (UINT16) * BEVCount);\r
1007\r
1008 //\r
1009 // Create buffer to hold all boot device order\r
1010 //\r
1011 DevOrder = AllocateZeroPool (TotalSize);\r
1012 if (NULL == DevOrder) {\r
1013 return EFI_OUT_OF_RESOURCES;\r
1014 }\r
1015 DevOrderPtr = DevOrder;\r
1016\r
1017 DevOrderPtr->BbsType = BBS_FLOPPY;\r
1018 DevOrderPtr->Length = (UINT16) (sizeof (DevOrderPtr->Length) + FDCount * sizeof (UINT16));\r
1019 DevOrderPtr = (LEGACY_DEV_ORDER_ENTRY *) BdsFillDevOrderBuf (BbsTable, BBS_FLOPPY, BbsCount, DevOrderPtr->Data);\r
1020\r
1021 DevOrderPtr->BbsType = BBS_HARDDISK;\r
1022 DevOrderPtr->Length = (UINT16) (sizeof (UINT16) + HDCount * sizeof (UINT16));\r
1023 DevOrderPtr = (LEGACY_DEV_ORDER_ENTRY *) BdsFillDevOrderBuf (BbsTable, BBS_HARDDISK, BbsCount, DevOrderPtr->Data);\r
1024 \r
1025 DevOrderPtr->BbsType = BBS_CDROM;\r
1026 DevOrderPtr->Length = (UINT16) (sizeof (UINT16) + CDCount * sizeof (UINT16));\r
1027 DevOrderPtr = (LEGACY_DEV_ORDER_ENTRY *) BdsFillDevOrderBuf (BbsTable, BBS_CDROM, BbsCount, DevOrderPtr->Data);\r
1028 \r
1029 DevOrderPtr->BbsType = BBS_EMBED_NETWORK;\r
1030 DevOrderPtr->Length = (UINT16) (sizeof (UINT16) + NETCount * sizeof (UINT16));\r
1031 DevOrderPtr = (LEGACY_DEV_ORDER_ENTRY *) BdsFillDevOrderBuf (BbsTable, BBS_EMBED_NETWORK, BbsCount, DevOrderPtr->Data);\r
1032\r
1033 DevOrderPtr->BbsType = BBS_BEV_DEVICE;\r
1034 DevOrderPtr->Length = (UINT16) (sizeof (UINT16) + BEVCount * sizeof (UINT16));\r
1035 DevOrderPtr = (LEGACY_DEV_ORDER_ENTRY *) BdsFillDevOrderBuf (BbsTable, BBS_BEV_DEVICE, BbsCount, DevOrderPtr->Data);\r
1036\r
1037 ASSERT (TotalSize == (UINTN) ((UINT8 *) DevOrderPtr - (UINT8 *) DevOrder));\r
1038\r
1039 //\r
1040 // Save device order for legacy boot device to variable.\r
1041 //\r
1042 Status = gRT->SetVariable (\r
1043 VAR_LEGACY_DEV_ORDER,\r
1044 &gEfiLegacyDevOrderVariableGuid,\r
1045 EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r
1046 TotalSize,\r
1047 DevOrder\r
1048 );\r
1049 FreePool (DevOrder);\r
1050\r
1051 return Status;\r
1052}\r
1053\r
1054/**\r
1055 Add the legacy boot devices from BBS table into \r
1056 the legacy device boot order.\r
1057\r
1058 @retval EFI_SUCCESS The boot devices are added successfully.\r
1059 @retval EFI_NOT_FOUND The legacy boot devices are not found.\r
1060 @retval EFI_OUT_OF_RESOURCES Memmory or storage is not enough.\r
1061 @retval EFI_DEVICE_ERROR Fail to add the legacy device boot order into EFI variable\r
1062 because of hardware error.\r
1063**/\r
1064EFI_STATUS\r
1065EFIAPI\r
1066BdsUpdateLegacyDevOrder (\r
1067 VOID\r
1068 )\r
1069{\r
1070 LEGACY_DEV_ORDER_ENTRY *DevOrder;\r
1071 LEGACY_DEV_ORDER_ENTRY *NewDevOrder;\r
1072 LEGACY_DEV_ORDER_ENTRY *Ptr;\r
1073 LEGACY_DEV_ORDER_ENTRY *NewPtr;\r
1074 UINTN DevOrderSize;\r
1075 EFI_LEGACY_BIOS_PROTOCOL *LegacyBios;\r
1076 EFI_STATUS Status;\r
1077 UINT16 HddCount;\r
1078 UINT16 BbsCount;\r
1079 HDD_INFO *LocalHddInfo;\r
1080 BBS_TABLE *LocalBbsTable;\r
1081 UINTN Index;\r
1082 UINTN Index2;\r
1083 UINTN *Idx;\r
1084 UINTN FDCount;\r
1085 UINTN HDCount;\r
1086 UINTN CDCount;\r
1087 UINTN NETCount;\r
1088 UINTN BEVCount;\r
1089 UINTN TotalSize;\r
1090 UINTN HeaderSize;\r
1091 UINT16 *NewFDPtr;\r
1092 UINT16 *NewHDPtr;\r
1093 UINT16 *NewCDPtr;\r
1094 UINT16 *NewNETPtr;\r
1095 UINT16 *NewBEVPtr;\r
1096 UINT16 *NewDevPtr;\r
1097 UINTN FDIndex;\r
1098 UINTN HDIndex;\r
1099 UINTN CDIndex;\r
1100 UINTN NETIndex;\r
1101 UINTN BEVIndex;\r
1102\r
1103 Idx = NULL;\r
1104 FDCount = 0;\r
1105 HDCount = 0;\r
1106 CDCount = 0;\r
1107 NETCount = 0;\r
1108 BEVCount = 0;\r
1109 TotalSize = 0;\r
1110 HeaderSize = sizeof (BBS_TYPE) + sizeof (UINT16);\r
1111 FDIndex = 0;\r
1112 HDIndex = 0;\r
1113 CDIndex = 0;\r
1114 NETIndex = 0;\r
1115 BEVIndex = 0;\r
1116 NewDevPtr = NULL;\r
1117\r
1118 Status = gBS->LocateProtocol (&gEfiLegacyBiosProtocolGuid, NULL, (VOID **) &LegacyBios);\r
1119 if (EFI_ERROR (Status)) {\r
1120 return Status;\r
1121 }\r
1122\r
1123 Status = LegacyBios->GetBbsInfo (\r
1124 LegacyBios,\r
1125 &HddCount,\r
1126 &LocalHddInfo,\r
1127 &BbsCount,\r
1128 &LocalBbsTable\r
1129 );\r
1130 if (EFI_ERROR (Status)) {\r
1131 return Status;\r
1132 }\r
1133\r
1134 DevOrder = BdsLibGetVariableAndSize (\r
1135 VAR_LEGACY_DEV_ORDER,\r
1136 &gEfiLegacyDevOrderVariableGuid,\r
1137 &DevOrderSize\r
1138 );\r
1139 if (NULL == DevOrder) {\r
1140 return BdsCreateDevOrder (LocalBbsTable, BbsCount);\r
1141 }\r
1142 //\r
1143 // First we figure out how many boot devices with same device type respectively\r
1144 //\r
1145 for (Index = 0; Index < BbsCount; Index++) {\r
1146 if ((LocalBbsTable[Index].BootPriority == BBS_IGNORE_ENTRY) ||\r
1147 (LocalBbsTable[Index].BootPriority == BBS_DO_NOT_BOOT_FROM)\r
1148 ) {\r
1149 continue;\r
1150 }\r
1151\r
1152 switch (LocalBbsTable[Index].DeviceType) {\r
1153 case BBS_FLOPPY:\r
1154 FDCount++;\r
1155 break;\r
1156\r
1157 case BBS_HARDDISK:\r
1158 HDCount++;\r
1159 break;\r
1160\r
1161 case BBS_CDROM:\r
1162 CDCount++;\r
1163 break;\r
1164\r
1165 case BBS_EMBED_NETWORK:\r
1166 NETCount++;\r
1167 break;\r
1168\r
1169 case BBS_BEV_DEVICE:\r
1170 BEVCount++;\r
1171 break;\r
1172\r
1173 default:\r
1174 break;\r
1175 }\r
1176 }\r
1177\r
1178 TotalSize += (HeaderSize + FDCount * sizeof (UINT16));\r
1179 TotalSize += (HeaderSize + HDCount * sizeof (UINT16));\r
1180 TotalSize += (HeaderSize + CDCount * sizeof (UINT16));\r
1181 TotalSize += (HeaderSize + NETCount * sizeof (UINT16));\r
1182 TotalSize += (HeaderSize + BEVCount * sizeof (UINT16));\r
1183\r
1184 NewDevOrder = AllocateZeroPool (TotalSize);\r
1185 if (NULL == NewDevOrder) {\r
1186 return EFI_OUT_OF_RESOURCES;\r
1187 }\r
1188\r
1189\r
1190\r
1191 //\r
1192 // copy FD\r
1193 //\r
1194 Ptr = DevOrder;\r
1195 NewPtr = NewDevOrder;\r
1196 NewPtr->BbsType = Ptr->BbsType;\r
1197 NewPtr->Length = (UINT16) (sizeof (UINT16) + FDCount * sizeof (UINT16));\r
1198 for (Index = 0; Index < Ptr->Length / sizeof (UINT16) - 1; Index++) {\r
1199 if (LocalBbsTable[Ptr->Data[Index] & 0xFF].BootPriority == BBS_IGNORE_ENTRY ||\r
1200 LocalBbsTable[Ptr->Data[Index] & 0xFF].BootPriority == BBS_DO_NOT_BOOT_FROM ||\r
1201 LocalBbsTable[Ptr->Data[Index] & 0xFF].DeviceType != BBS_FLOPPY\r
1202 ) {\r
1203 continue;\r
1204 }\r
1205\r
1206 NewPtr->Data[FDIndex] = Ptr->Data[Index];\r
1207 FDIndex++;\r
1208 }\r
1209 NewFDPtr = NewPtr->Data;\r
1210\r
1211 //\r
1212 // copy HD\r
1213 //\r
1214 Ptr = (LEGACY_DEV_ORDER_ENTRY *) (&Ptr->Data[Ptr->Length / sizeof (UINT16) - 1]);\r
1215 NewPtr = (LEGACY_DEV_ORDER_ENTRY *) (&NewPtr->Data[NewPtr->Length / sizeof (UINT16) -1]);\r
1216 NewPtr->BbsType = Ptr->BbsType;\r
1217 NewPtr->Length = (UINT16) (sizeof (UINT16) + HDCount * sizeof (UINT16));\r
1218 for (Index = 0; Index < Ptr->Length / sizeof (UINT16) - 1; Index++) {\r
1219 if (LocalBbsTable[Ptr->Data[Index] & 0xFF].BootPriority == BBS_IGNORE_ENTRY ||\r
1220 LocalBbsTable[Ptr->Data[Index] & 0xFF].BootPriority == BBS_DO_NOT_BOOT_FROM ||\r
1221 LocalBbsTable[Ptr->Data[Index] & 0xFF].BootPriority == BBS_LOWEST_PRIORITY ||\r
1222 LocalBbsTable[Ptr->Data[Index] & 0xFF].DeviceType != BBS_HARDDISK\r
1223 ) {\r
1224 continue;\r
1225 }\r
1226\r
1227 NewPtr->Data[HDIndex] = Ptr->Data[Index];\r
1228 HDIndex++;\r
1229 }\r
1230 NewHDPtr = NewPtr->Data;\r
1231\r
1232 //\r
1233 // copy CD\r
1234 //\r
1235 Ptr = (LEGACY_DEV_ORDER_ENTRY *) (&Ptr->Data[Ptr->Length / sizeof (UINT16) - 1]);\r
1236 NewPtr = (LEGACY_DEV_ORDER_ENTRY *) (&NewPtr->Data[NewPtr->Length / sizeof (UINT16) -1]);\r
1237 NewPtr->BbsType = Ptr->BbsType;\r
1238 NewPtr->Length = (UINT16) (sizeof (UINT16) + CDCount * sizeof (UINT16));\r
1239 for (Index = 0; Index < Ptr->Length / sizeof (UINT16) - 1; Index++) {\r
1240 if (LocalBbsTable[Ptr->Data[Index] & 0xFF].BootPriority == BBS_IGNORE_ENTRY ||\r
1241 LocalBbsTable[Ptr->Data[Index] & 0xFF].BootPriority == BBS_DO_NOT_BOOT_FROM ||\r
1242 LocalBbsTable[Ptr->Data[Index] & 0xFF].BootPriority == BBS_LOWEST_PRIORITY ||\r
1243 LocalBbsTable[Ptr->Data[Index] & 0xFF].DeviceType != BBS_CDROM\r
1244 ) {\r
1245 continue;\r
1246 }\r
1247\r
1248 NewPtr->Data[CDIndex] = Ptr->Data[Index];\r
1249 CDIndex++;\r
1250 }\r
1251 NewCDPtr = NewPtr->Data;\r
1252\r
1253 //\r
1254 // copy NET\r
1255 //\r
1256 Ptr = (LEGACY_DEV_ORDER_ENTRY *) (&Ptr->Data[Ptr->Length / sizeof (UINT16) - 1]);\r
1257 NewPtr = (LEGACY_DEV_ORDER_ENTRY *) (&NewPtr->Data[NewPtr->Length / sizeof (UINT16) -1]);\r
1258 NewPtr->BbsType = Ptr->BbsType;\r
1259 NewPtr->Length = (UINT16) (sizeof (UINT16) + NETCount * sizeof (UINT16));\r
1260 for (Index = 0; Index < Ptr->Length / sizeof (UINT16) - 1; Index++) {\r
1261 if (LocalBbsTable[Ptr->Data[Index] & 0xFF].BootPriority == BBS_IGNORE_ENTRY ||\r
1262 LocalBbsTable[Ptr->Data[Index] & 0xFF].BootPriority == BBS_DO_NOT_BOOT_FROM ||\r
1263 LocalBbsTable[Ptr->Data[Index] & 0xFF].BootPriority == BBS_LOWEST_PRIORITY ||\r
1264 LocalBbsTable[Ptr->Data[Index] & 0xFF].DeviceType != BBS_EMBED_NETWORK\r
1265 ) {\r
1266 continue;\r
1267 }\r
1268\r
1269 NewPtr->Data[NETIndex] = Ptr->Data[Index];\r
1270 NETIndex++;\r
1271 }\r
1272 NewNETPtr = NewPtr->Data;\r
1273 \r
1274 //\r
1275 // copy BEV\r
1276 //\r
1277 Ptr = (LEGACY_DEV_ORDER_ENTRY *) (&Ptr->Data[Ptr->Length / sizeof (UINT16) - 1]);\r
1278 NewPtr = (LEGACY_DEV_ORDER_ENTRY *) (&NewPtr->Data[NewPtr->Length / sizeof (UINT16) -1]);\r
1279 NewPtr->BbsType = Ptr->BbsType;\r
1280 NewPtr->Length = (UINT16) (sizeof (UINT16) + BEVCount * sizeof (UINT16));\r
1281 for (Index = 0; Index < Ptr->Length / sizeof (UINT16) - 1; Index++) {\r
1282 if (LocalBbsTable[Ptr->Data[Index] & 0xFF].BootPriority == BBS_IGNORE_ENTRY ||\r
1283 LocalBbsTable[Ptr->Data[Index] & 0xFF].BootPriority == BBS_DO_NOT_BOOT_FROM ||\r
1284 LocalBbsTable[Ptr->Data[Index] & 0xFF].BootPriority == BBS_LOWEST_PRIORITY ||\r
1285 LocalBbsTable[Ptr->Data[Index] & 0xFF].DeviceType != BBS_BEV_DEVICE\r
1286 ) {\r
1287 continue;\r
1288 }\r
1289\r
1290 NewPtr->Data[BEVIndex] = Ptr->Data[Index];\r
1291 BEVIndex++;\r
1292 }\r
1293 NewBEVPtr = NewPtr->Data;\r
1294\r
1295 for (Index = 0; Index < BbsCount; Index++) {\r
1296 if ((LocalBbsTable[Index].BootPriority == BBS_IGNORE_ENTRY) ||\r
1297 (LocalBbsTable[Index].BootPriority == BBS_DO_NOT_BOOT_FROM)\r
1298 ) {\r
1299 continue;\r
1300 }\r
1301\r
1302 switch (LocalBbsTable[Index].DeviceType) {\r
1303 case BBS_FLOPPY:\r
1304 Idx = &FDIndex;\r
1305 NewDevPtr = NewFDPtr;\r
1306 break;\r
1307\r
1308 case BBS_HARDDISK:\r
1309 Idx = &HDIndex;\r
1310 NewDevPtr = NewHDPtr;\r
1311 break;\r
1312\r
1313 case BBS_CDROM:\r
1314 Idx = &CDIndex;\r
1315 NewDevPtr = NewCDPtr;\r
1316 break;\r
1317\r
1318 case BBS_EMBED_NETWORK:\r
1319 Idx = &NETIndex;\r
1320 NewDevPtr = NewNETPtr;\r
1321 break;\r
1322\r
1323 case BBS_BEV_DEVICE:\r
1324 Idx = &BEVIndex;\r
1325 NewDevPtr = NewBEVPtr;\r
1326 break;\r
1327\r
1328 default:\r
1329 Idx = NULL;\r
1330 break;\r
1331 }\r
1332 //\r
1333 // at this point we have copied those valid indexes to new buffer\r
1334 // and we should check if there is any new appeared boot device\r
1335 //\r
1336 if (Idx != NULL) {\r
1337 for (Index2 = 0; Index2 < *Idx; Index2++) {\r
1338 if ((NewDevPtr[Index2] & 0xFF) == (UINT16) Index) {\r
1339 break;\r
1340 }\r
1341 }\r
1342\r
1343 if (Index2 == *Idx) {\r
1344 //\r
1345 // Index2 == *Idx means we didn't find Index\r
1346 // so Index is a new appeared device's index in BBS table\r
1347 // insert it before disabled indexes.\r
1348 //\r
1349 for (Index2 = 0; Index2 < *Idx; Index2++) {\r
1350 if ((NewDevPtr[Index2] & 0xFF00) == 0xFF00) {\r
1351 break;\r
1352 }\r
1353 }\r
1354 CopyMem (&NewDevPtr[Index2 + 1], &NewDevPtr[Index2], (*Idx - Index2) * sizeof (UINT16));\r
1355 NewDevPtr[Index2] = (UINT16) (Index & 0xFF);\r
1356 (*Idx)++;\r
1357 }\r
1358 }\r
1359 }\r
1360\r
1361 FreePool (DevOrder);\r
1362\r
1363 Status = gRT->SetVariable (\r
1364 VAR_LEGACY_DEV_ORDER,\r
1365 &gEfiLegacyDevOrderVariableGuid,\r
1366 EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r
1367 TotalSize,\r
1368 NewDevOrder\r
1369 );\r
1370 FreePool (NewDevOrder);\r
1371\r
1372 return Status;\r
1373}\r
1374\r
1375/**\r
1376 Set Boot Priority for specified device type.\r
1377\r
1378 @param DeviceType The device type.\r
1379 @param BbsIndex The BBS index to set the highest priority. Ignore when -1.\r
1380 @param LocalBbsTable The BBS table.\r
1381 @param Priority The prority table.\r
1382\r
1383 @retval EFI_SUCCESS The function completes successfully.\r
1384 @retval EFI_NOT_FOUND Failed to find device.\r
1385 @retval EFI_OUT_OF_RESOURCES Failed to get the efi variable of device order.\r
1386\r
1387**/\r
1388EFI_STATUS\r
1389BdsSetBootPriority4SameTypeDev (\r
1390 IN UINT16 DeviceType,\r
1391 IN UINTN BbsIndex,\r
1392 IN OUT BBS_TABLE *LocalBbsTable,\r
1393 IN OUT UINT16 *Priority\r
1394 )\r
1395{\r
1396 LEGACY_DEV_ORDER_ENTRY *DevOrder;\r
1397 LEGACY_DEV_ORDER_ENTRY *DevOrderPtr;\r
1398 UINTN DevOrderSize;\r
1399 UINTN Index;\r
1400\r
1401 DevOrder = BdsLibGetVariableAndSize (\r
1402 VAR_LEGACY_DEV_ORDER,\r
1403 &gEfiLegacyDevOrderVariableGuid,\r
1404 &DevOrderSize\r
1405 );\r
1406 if (NULL == DevOrder) {\r
1407 return EFI_OUT_OF_RESOURCES;\r
1408 }\r
1409\r
1410 DevOrderPtr = DevOrder;\r
1411 while ((UINT8 *) DevOrderPtr < (UINT8 *) DevOrder + DevOrderSize) {\r
1412 if (DevOrderPtr->BbsType == DeviceType) {\r
1413 break;\r
1414 }\r
1415\r
1416 DevOrderPtr = (LEGACY_DEV_ORDER_ENTRY *) ((UINT8 *) DevOrderPtr + sizeof (BBS_TYPE) + DevOrderPtr->Length);\r
1417 }\r
1418\r
1419 if ((UINT8 *) DevOrderPtr >= (UINT8 *) DevOrder + DevOrderSize) {\r
1420 FreePool (DevOrder);\r
1421 return EFI_NOT_FOUND;\r
1422 }\r
1423\r
1424 if (BbsIndex != (UINTN) -1) {\r
1425 LocalBbsTable[BbsIndex].BootPriority = *Priority;\r
1426 (*Priority)++;\r
1427 }\r
1428 //\r
1429 // If the high byte of the DevIndex is 0xFF, it indicates that this device has been disabled.\r
1430 //\r
1431 for (Index = 0; Index < DevOrderPtr->Length / sizeof (UINT16) - 1; Index++) {\r
1432 if ((DevOrderPtr->Data[Index] & 0xFF00) == 0xFF00) {\r
1433 //\r
1434 // LocalBbsTable[DevIndex[Index] & 0xFF].BootPriority = BBS_DISABLED_ENTRY;\r
1435 //\r
1436 } else if (DevOrderPtr->Data[Index] != BbsIndex) {\r
1437 LocalBbsTable[DevOrderPtr->Data[Index]].BootPriority = *Priority;\r
1438 (*Priority)++;\r
1439 }\r
1440 }\r
1441\r
1442 FreePool (DevOrder);\r
1443 return EFI_SUCCESS;\r
1444}\r
1445\r
1446/**\r
1447 Print the BBS Table.\r
1448\r
1449 @param LocalBbsTable The BBS table.\r
1450 @param BbsCount The count of entry in BBS table.\r
1451**/\r
1452VOID\r
1453PrintBbsTable (\r
1454 IN BBS_TABLE *LocalBbsTable,\r
1455 IN UINT16 BbsCount\r
1456 )\r
1457{\r
1458 UINT16 Idx;\r
1459\r
1460 DEBUG ((DEBUG_ERROR, "\n"));\r
1461 DEBUG ((DEBUG_ERROR, " NO Prio bb/dd/ff cl/sc Type Stat segm:offs\n"));\r
1462 DEBUG ((DEBUG_ERROR, "=============================================\n"));\r
1463 for (Idx = 0; Idx < BbsCount; Idx++) {\r
1464 if ((LocalBbsTable[Idx].BootPriority == BBS_IGNORE_ENTRY) ||\r
1465 (LocalBbsTable[Idx].BootPriority == BBS_DO_NOT_BOOT_FROM) ||\r
1466 (LocalBbsTable[Idx].BootPriority == BBS_LOWEST_PRIORITY)\r
1467 ) {\r
1468 continue;\r
1469 }\r
1470\r
1471 DEBUG (\r
1472 (DEBUG_ERROR,\r
1473 " %02x: %04x %02x/%02x/%02x %02x/%02x %04x %04x %04x:%04x\n",\r
1474 (UINTN) Idx,\r
1475 (UINTN) LocalBbsTable[Idx].BootPriority,\r
1476 (UINTN) LocalBbsTable[Idx].Bus,\r
1477 (UINTN) LocalBbsTable[Idx].Device,\r
1478 (UINTN) LocalBbsTable[Idx].Function,\r
1479 (UINTN) LocalBbsTable[Idx].Class,\r
1480 (UINTN) LocalBbsTable[Idx].SubClass,\r
1481 (UINTN) LocalBbsTable[Idx].DeviceType,\r
1482 (UINTN) * (UINT16 *) &LocalBbsTable[Idx].StatusFlags,\r
1483 (UINTN) LocalBbsTable[Idx].BootHandlerSegment,\r
1484 (UINTN) LocalBbsTable[Idx].BootHandlerOffset,\r
1485 (UINTN) ((LocalBbsTable[Idx].MfgStringSegment << 4) + LocalBbsTable[Idx].MfgStringOffset),\r
1486 (UINTN) ((LocalBbsTable[Idx].DescStringSegment << 4) + LocalBbsTable[Idx].DescStringOffset))\r
1487 );\r
1488 }\r
1489\r
1490 DEBUG ((DEBUG_ERROR, "\n"));\r
1491}\r
1492\r
1493/**\r
1494 Set the boot priority for BBS entries based on boot option entry and boot order.\r
1495\r
1496 @param Entry The boot option is to be checked for refresh BBS table.\r
1497 \r
1498 @retval EFI_SUCCESS The boot priority for BBS entries is refreshed successfully.\r
1499 @retval EFI_NOT_FOUND BBS entries can't be found.\r
1500 @retval EFI_OUT_OF_RESOURCES Failed to get the legacy device boot order.\r
1501**/\r
1502EFI_STATUS\r
1503EFIAPI\r
1504BdsRefreshBbsTableForBoot (\r
1505 IN BDS_COMMON_OPTION *Entry\r
1506 )\r
1507{\r
1508 EFI_STATUS Status;\r
1509 UINT16 BbsIndex;\r
1510 UINT16 HddCount;\r
1511 UINT16 BbsCount;\r
1512 HDD_INFO *LocalHddInfo;\r
1513 BBS_TABLE *LocalBbsTable;\r
1514 UINT16 DevType;\r
1515 EFI_LEGACY_BIOS_PROTOCOL *LegacyBios;\r
1516 UINTN Index;\r
1517 UINT16 Priority;\r
1518 UINT16 *BootOrder;\r
1519 UINTN BootOrderSize;\r
1520 UINT8 *BootOptionVar;\r
1521 UINTN BootOptionSize;\r
1522 CHAR16 BootOption[9];\r
1523 UINT8 *Ptr;\r
1524 UINT16 DevPathLen;\r
1525 EFI_DEVICE_PATH_PROTOCOL *DevPath;\r
1526 UINT16 *DeviceType;\r
1527 UINTN DeviceTypeCount;\r
1528 UINTN DeviceTypeIndex;\r
1529\r
1530 HddCount = 0;\r
1531 BbsCount = 0;\r
1532 LocalHddInfo = NULL;\r
1533 LocalBbsTable = NULL;\r
1534 DevType = BBS_UNKNOWN;\r
1535\r
1536 Status = gBS->LocateProtocol (&gEfiLegacyBiosProtocolGuid, NULL, (VOID **) &LegacyBios);\r
1537 if (EFI_ERROR (Status)) {\r
1538 return Status;\r
1539 }\r
1540\r
1541 LegacyBios->GetBbsInfo (\r
1542 LegacyBios,\r
1543 &HddCount,\r
1544 &LocalHddInfo,\r
1545 &BbsCount,\r
1546 &LocalBbsTable\r
1547 );\r
1548 //\r
1549 // First, set all the present devices' boot priority to BBS_UNPRIORITIZED_ENTRY\r
1550 // We will set them according to the settings setup by user\r
1551 //\r
1552 for (Index = 0; Index < BbsCount; Index++) {\r
1553 if (!((BBS_IGNORE_ENTRY == LocalBbsTable[Index].BootPriority) ||\r
1554 (BBS_DO_NOT_BOOT_FROM == LocalBbsTable[Index].BootPriority) ||\r
1555 (BBS_LOWEST_PRIORITY == LocalBbsTable[Index].BootPriority))) {\r
1556 LocalBbsTable[Index].BootPriority = BBS_UNPRIORITIZED_ENTRY;\r
1557 }\r
1558 }\r
1559 //\r
1560 // boot priority always starts at 0\r
1561 //\r
1562 Priority = 0;\r
1563 if (Entry->LoadOptionsSize == sizeof (BBS_TABLE) + sizeof (UINT16)) {\r
1564 //\r
1565 // If Entry stands for a legacy boot option, we prioritize the devices with the same type first.\r
1566 //\r
1567 DevType = ((BBS_TABLE *) Entry->LoadOptions)->DeviceType;\r
1568 BbsIndex = *(UINT16 *) ((BBS_TABLE *) Entry->LoadOptions + 1);\r
1569 Status = BdsSetBootPriority4SameTypeDev (\r
1570 DevType,\r
1571 BbsIndex,\r
1572 LocalBbsTable,\r
1573 &Priority\r
1574 );\r
1575 if (EFI_ERROR (Status)) {\r
1576 return Status;\r
1577 }\r
1578 }\r
1579 //\r
1580 // we have to set the boot priority for other BBS entries with different device types\r
1581 //\r
1582 BootOrder = BdsLibGetVariableAndSize (\r
1583 L"BootOrder",\r
1584 &gEfiGlobalVariableGuid,\r
1585 &BootOrderSize\r
1586 );\r
1587 DeviceType = AllocatePool (BootOrderSize + sizeof (UINT16));\r
1588 ASSERT (DeviceType != NULL);\r
1589\r
1590 DeviceType[0] = DevType;\r
1591 DeviceTypeCount = 1;\r
1592 for (Index = 0; ((BootOrder != NULL) && (Index < BootOrderSize / sizeof (UINT16))); Index++) {\r
1593 UnicodeSPrint (BootOption, sizeof (BootOption), L"Boot%04x", BootOrder[Index]);\r
1594 BootOptionVar = BdsLibGetVariableAndSize (\r
1595 BootOption,\r
1596 &gEfiGlobalVariableGuid,\r
1597 &BootOptionSize\r
1598 );\r
1599 if (NULL == BootOptionVar) {\r
1600 continue;\r
1601 }\r
1602\r
1603 Ptr = BootOptionVar;\r
1604\r
1605 Ptr += sizeof (UINT32);\r
1606 DevPathLen = *(UINT16 *) Ptr;\r
1607 Ptr += sizeof (UINT16);\r
1608 Ptr += StrSize ((UINT16 *) Ptr);\r
1609 DevPath = (EFI_DEVICE_PATH_PROTOCOL *) Ptr;\r
1610 if (BBS_DEVICE_PATH != DevPath->Type || BBS_BBS_DP != DevPath->SubType) {\r
1611 FreePool (BootOptionVar);\r
1612 continue;\r
1613 }\r
1614\r
1615 Ptr += DevPathLen;\r
1616 DevType = ((BBS_TABLE *) Ptr)->DeviceType;\r
1617 for (DeviceTypeIndex = 0; DeviceTypeIndex < DeviceTypeCount; DeviceTypeIndex++) {\r
1618 if (DeviceType[DeviceTypeIndex] == DevType) {\r
1619 break;\r
1620 }\r
1621 }\r
1622 if (DeviceTypeIndex < DeviceTypeCount) {\r
1623 //\r
1624 // We don't want to process twice for a device type\r
1625 //\r
1626 FreePool (BootOptionVar);\r
1627 continue;\r
1628 }\r
1629\r
1630 DeviceType[DeviceTypeCount] = DevType;\r
1631 DeviceTypeCount++;\r
1632\r
1633 Status = BdsSetBootPriority4SameTypeDev (\r
1634 DevType,\r
1635 (UINTN) -1,\r
1636 LocalBbsTable,\r
1637 &Priority\r
1638 );\r
1639 FreePool (BootOptionVar);\r
1640 if (EFI_ERROR (Status)) {\r
1641 break;\r
1642 }\r
1643 }\r
1644\r
1645 if (BootOrder != NULL) {\r
1646 FreePool (BootOrder);\r
1647 }\r
1648\r
1649 DEBUG_CODE_BEGIN();\r
1650 PrintBbsTable (LocalBbsTable, BbsCount);\r
1651 DEBUG_CODE_END();\r
1652\r
1653 return Status;\r
1654}\r
5c08e117 1655\r
1656/**\r
1657 Boot the legacy system with the boot option\r
1658\r
1659 @param Option The legacy boot option which have BBS device path\r
1660\r
1661 @retval EFI_UNSUPPORTED There is no legacybios protocol, do not support\r
1662 legacy boot.\r
1663 @retval EFI_STATUS Return the status of LegacyBios->LegacyBoot ().\r
1664\r
1665**/\r
1666EFI_STATUS\r
1667BdsLibDoLegacyBoot (\r
1668 IN BDS_COMMON_OPTION *Option\r
1669 )\r
1670{\r
1671 EFI_STATUS Status;\r
1672 EFI_LEGACY_BIOS_PROTOCOL *LegacyBios;\r
26c0ba77 1673 EFI_EVENT LegacyBootEvent;\r
5c08e117 1674\r
1675 Status = gBS->LocateProtocol (&gEfiLegacyBiosProtocolGuid, NULL, (VOID **) &LegacyBios);\r
1676 if (EFI_ERROR (Status)) {\r
1677 //\r
1678 // If no LegacyBios protocol we do not support legacy boot\r
1679 //\r
1680 return EFI_UNSUPPORTED;\r
1681 }\r
1682 //\r
1683 // Notes: if we separate the int 19, then we don't need to refresh BBS\r
1684 //\r
1685 BdsRefreshBbsTableForBoot (Option);\r
1686\r
1687 //\r
cd6a3b15 1688 // Write boot to OS performance data for legacy boot.\r
5c08e117 1689 //\r
1690 PERF_CODE (\r
26c0ba77
SZ
1691 //\r
1692 // Create an event to be signalled when Legacy Boot occurs to write performance data.\r
1693 //\r
1694 Status = EfiCreateEventLegacyBootEx(\r
1695 TPL_NOTIFY,\r
1696 WriteBootToOsPerformanceData,\r
1697 NULL, \r
1698 &LegacyBootEvent\r
1699 );\r
1700 ASSERT_EFI_ERROR (Status);\r
5c08e117 1701 );\r
1702\r
1703 DEBUG ((DEBUG_INFO | DEBUG_LOAD, "Legacy Boot: %S\n", Option->Description));\r
1704 return LegacyBios->LegacyBoot (\r
1705 LegacyBios,\r
1706 (BBS_BBS_DEVICE_PATH *) Option->DevicePath,\r
1707 Option->LoadOptionsSize,\r
1708 Option->LoadOptions\r
1709 );\r
1710}\r
1711\r
3d7decbc 1712/**\r
1713 Internal function to check if the input boot option is a valid EFI NV Boot####.\r
1714\r
1715 @param OptionToCheck Boot option to be checked.\r
1716\r
1717 @retval TRUE This boot option matches a valid EFI NV Boot####.\r
1718 @retval FALSE If not.\r
128efbbc 1719\r
3d7decbc 1720**/\r
3d7decbc 1721BOOLEAN\r
1722IsBootOptionValidNVVarialbe (\r
1723 IN BDS_COMMON_OPTION *OptionToCheck\r
1724 )\r
1725{\r
1726 LIST_ENTRY TempList;\r
1727 BDS_COMMON_OPTION *BootOption;\r
1728 BOOLEAN Valid;\r
1729 CHAR16 OptionName[20];\r
1730\r
1731 Valid = FALSE;\r
1732\r
1733 InitializeListHead (&TempList);\r
1734 UnicodeSPrint (OptionName, sizeof (OptionName), L"Boot%04x", OptionToCheck->BootCurrent);\r
5c08e117 1735\r
3d7decbc 1736 BootOption = BdsLibVariableToOption (&TempList, OptionName);\r
1737 if (BootOption == NULL) {\r
1738 return FALSE;\r
1739 }\r
1740\r
1741 //\r
128efbbc 1742 // If the Boot Option Number and Device Path matches, OptionToCheck matches a\r
3d7decbc 1743 // valid EFI NV Boot####.\r
1744 //\r
1745 if ((OptionToCheck->BootCurrent == BootOption->BootCurrent) &&\r
1746 (CompareMem (OptionToCheck->DevicePath, BootOption->DevicePath, GetDevicePathSize (OptionToCheck->DevicePath)) == 0))\r
1747 {\r
1748 Valid = TRUE;\r
1749 }\r
1750\r
1751 FreePool (BootOption);\r
128efbbc 1752\r
3d7decbc 1753 return Valid;\r
1754}\r
7389fdd0 1755\r
1756/**\r
1757 Check whether a USB device match the specified USB Class device path. This\r
1758 function follows "Load Option Processing" behavior in UEFI specification.\r
1759\r
1760 @param UsbIo USB I/O protocol associated with the USB device.\r
1761 @param UsbClass The USB Class device path to match.\r
1762\r
1763 @retval TRUE The USB device match the USB Class device path.\r
1764 @retval FALSE The USB device does not match the USB Class device path.\r
1765\r
1766**/\r
1767BOOLEAN\r
1768BdsMatchUsbClass (\r
1769 IN EFI_USB_IO_PROTOCOL *UsbIo,\r
1770 IN USB_CLASS_DEVICE_PATH *UsbClass\r
1771 )\r
1772{\r
1773 EFI_STATUS Status;\r
1774 EFI_USB_DEVICE_DESCRIPTOR DevDesc;\r
1775 EFI_USB_INTERFACE_DESCRIPTOR IfDesc;\r
1776 UINT8 DeviceClass;\r
1777 UINT8 DeviceSubClass;\r
1778 UINT8 DeviceProtocol;\r
1779\r
1780 if ((DevicePathType (UsbClass) != MESSAGING_DEVICE_PATH) ||\r
1781 (DevicePathSubType (UsbClass) != MSG_USB_CLASS_DP)){\r
1782 return FALSE;\r
1783 }\r
1784\r
1785 //\r
1786 // Check Vendor Id and Product Id.\r
1787 //\r
1788 Status = UsbIo->UsbGetDeviceDescriptor (UsbIo, &DevDesc);\r
1789 if (EFI_ERROR (Status)) {\r
1790 return FALSE;\r
1791 }\r
1792\r
1793 if ((UsbClass->VendorId != 0xffff) &&\r
1794 (UsbClass->VendorId != DevDesc.IdVendor)) {\r
1795 return FALSE;\r
1796 }\r
1797\r
1798 if ((UsbClass->ProductId != 0xffff) &&\r
1799 (UsbClass->ProductId != DevDesc.IdProduct)) {\r
1800 return FALSE;\r
1801 }\r
1802\r
1803 DeviceClass = DevDesc.DeviceClass;\r
1804 DeviceSubClass = DevDesc.DeviceSubClass;\r
1805 DeviceProtocol = DevDesc.DeviceProtocol;\r
1806 if (DeviceClass == 0) {\r
1807 //\r
1808 // If Class in Device Descriptor is set to 0, use the Class, SubClass and\r
1809 // Protocol in Interface Descriptor instead.\r
1810 //\r
1811 Status = UsbIo->UsbGetInterfaceDescriptor (UsbIo, &IfDesc);\r
1812 if (EFI_ERROR (Status)) {\r
1813 return FALSE;\r
1814 }\r
1815\r
1816 DeviceClass = IfDesc.InterfaceClass;\r
1817 DeviceSubClass = IfDesc.InterfaceSubClass;\r
1818 DeviceProtocol = IfDesc.InterfaceProtocol;\r
1819 }\r
1820\r
1821 //\r
1822 // Check Class, SubClass and Protocol.\r
1823 //\r
1824 if ((UsbClass->DeviceClass != 0xff) &&\r
1825 (UsbClass->DeviceClass != DeviceClass)) {\r
1826 return FALSE;\r
1827 }\r
1828\r
1829 if ((UsbClass->DeviceSubClass != 0xff) &&\r
1830 (UsbClass->DeviceSubClass != DeviceSubClass)) {\r
1831 return FALSE;\r
1832 }\r
1833\r
1834 if ((UsbClass->DeviceProtocol != 0xff) &&\r
1835 (UsbClass->DeviceProtocol != DeviceProtocol)) {\r
1836 return FALSE;\r
1837 }\r
1838\r
1839 return TRUE;\r
1840}\r
1841\r
1842/**\r
1843 Check whether a USB device match the specified USB WWID device path. This\r
1844 function follows "Load Option Processing" behavior in UEFI specification.\r
1845\r
1846 @param UsbIo USB I/O protocol associated with the USB device.\r
1847 @param UsbWwid The USB WWID device path to match.\r
1848\r
1849 @retval TRUE The USB device match the USB WWID device path.\r
1850 @retval FALSE The USB device does not match the USB WWID device path.\r
1851\r
1852**/\r
1853BOOLEAN\r
1854BdsMatchUsbWwid (\r
1855 IN EFI_USB_IO_PROTOCOL *UsbIo,\r
1856 IN USB_WWID_DEVICE_PATH *UsbWwid\r
1857 )\r
1858{\r
1859 EFI_STATUS Status;\r
1860 EFI_USB_DEVICE_DESCRIPTOR DevDesc;\r
1861 EFI_USB_INTERFACE_DESCRIPTOR IfDesc;\r
1862 UINT16 *LangIdTable;\r
1863 UINT16 TableSize;\r
1864 UINT16 Index;\r
1865 CHAR16 *CompareStr;\r
1866 UINTN CompareLen;\r
1867 CHAR16 *SerialNumberStr;\r
1868 UINTN Length;\r
1869\r
1870 if ((DevicePathType (UsbWwid) != MESSAGING_DEVICE_PATH) ||\r
1871 (DevicePathSubType (UsbWwid) != MSG_USB_WWID_DP )){\r
1872 return FALSE;\r
1873 }\r
1874\r
1875 //\r
1876 // Check Vendor Id and Product Id.\r
1877 //\r
1878 Status = UsbIo->UsbGetDeviceDescriptor (UsbIo, &DevDesc);\r
1879 if (EFI_ERROR (Status)) {\r
1880 return FALSE;\r
1881 }\r
1882 if ((DevDesc.IdVendor != UsbWwid->VendorId) ||\r
1883 (DevDesc.IdProduct != UsbWwid->ProductId)) {\r
1884 return FALSE;\r
1885 }\r
1886\r
1887 //\r
1888 // Check Interface Number.\r
1889 //\r
1890 Status = UsbIo->UsbGetInterfaceDescriptor (UsbIo, &IfDesc);\r
1891 if (EFI_ERROR (Status)) {\r
1892 return FALSE;\r
1893 }\r
1894 if (IfDesc.InterfaceNumber != UsbWwid->InterfaceNumber) {\r
1895 return FALSE;\r
1896 }\r
1897\r
1898 //\r
1899 // Check Serial Number.\r
1900 //\r
1901 if (DevDesc.StrSerialNumber == 0) {\r
1902 return FALSE;\r
1903 }\r
1904\r
1905 //\r
1906 // Get all supported languages.\r
1907 //\r
1908 TableSize = 0;\r
1909 LangIdTable = NULL;\r
1910 Status = UsbIo->UsbGetSupportedLanguages (UsbIo, &LangIdTable, &TableSize);\r
1911 if (EFI_ERROR (Status) || (TableSize == 0) || (LangIdTable == NULL)) {\r
1912 return FALSE;\r
1913 }\r
1914\r
1915 //\r
1916 // Serial number in USB WWID device path is the last 64-or-less UTF-16 characters.\r
1917 //\r
1918 CompareStr = (CHAR16 *) (UINTN) (UsbWwid + 1);\r
1919 CompareLen = (DevicePathNodeLength (UsbWwid) - sizeof (USB_WWID_DEVICE_PATH)) / sizeof (CHAR16);\r
1920 if (CompareStr[CompareLen - 1] == L'\0') {\r
1921 CompareLen--;\r
1922 }\r
1923\r
1924 //\r
1925 // Compare serial number in each supported language.\r
1926 //\r
1927 for (Index = 0; Index < TableSize / sizeof (UINT16); Index++) {\r
1928 SerialNumberStr = NULL;\r
1929 Status = UsbIo->UsbGetStringDescriptor (\r
1930 UsbIo,\r
1931 LangIdTable[Index],\r
1932 DevDesc.StrSerialNumber,\r
1933 &SerialNumberStr\r
1934 );\r
1935 if (EFI_ERROR (Status) || (SerialNumberStr == NULL)) {\r
1936 continue;\r
1937 }\r
1938\r
1939 Length = StrLen (SerialNumberStr);\r
1940 if ((Length >= CompareLen) &&\r
1941 (CompareMem (SerialNumberStr + Length - CompareLen, CompareStr, CompareLen * sizeof (CHAR16)) == 0)) {\r
1942 FreePool (SerialNumberStr);\r
1943 return TRUE;\r
1944 }\r
1945\r
1946 FreePool (SerialNumberStr);\r
1947 }\r
1948\r
1949 return FALSE;\r
1950}\r
1951\r
1952/**\r
9972247d 1953 Find a USB device path which match the specified short-form device path start\r
1954 with USB Class or USB WWID device path and load the boot file then return the \r
1955 image handle. If ParentDevicePath is NULL, this function will search in all USB\r
1956 devices of the platform. If ParentDevicePath is not NULL,this function will only\r
1957 search in its child devices.\r
7389fdd0 1958\r
1959 @param ParentDevicePath The device path of the parent.\r
1960 @param ShortFormDevicePath The USB Class or USB WWID device path to match.\r
1961\r
9972247d 1962 @return The image Handle if find load file from specified short-form device path\r
1963 or NULL if not found.\r
7389fdd0 1964\r
1965**/\r
1966EFI_HANDLE *\r
1967BdsFindUsbDevice (\r
1968 IN EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath,\r
1969 IN EFI_DEVICE_PATH_PROTOCOL *ShortFormDevicePath\r
1970 )\r
1971{\r
1972 EFI_STATUS Status;\r
1973 UINTN UsbIoHandleCount;\r
1974 EFI_HANDLE *UsbIoHandleBuffer;\r
1975 EFI_DEVICE_PATH_PROTOCOL *UsbIoDevicePath;\r
1976 EFI_USB_IO_PROTOCOL *UsbIo;\r
1977 UINTN Index;\r
1978 UINTN ParentSize;\r
1979 UINTN Size;\r
9972247d 1980 EFI_HANDLE ImageHandle;\r
1981 EFI_HANDLE Handle;\r
1982 EFI_DEVICE_PATH_PROTOCOL *FullDevicePath;\r
1983 EFI_DEVICE_PATH_PROTOCOL *NextDevicePath;\r
1984\r
1985 FullDevicePath = NULL;\r
1986 ImageHandle = NULL;\r
7389fdd0 1987\r
1988 //\r
1989 // Get all UsbIo Handles.\r
1990 //\r
1991 UsbIoHandleCount = 0;\r
1992 UsbIoHandleBuffer = NULL;\r
1993 Status = gBS->LocateHandleBuffer (\r
1994 ByProtocol,\r
1995 &gEfiUsbIoProtocolGuid,\r
1996 NULL,\r
1997 &UsbIoHandleCount,\r
1998 &UsbIoHandleBuffer\r
1999 );\r
2000 if (EFI_ERROR (Status) || (UsbIoHandleCount == 0) || (UsbIoHandleBuffer == NULL)) {\r
2001 return NULL;\r
2002 }\r
2003\r
7389fdd0 2004 ParentSize = (ParentDevicePath == NULL) ? 0 : GetDevicePathSize (ParentDevicePath);\r
2005 for (Index = 0; Index < UsbIoHandleCount; Index++) {\r
2006 //\r
2007 // Get the Usb IO interface.\r
2008 //\r
2009 Status = gBS->HandleProtocol(\r
2010 UsbIoHandleBuffer[Index],\r
2011 &gEfiUsbIoProtocolGuid,\r
2012 (VOID **) &UsbIo\r
2013 );\r
2014 if (EFI_ERROR (Status)) {\r
2015 continue;\r
2016 }\r
2017\r
9972247d 2018 UsbIoDevicePath = DevicePathFromHandle (UsbIoHandleBuffer[Index]);\r
2019 if (UsbIoDevicePath == NULL) {\r
2020 continue;\r
2021 }\r
2022\r
7389fdd0 2023 if (ParentDevicePath != NULL) {\r
2024 //\r
2025 // Compare starting part of UsbIoHandle's device path with ParentDevicePath.\r
2026 //\r
7389fdd0 2027 Size = GetDevicePathSize (UsbIoDevicePath);\r
2028 if ((Size < ParentSize) ||\r
2029 (CompareMem (UsbIoDevicePath, ParentDevicePath, ParentSize - END_DEVICE_PATH_LENGTH) != 0)) {\r
2030 continue;\r
2031 }\r
2032 }\r
2033\r
2034 if (BdsMatchUsbClass (UsbIo, (USB_CLASS_DEVICE_PATH *) ShortFormDevicePath) ||\r
2035 BdsMatchUsbWwid (UsbIo, (USB_WWID_DEVICE_PATH *) ShortFormDevicePath)) {\r
9972247d 2036 //\r
2037 // Try to find if there is the boot file in this DevicePath\r
2038 //\r
2039 NextDevicePath = NextDevicePathNode (ShortFormDevicePath);\r
2040 if (!IsDevicePathEnd (NextDevicePath)) {\r
2041 FullDevicePath = AppendDevicePath (UsbIoDevicePath, NextDevicePath);\r
2042 //\r
2043 // Connect the full device path, so that Simple File System protocol\r
2044 // could be installed for this USB device.\r
2045 //\r
2046 BdsLibConnectDevicePath (FullDevicePath);\r
79b7a6a1 2047 REPORT_STATUS_CODE (EFI_PROGRESS_CODE, PcdGet32 (PcdProgressCodeOsLoaderLoad));\r
9972247d 2048 Status = gBS->LoadImage (\r
2049 TRUE,\r
2050 gImageHandle,\r
2051 FullDevicePath,\r
2052 NULL,\r
2053 0,\r
2054 &ImageHandle\r
2055 );\r
2056 FreePool (FullDevicePath);\r
2057 } else {\r
2058 FullDevicePath = UsbIoDevicePath;\r
2059 Status = EFI_NOT_FOUND;\r
2060 }\r
2061\r
2062 //\r
2063 // If we didn't find an image directly, we need to try as if it is a removable device boot option\r
2064 // and load the image according to the default boot behavior for removable device.\r
2065 //\r
2066 if (EFI_ERROR (Status)) {\r
2067 //\r
2068 // check if there is a bootable removable media could be found in this device path ,\r
2069 // and get the bootable media handle\r
2070 //\r
2071 Handle = BdsLibGetBootableHandle(UsbIoDevicePath);\r
2072 if (Handle == NULL) {\r
2073 continue;\r
2074 }\r
2075 //\r
2076 // Load the default boot file \EFI\BOOT\boot{machinename}.EFI from removable Media\r
2077 // machinename is ia32, ia64, x64, ...\r
2078 //\r
2079 FullDevicePath = FileDevicePath (Handle, EFI_REMOVABLE_MEDIA_FILE_NAME);\r
2080 if (FullDevicePath != NULL) {\r
79b7a6a1 2081 REPORT_STATUS_CODE (EFI_PROGRESS_CODE, PcdGet32 (PcdProgressCodeOsLoaderLoad));\r
9972247d 2082 Status = gBS->LoadImage (\r
2083 TRUE,\r
2084 gImageHandle,\r
2085 FullDevicePath,\r
2086 NULL,\r
2087 0,\r
2088 &ImageHandle\r
2089 );\r
2090 if (EFI_ERROR (Status)) {\r
2091 //\r
2092 // The DevicePath failed, and it's not a valid\r
2093 // removable media device.\r
2094 //\r
2095 continue;\r
2096 }\r
2097 } else {\r
2098 continue;\r
2099 }\r
2100 }\r
7389fdd0 2101 break;\r
2102 }\r
2103 }\r
2104\r
2105 FreePool (UsbIoHandleBuffer);\r
9972247d 2106 return ImageHandle;\r
7389fdd0 2107}\r
2108\r
2109/**\r
2110 Expand USB Class or USB WWID device path node to be full device path of a USB\r
9972247d 2111 device in platform then load the boot file on this full device path and return the \r
2112 image handle.\r
7389fdd0 2113\r
2114 This function support following 4 cases:\r
2115 1) Boot Option device path starts with a USB Class or USB WWID device path,\r
2116 and there is no Media FilePath device path in the end.\r
2117 In this case, it will follow Removable Media Boot Behavior.\r
2118 2) Boot Option device path starts with a USB Class or USB WWID device path,\r
2119 and ended with Media FilePath device path.\r
2120 3) Boot Option device path starts with a full device path to a USB Host Controller,\r
2121 contains a USB Class or USB WWID device path node, while not ended with Media\r
2122 FilePath device path. In this case, it will follow Removable Media Boot Behavior.\r
2123 4) Boot Option device path starts with a full device path to a USB Host Controller,\r
2124 contains a USB Class or USB WWID device path node, and ended with Media\r
2125 FilePath device path.\r
2126\r
2127 @param DevicePath The Boot Option device path.\r
2128\r
9972247d 2129 @return The image handle of boot file, or NULL if there is no boot file found in\r
2130 the specified USB Class or USB WWID device path.\r
7389fdd0 2131\r
2132**/\r
9972247d 2133EFI_HANDLE *\r
7389fdd0 2134BdsExpandUsbShortFormDevicePath (\r
2135 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
2136 )\r
2137{\r
9972247d 2138 EFI_HANDLE *ImageHandle;\r
7389fdd0 2139 EFI_DEVICE_PATH_PROTOCOL *TempDevicePath;\r
7389fdd0 2140 EFI_DEVICE_PATH_PROTOCOL *ShortFormDevicePath;\r
2141\r
2142 //\r
2143 // Search for USB Class or USB WWID device path node.\r
2144 //\r
2145 ShortFormDevicePath = NULL;\r
9972247d 2146 ImageHandle = NULL;\r
2147 TempDevicePath = DevicePath;\r
7389fdd0 2148 while (!IsDevicePathEnd (TempDevicePath)) {\r
2149 if ((DevicePathType (TempDevicePath) == MESSAGING_DEVICE_PATH) &&\r
2150 ((DevicePathSubType (TempDevicePath) == MSG_USB_CLASS_DP) ||\r
2151 (DevicePathSubType (TempDevicePath) == MSG_USB_WWID_DP))) {\r
2152 ShortFormDevicePath = TempDevicePath;\r
2153 break;\r
2154 }\r
7389fdd0 2155 TempDevicePath = NextDevicePathNode (TempDevicePath);\r
2156 }\r
2157\r
2158 if (ShortFormDevicePath == NULL) {\r
2159 //\r
2160 // No USB Class or USB WWID device path node found, do nothing.\r
2161 //\r
2162 return NULL;\r
2163 }\r
2164\r
2165 if (ShortFormDevicePath == DevicePath) {\r
2166 //\r
2167 // Boot Option device path starts with USB Class or USB WWID device path.\r
2168 //\r
9972247d 2169 ImageHandle = BdsFindUsbDevice (NULL, ShortFormDevicePath);\r
2170 if (ImageHandle == NULL) {\r
7389fdd0 2171 //\r
2172 // Failed to find a match in existing devices, connect the short form USB\r
2173 // device path and try again.\r
2174 //\r
2175 BdsLibConnectUsbDevByShortFormDP (0xff, ShortFormDevicePath);\r
9972247d 2176 ImageHandle = BdsFindUsbDevice (NULL, ShortFormDevicePath);\r
7389fdd0 2177 }\r
2178 } else {\r
2179 //\r
2180 // Boot Option device path contains USB Class or USB WWID device path node.\r
2181 //\r
2182\r
2183 //\r
2184 // Prepare the parent device path for search.\r
2185 //\r
2186 TempDevicePath = DuplicateDevicePath (DevicePath);\r
2187 ASSERT (TempDevicePath != NULL);\r
2188 SetDevicePathEndNode (((UINT8 *) TempDevicePath) + ((UINTN) ShortFormDevicePath - (UINTN) DevicePath));\r
2189\r
2190 //\r
9972247d 2191 // The USB Host Controller device path is already in Boot Option device path\r
7389fdd0 2192 // and USB Bus driver already support RemainingDevicePath starts with USB\r
2193 // Class or USB WWID device path, so just search in existing USB devices and\r
2194 // doesn't perform ConnectController here.\r
2195 //\r
9972247d 2196 ImageHandle = BdsFindUsbDevice (TempDevicePath, ShortFormDevicePath);\r
7389fdd0 2197 FreePool (TempDevicePath);\r
2198 }\r
2199\r
9972247d 2200 return ImageHandle;\r
7389fdd0 2201}\r
2202\r
5c08e117 2203/**\r
2204 Process the boot option follow the UEFI specification and\r
2205 special treat the legacy boot option with BBS_DEVICE_PATH.\r
2206\r
2207 @param Option The boot option need to be processed\r
2208 @param DevicePath The device path which describe where to load the\r
2209 boot image or the legacy BBS device path to boot\r
2210 the legacy OS\r
2211 @param ExitDataSize The size of exit data.\r
2212 @param ExitData Data returned when Boot image failed.\r
2213\r
2214 @retval EFI_SUCCESS Boot from the input boot option successfully.\r
2215 @retval EFI_NOT_FOUND If the Device Path is not found in the system\r
2216\r
2217**/\r
2218EFI_STATUS\r
2219EFIAPI\r
2220BdsLibBootViaBootOption (\r
2221 IN BDS_COMMON_OPTION *Option,\r
2222 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r
2223 OUT UINTN *ExitDataSize,\r
2224 OUT CHAR16 **ExitData OPTIONAL\r
2225 )\r
2226{\r
2227 EFI_STATUS Status;\r
2df686c6 2228 EFI_STATUS StatusLogo;\r
5c08e117 2229 EFI_HANDLE Handle;\r
2230 EFI_HANDLE ImageHandle;\r
2231 EFI_DEVICE_PATH_PROTOCOL *FilePath;\r
2232 EFI_LOADED_IMAGE_PROTOCOL *ImageInfo;\r
2233 EFI_DEVICE_PATH_PROTOCOL *WorkingDevicePath;\r
2234 EFI_ACPI_S3_SAVE_PROTOCOL *AcpiS3Save;\r
2235 LIST_ENTRY TempBootLists;\r
2df686c6 2236 EFI_BOOT_LOGO_PROTOCOL *BootLogo;\r
5c08e117 2237\r
5c08e117 2238 *ExitDataSize = 0;\r
2239 *ExitData = NULL;\r
2240\r
5c08e117 2241 //\r
2242 // Notes: this code can be remove after the s3 script table\r
2243 // hook on the event EVT_SIGNAL_READY_TO_BOOT or\r
2244 // EVT_SIGNAL_LEGACY_BOOT\r
2245 //\r
2246 Status = gBS->LocateProtocol (&gEfiAcpiS3SaveProtocolGuid, NULL, (VOID **) &AcpiS3Save);\r
2247 if (!EFI_ERROR (Status)) {\r
2248 AcpiS3Save->S3Save (AcpiS3Save, NULL);\r
2249 }\r
2250 //\r
2251 // If it's Device Path that starts with a hard drive path, append it with the front part to compose a\r
2252 // full device path\r
2253 //\r
2254 WorkingDevicePath = NULL;\r
2255 if ((DevicePathType (DevicePath) == MEDIA_DEVICE_PATH) &&\r
2256 (DevicePathSubType (DevicePath) == MEDIA_HARDDRIVE_DP)) {\r
2257 WorkingDevicePath = BdsExpandPartitionPartialDevicePathToFull (\r
2258 (HARDDRIVE_DEVICE_PATH *)DevicePath\r
2259 );\r
2260 if (WorkingDevicePath != NULL) {\r
2261 DevicePath = WorkingDevicePath;\r
2262 }\r
2263 }\r
7389fdd0 2264\r
5c08e117 2265 //\r
2266 // Set Boot Current\r
2267 //\r
3d7decbc 2268 if (IsBootOptionValidNVVarialbe (Option)) {\r
2269 //\r
2270 // For a temporary boot (i.e. a boot by selected a EFI Shell using "Boot From File"), Boot Current is actually not valid.\r
2271 // In this case, "BootCurrent" is not created.\r
2272 // Only create the BootCurrent variable when it points to a valid Boot#### variable.\r
2273 //\r
69fc8f08 2274 SetVariableAndReportStatusCodeOnError (\r
3d7decbc 2275 L"BootCurrent",\r
2276 &gEfiGlobalVariableGuid,\r
2277 EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
2278 sizeof (UINT16),\r
2279 &Option->BootCurrent\r
2280 );\r
2281 }\r
5c08e117 2282\r
cb38c322 2283 //\r
2284 // Report Status Code to indicate ReadyToBoot event will be signalled\r
2285 //\r
2286 REPORT_STATUS_CODE (EFI_PROGRESS_CODE, (EFI_SOFTWARE_DXE_BS_DRIVER | EFI_SW_DXE_BS_PC_READY_TO_BOOT_EVENT));\r
2287\r
72861c22 2288 //\r
2289 // Signal the EVT_SIGNAL_READY_TO_BOOT event\r
2290 //\r
2291 EfiSignalEventReadyToBoot();\r
2292\r
2293 //\r
2294 // Expand USB Class or USB WWID device path node to be full device path of a USB\r
2295 // device in platform then load the boot file on this full device path and get the\r
2296 // image handle.\r
2297 //\r
2298 ImageHandle = BdsExpandUsbShortFormDevicePath (DevicePath);\r
2299\r
2300 //\r
2301 // Adjust the different type memory page number just before booting\r
2302 // and save the updated info into the variable for next boot to use\r
2303 //\r
2304 BdsSetMemoryTypeInformationVariable ();\r
2305\r
5c08e117 2306 //\r
9972247d 2307 // By expanding the USB Class or WWID device path, the ImageHandle has returnned.\r
2308 // Here get the ImageHandle for the non USB class or WWID device path.\r
5c08e117 2309 //\r
9972247d 2310 if (ImageHandle == NULL) {\r
2311 ASSERT (Option->DevicePath != NULL);\r
2312 if ((DevicePathType (Option->DevicePath) == BBS_DEVICE_PATH) &&\r
2313 (DevicePathSubType (Option->DevicePath) == BBS_BBS_DP)\r
2314 ) {\r
2315 //\r
2316 // Check to see if we should legacy BOOT. If yes then do the legacy boot\r
2317 //\r
2318 return BdsLibDoLegacyBoot (Option);\r
5c08e117 2319 }\r
128efbbc 2320\r
5c08e117 2321 //\r
9972247d 2322 // If the boot option point to Internal FV shell, make sure it is valid\r
5c08e117 2323 //\r
9972247d 2324 Status = BdsLibUpdateFvFileDevicePath (&DevicePath, PcdGetPtr(PcdShellFile));\r
2325 if (!EFI_ERROR(Status)) {\r
2326 if (Option->DevicePath != NULL) {\r
2327 FreePool(Option->DevicePath);\r
2328 }\r
2329 Option->DevicePath = AllocateZeroPool (GetDevicePathSize (DevicePath));\r
2330 ASSERT(Option->DevicePath != NULL);\r
2331 CopyMem (Option->DevicePath, DevicePath, GetDevicePathSize (DevicePath));\r
2332 //\r
2333 // Update the shell boot option\r
2334 //\r
2335 InitializeListHead (&TempBootLists);\r
2336 BdsLibRegisterNewOption (&TempBootLists, DevicePath, L"EFI Internal Shell", L"BootOrder");\r
2337\r
2338 //\r
2339 // free the temporary device path created by BdsLibUpdateFvFileDevicePath()\r
2340 //\r
2341 FreePool (DevicePath);\r
2342 DevicePath = Option->DevicePath;\r
2343 }\r
5c08e117 2344\r
9972247d 2345 DEBUG_CODE_BEGIN();\r
5c08e117 2346\r
9aa7ba01 2347 if (Option->Description == NULL) {\r
2348 DEBUG ((DEBUG_INFO | DEBUG_LOAD, "Booting from unknown device path\n"));\r
2349 } else {\r
2350 DEBUG ((DEBUG_INFO | DEBUG_LOAD, "Booting %S\n", Option->Description));\r
ab8cc80b 2351 }\r
9aa7ba01 2352 \r
9972247d 2353 DEBUG_CODE_END();\r
ab8cc80b 2354 \r
79b7a6a1 2355 //\r
2356 // Report status code for OS Loader LoadImage.\r
2357 //\r
2358 REPORT_STATUS_CODE (EFI_PROGRESS_CODE, PcdGet32 (PcdProgressCodeOsLoaderLoad));\r
9972247d 2359 Status = gBS->LoadImage (\r
2360 TRUE,\r
2361 gImageHandle,\r
2362 DevicePath,\r
2363 NULL,\r
2364 0,\r
2365 &ImageHandle\r
2366 );\r
5c08e117 2367\r
5c08e117 2368 //\r
9972247d 2369 // If we didn't find an image directly, we need to try as if it is a removable device boot option\r
2370 // and load the image according to the default boot behavior for removable device.\r
5c08e117 2371 //\r
9972247d 2372 if (EFI_ERROR (Status)) {\r
2373 //\r
2374 // check if there is a bootable removable media could be found in this device path ,\r
2375 // and get the bootable media handle\r
2376 //\r
2377 Handle = BdsLibGetBootableHandle(DevicePath);\r
cb38c322 2378 if (Handle != NULL) {\r
2379 //\r
2380 // Load the default boot file \EFI\BOOT\boot{machinename}.EFI from removable Media\r
2381 // machinename is ia32, ia64, x64, ...\r
2382 //\r
2383 FilePath = FileDevicePath (Handle, EFI_REMOVABLE_MEDIA_FILE_NAME);\r
2384 if (FilePath != NULL) {\r
2385 REPORT_STATUS_CODE (EFI_PROGRESS_CODE, PcdGet32 (PcdProgressCodeOsLoaderLoad));\r
2386 Status = gBS->LoadImage (\r
2387 TRUE,\r
2388 gImageHandle,\r
2389 FilePath,\r
2390 NULL,\r
2391 0,\r
2392 &ImageHandle\r
2393 );\r
9972247d 2394 }\r
2395 }\r
5c08e117 2396 }\r
5c08e117 2397 }\r
2398 //\r
2399 // Provide the image with it's load options\r
2400 //\r
cb38c322 2401 if ((ImageHandle == NULL) || (EFI_ERROR(Status))) {\r
2402 //\r
2403 // Report Status Code to indicate that the failure to load boot option\r
2404 //\r
2405 REPORT_STATUS_CODE (\r
2406 EFI_ERROR_CODE | EFI_ERROR_MINOR,\r
2407 (EFI_SOFTWARE_DXE_BS_DRIVER | EFI_SW_DXE_BS_EC_BOOT_OPTION_LOAD_ERROR)\r
2408 ); \r
9972247d 2409 goto Done;\r
2410 }\r
cb38c322 2411\r
5c08e117 2412 Status = gBS->HandleProtocol (ImageHandle, &gEfiLoadedImageProtocolGuid, (VOID **) &ImageInfo);\r
2413 ASSERT_EFI_ERROR (Status);\r
2414\r
2415 if (Option->LoadOptionsSize != 0) {\r
2416 ImageInfo->LoadOptionsSize = Option->LoadOptionsSize;\r
2417 ImageInfo->LoadOptions = Option->LoadOptions;\r
2418 }\r
bf0712ae
ED
2419\r
2420 //\r
2421 // Clean to NULL because the image is loaded directly from the firmwares boot manager.\r
2422 //\r
2423 ImageInfo->ParentHandle = NULL;\r
2424\r
5c08e117 2425 //\r
2426 // Before calling the image, enable the Watchdog Timer for\r
2427 // the 5 Minute period\r
2428 //\r
2429 gBS->SetWatchdogTimer (5 * 60, 0x0000, 0x00, NULL);\r
2430\r
cd6a3b15 2431 //\r
2432 // Write boot to OS performance data for UEFI boot\r
2433 //\r
2434 PERF_CODE (\r
26c0ba77 2435 WriteBootToOsPerformanceData (NULL, NULL);\r
cd6a3b15 2436 );\r
2437\r
79b7a6a1 2438 //\r
2439 // Report status code for OS Loader StartImage.\r
2440 //\r
2441 REPORT_STATUS_CODE (EFI_PROGRESS_CODE, PcdGet32 (PcdProgressCodeOsLoaderStart));\r
2442\r
5c08e117 2443 Status = gBS->StartImage (ImageHandle, ExitDataSize, ExitData);\r
2444 DEBUG ((DEBUG_INFO | DEBUG_LOAD, "Image Return Status = %r\n", Status));\r
cb38c322 2445 if (EFI_ERROR (Status)) {\r
2446 //\r
2447 // Report Status Code to indicate that boot failure\r
2448 //\r
2449 REPORT_STATUS_CODE (\r
2450 EFI_ERROR_CODE | EFI_ERROR_MINOR,\r
2451 (EFI_SOFTWARE_DXE_BS_DRIVER | EFI_SW_DXE_BS_EC_BOOT_OPTION_FAILED)\r
2452 );\r
2453 }\r
5c08e117 2454\r
2455 //\r
2456 // Clear the Watchdog Timer after the image returns\r
2457 //\r
2458 gBS->SetWatchdogTimer (0x0000, 0x0000, 0x0000, NULL);\r
2459\r
2460Done:\r
2df686c6 2461 //\r
2462 // Set Logo status invalid after trying one boot option\r
2463 //\r
2464 BootLogo = NULL;\r
2465 StatusLogo = gBS->LocateProtocol (&gEfiBootLogoProtocolGuid, NULL, (VOID **) &BootLogo);\r
2466 if (!EFI_ERROR (StatusLogo) && (BootLogo != NULL)) {\r
2467 BootLogo->SetBootLogo (BootLogo, NULL, 0, 0, 0, 0);\r
2468 }\r
2469\r
5c08e117 2470 //\r
2471 // Clear Boot Current\r
69fc8f08 2472 // Deleting variable with current implementation shouldn't fail.\r
5c08e117 2473 //\r
2474 gRT->SetVariable (\r
2475 L"BootCurrent",\r
2476 &gEfiGlobalVariableGuid,\r
2477 EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
2478 0,\r
69fc8f08 2479 NULL\r
5c08e117 2480 );\r
2481\r
2482 return Status;\r
2483}\r
2484\r
2485\r
2486/**\r
2487 Expand a device path that starts with a hard drive media device path node to be a\r
2488 full device path that includes the full hardware path to the device. We need\r
2489 to do this so it can be booted. As an optimization the front match (the part point\r
2490 to the partition node. E.g. ACPI() /PCI()/ATA()/Partition() ) is saved in a variable\r
2491 so a connect all is not required on every boot. All successful history device path\r
2492 which point to partition node (the front part) will be saved.\r
2493\r
2494 @param HardDriveDevicePath EFI Device Path to boot, if it starts with a hard\r
2495 drive media device path.\r
2496 @return A Pointer to the full device path or NULL if a valid Hard Drive devic path\r
2497 cannot be found.\r
2498\r
2499**/\r
2500EFI_DEVICE_PATH_PROTOCOL *\r
2501EFIAPI\r
2502BdsExpandPartitionPartialDevicePathToFull (\r
2503 IN HARDDRIVE_DEVICE_PATH *HardDriveDevicePath\r
2504 )\r
2505{\r
2506 EFI_STATUS Status;\r
2507 UINTN BlockIoHandleCount;\r
2508 EFI_HANDLE *BlockIoBuffer;\r
2509 EFI_DEVICE_PATH_PROTOCOL *FullDevicePath;\r
2510 EFI_DEVICE_PATH_PROTOCOL *BlockIoDevicePath;\r
2511 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
2512 UINTN Index;\r
2513 UINTN InstanceNum;\r
2514 EFI_DEVICE_PATH_PROTOCOL *CachedDevicePath;\r
2515 EFI_DEVICE_PATH_PROTOCOL *TempNewDevicePath;\r
2516 UINTN CachedDevicePathSize;\r
2517 BOOLEAN DeviceExist;\r
2518 BOOLEAN NeedAdjust;\r
2519 EFI_DEVICE_PATH_PROTOCOL *Instance;\r
2520 UINTN Size;\r
2521\r
2522 FullDevicePath = NULL;\r
2523 //\r
e24fc103 2524 // Check if there is prestore HD_BOOT_DEVICE_PATH_VARIABLE_NAME variable.\r
5c08e117 2525 // If exist, search the front path which point to partition node in the variable instants.\r
e24fc103 2526 // If fail to find or HD_BOOT_DEVICE_PATH_VARIABLE_NAME not exist, reconnect all and search in all system\r
5c08e117 2527 //\r
f3fc9d8d
RN
2528 GetVariable2 (\r
2529 HD_BOOT_DEVICE_PATH_VARIABLE_NAME,\r
2530 &gHdBootDevicePathVariablGuid,\r
2531 (VOID **) &CachedDevicePath,\r
2532 &CachedDevicePathSize\r
2533 );\r
2534\r
2535 //\r
2536 // Delete the invalid HD_BOOT_DEVICE_PATH_VARIABLE_NAME variable.\r
2537 //\r
2538 if ((CachedDevicePath != NULL) && !IsDevicePathValid (CachedDevicePath, CachedDevicePathSize)) {\r
2539 FreePool (CachedDevicePath);\r
2540 CachedDevicePath = NULL;\r
2541 Status = gRT->SetVariable (\r
2542 HD_BOOT_DEVICE_PATH_VARIABLE_NAME,\r
2543 &gHdBootDevicePathVariablGuid,\r
2544 0,\r
2545 0,\r
2546 NULL\r
2547 );\r
2548 ASSERT_EFI_ERROR (Status);\r
2549 }\r
128efbbc 2550\r
5c08e117 2551 if (CachedDevicePath != NULL) {\r
2552 TempNewDevicePath = CachedDevicePath;\r
2553 DeviceExist = FALSE;\r
2554 NeedAdjust = FALSE;\r
2555 do {\r
2556 //\r
2557 // Check every instance of the variable\r
2558 // First, check whether the instance contain the partition node, which is needed for distinguishing multi\r
2559 // partial partition boot option. Second, check whether the instance could be connected.\r
2560 //\r
2561 Instance = GetNextDevicePathInstance (&TempNewDevicePath, &Size);\r
2562 if (MatchPartitionDevicePathNode (Instance, HardDriveDevicePath)) {\r
2563 //\r
2564 // Connect the device path instance, the device path point to hard drive media device path node\r
2565 // e.g. ACPI() /PCI()/ATA()/Partition()\r
2566 //\r
2567 Status = BdsLibConnectDevicePath (Instance);\r
2568 if (!EFI_ERROR (Status)) {\r
2569 DeviceExist = TRUE;\r
2570 break;\r
2571 }\r
2572 }\r
2573 //\r
2574 // Come here means the first instance is not matched\r
2575 //\r
2576 NeedAdjust = TRUE;\r
2577 FreePool(Instance);\r
2578 } while (TempNewDevicePath != NULL);\r
2579\r
2580 if (DeviceExist) {\r
2581 //\r
2582 // Find the matched device path.\r
2583 // Append the file path information from the boot option and return the fully expanded device path.\r
2584 //\r
2585 DevicePath = NextDevicePathNode ((EFI_DEVICE_PATH_PROTOCOL *) HardDriveDevicePath);\r
2586 FullDevicePath = AppendDevicePath (Instance, DevicePath);\r
2587\r
2588 //\r
e24fc103 2589 // Adjust the HD_BOOT_DEVICE_PATH_VARIABLE_NAME instances sequence if the matched one is not first one.\r
5c08e117 2590 //\r
2591 if (NeedAdjust) {\r
2592 //\r
2593 // First delete the matched instance.\r
2594 //\r
2595 TempNewDevicePath = CachedDevicePath;\r
2596 CachedDevicePath = BdsLibDelPartMatchInstance (CachedDevicePath, Instance );\r
2597 FreePool (TempNewDevicePath);\r
128efbbc 2598\r
5c08e117 2599 //\r
2600 // Second, append the remaining path after the matched instance\r
2601 //\r
2602 TempNewDevicePath = CachedDevicePath;\r
2603 CachedDevicePath = AppendDevicePathInstance (Instance, CachedDevicePath );\r
2604 FreePool (TempNewDevicePath);\r
2605 //\r
2606 // Save the matching Device Path so we don't need to do a connect all next time\r
69fc8f08 2607 // Failure to set the variable only impacts the performance when next time expanding the short-form device path.\r
5c08e117 2608 //\r
2609 Status = gRT->SetVariable (\r
e24fc103
LG
2610 HD_BOOT_DEVICE_PATH_VARIABLE_NAME,\r
2611 &gHdBootDevicePathVariablGuid,\r
f3fc9d8d 2612 EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r
5c08e117 2613 GetDevicePathSize (CachedDevicePath),\r
2614 CachedDevicePath\r
2615 );\r
2616 }\r
128efbbc 2617\r
5c08e117 2618 FreePool (Instance);\r
2619 FreePool (CachedDevicePath);\r
2620 return FullDevicePath;\r
2621 }\r
2622 }\r
2623\r
2624 //\r
e24fc103 2625 // If we get here we fail to find or HD_BOOT_DEVICE_PATH_VARIABLE_NAME not exist, and now we need\r
5c08e117 2626 // to search all devices in the system for a matched partition\r
2627 //\r
2628 BdsLibConnectAllDriversToAllControllers ();\r
2629 Status = gBS->LocateHandleBuffer (ByProtocol, &gEfiBlockIoProtocolGuid, NULL, &BlockIoHandleCount, &BlockIoBuffer);\r
2630 if (EFI_ERROR (Status) || BlockIoHandleCount == 0 || BlockIoBuffer == NULL) {\r
2631 //\r
2632 // If there was an error or there are no device handles that support\r
2633 // the BLOCK_IO Protocol, then return.\r
2634 //\r
2635 return NULL;\r
2636 }\r
2637 //\r
2638 // Loop through all the device handles that support the BLOCK_IO Protocol\r
2639 //\r
2640 for (Index = 0; Index < BlockIoHandleCount; Index++) {\r
2641\r
2642 Status = gBS->HandleProtocol (BlockIoBuffer[Index], &gEfiDevicePathProtocolGuid, (VOID *) &BlockIoDevicePath);\r
2643 if (EFI_ERROR (Status) || BlockIoDevicePath == NULL) {\r
2644 continue;\r
2645 }\r
2646\r
2647 if (MatchPartitionDevicePathNode (BlockIoDevicePath, HardDriveDevicePath)) {\r
2648 //\r
2649 // Find the matched partition device path\r
2650 //\r
2651 DevicePath = NextDevicePathNode ((EFI_DEVICE_PATH_PROTOCOL *) HardDriveDevicePath);\r
2652 FullDevicePath = AppendDevicePath (BlockIoDevicePath, DevicePath);\r
2653\r
2654 //\r
e24fc103 2655 // Save the matched partition device path in HD_BOOT_DEVICE_PATH_VARIABLE_NAME variable\r
5c08e117 2656 //\r
2657 if (CachedDevicePath != NULL) {\r
2658 //\r
e24fc103 2659 // Save the matched partition device path as first instance of HD_BOOT_DEVICE_PATH_VARIABLE_NAME variable\r
5c08e117 2660 //\r
2661 if (BdsLibMatchDevicePaths (CachedDevicePath, BlockIoDevicePath)) {\r
2662 TempNewDevicePath = CachedDevicePath;\r
2663 CachedDevicePath = BdsLibDelPartMatchInstance (CachedDevicePath, BlockIoDevicePath);\r
2664 FreePool(TempNewDevicePath);\r
e5a9b63c 2665 }\r
5c08e117 2666\r
e5a9b63c 2667 if (CachedDevicePath != NULL) {\r
5c08e117 2668 TempNewDevicePath = CachedDevicePath;\r
2669 CachedDevicePath = AppendDevicePathInstance (BlockIoDevicePath, CachedDevicePath);\r
2670 FreePool(TempNewDevicePath);\r
e5a9b63c
RN
2671 } else {\r
2672 CachedDevicePath = DuplicateDevicePath (BlockIoDevicePath);\r
5c08e117 2673 }\r
e5a9b63c 2674\r
5c08e117 2675 //\r
2676 // Here limit the device path instance number to 12, which is max number for a system support 3 IDE controller\r
e24fc103
LG
2677 // If the user try to boot many OS in different HDs or partitions, in theory, \r
2678 // the HD_BOOT_DEVICE_PATH_VARIABLE_NAME variable maybe become larger and larger.\r
5c08e117 2679 //\r
2680 InstanceNum = 0;\r
2681 ASSERT (CachedDevicePath != NULL);\r
2682 TempNewDevicePath = CachedDevicePath;\r
2683 while (!IsDevicePathEnd (TempNewDevicePath)) {\r
2684 TempNewDevicePath = NextDevicePathNode (TempNewDevicePath);\r
2685 //\r
2686 // Parse one instance\r
2687 //\r
2688 while (!IsDevicePathEndType (TempNewDevicePath)) {\r
2689 TempNewDevicePath = NextDevicePathNode (TempNewDevicePath);\r
2690 }\r
2691 InstanceNum++;\r
2692 //\r
2693 // If the CachedDevicePath variable contain too much instance, only remain 12 instances.\r
2694 //\r
2695 if (InstanceNum >= 12) {\r
2696 SetDevicePathEndNode (TempNewDevicePath);\r
2697 break;\r
2698 }\r
2699 }\r
2700 } else {\r
2701 CachedDevicePath = DuplicateDevicePath (BlockIoDevicePath);\r
2702 }\r
2703\r
2704 //\r
2705 // Save the matching Device Path so we don't need to do a connect all next time\r
69fc8f08 2706 // Failure to set the variable only impacts the performance when next time expanding the short-form device path.\r
5c08e117 2707 //\r
2708 Status = gRT->SetVariable (\r
e24fc103
LG
2709 HD_BOOT_DEVICE_PATH_VARIABLE_NAME,\r
2710 &gHdBootDevicePathVariablGuid,\r
f3fc9d8d 2711 EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r
5c08e117 2712 GetDevicePathSize (CachedDevicePath),\r
2713 CachedDevicePath\r
2714 );\r
2715\r
2716 break;\r
2717 }\r
2718 }\r
128efbbc 2719\r
cd730ec0 2720 if (CachedDevicePath != NULL) {\r
2721 FreePool (CachedDevicePath);\r
2722 }\r
5c08e117 2723 if (BlockIoBuffer != NULL) {\r
2724 FreePool (BlockIoBuffer);\r
2725 }\r
2726 return FullDevicePath;\r
2727}\r
2728\r
2729/**\r
2730 Check whether there is a instance in BlockIoDevicePath, which contain multi device path\r
2731 instances, has the same partition node with HardDriveDevicePath device path\r
2732\r
2733 @param BlockIoDevicePath Multi device path instances which need to check\r
2734 @param HardDriveDevicePath A device path which starts with a hard drive media\r
2735 device path.\r
2736\r
2737 @retval TRUE There is a matched device path instance.\r
2738 @retval FALSE There is no matched device path instance.\r
2739\r
2740**/\r
2741BOOLEAN\r
2742EFIAPI\r
2743MatchPartitionDevicePathNode (\r
2744 IN EFI_DEVICE_PATH_PROTOCOL *BlockIoDevicePath,\r
2745 IN HARDDRIVE_DEVICE_PATH *HardDriveDevicePath\r
2746 )\r
2747{\r
2748 HARDDRIVE_DEVICE_PATH *TmpHdPath;\r
2749 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
2750 BOOLEAN Match;\r
2751 EFI_DEVICE_PATH_PROTOCOL *BlockIoHdDevicePathNode;\r
2752\r
2753 if ((BlockIoDevicePath == NULL) || (HardDriveDevicePath == NULL)) {\r
2754 return FALSE;\r
2755 }\r
128efbbc 2756\r
5c08e117 2757 //\r
2758 // Make PreviousDevicePath == the device path node before the end node\r
2759 //\r
2760 DevicePath = BlockIoDevicePath;\r
2761 BlockIoHdDevicePathNode = NULL;\r
2762\r
2763 //\r
2764 // find the partition device path node\r
2765 //\r
2766 while (!IsDevicePathEnd (DevicePath)) {\r
2767 if ((DevicePathType (DevicePath) == MEDIA_DEVICE_PATH) &&\r
2768 (DevicePathSubType (DevicePath) == MEDIA_HARDDRIVE_DP)\r
2769 ) {\r
2770 BlockIoHdDevicePathNode = DevicePath;\r
2771 break;\r
2772 }\r
2773\r
2774 DevicePath = NextDevicePathNode (DevicePath);\r
2775 }\r
2776\r
2777 if (BlockIoHdDevicePathNode == NULL) {\r
2778 return FALSE;\r
2779 }\r
2780 //\r
2781 // See if the harddrive device path in blockio matches the orig Hard Drive Node\r
2782 //\r
2783 TmpHdPath = (HARDDRIVE_DEVICE_PATH *) BlockIoHdDevicePathNode;\r
2784 Match = FALSE;\r
128efbbc 2785\r
5c08e117 2786 //\r
2787 // Check for the match\r
2788 //\r
2789 if ((TmpHdPath->MBRType == HardDriveDevicePath->MBRType) &&\r
2790 (TmpHdPath->SignatureType == HardDriveDevicePath->SignatureType)) {\r
2791 switch (TmpHdPath->SignatureType) {\r
2792 case SIGNATURE_TYPE_GUID:\r
2793 Match = CompareGuid ((EFI_GUID *)TmpHdPath->Signature, (EFI_GUID *)HardDriveDevicePath->Signature);\r
2794 break;\r
2795 case SIGNATURE_TYPE_MBR:\r
2796 Match = (BOOLEAN)(*((UINT32 *)(&(TmpHdPath->Signature[0]))) == ReadUnaligned32((UINT32 *)(&(HardDriveDevicePath->Signature[0]))));\r
2797 break;\r
2798 default:\r
2799 Match = FALSE;\r
2800 break;\r
2801 }\r
2802 }\r
2803\r
2804 return Match;\r
2805}\r
2806\r
2807/**\r
2808 Delete the boot option associated with the handle passed in.\r
2809\r
2810 @param Handle The handle which present the device path to create\r
2811 boot option\r
2812\r
2813 @retval EFI_SUCCESS Delete the boot option success\r
2814 @retval EFI_NOT_FOUND If the Device Path is not found in the system\r
2815 @retval EFI_OUT_OF_RESOURCES Lack of memory resource\r
2816 @retval Other Error return value from SetVariable()\r
2817\r
2818**/\r
2819EFI_STATUS\r
2820BdsLibDeleteOptionFromHandle (\r
2821 IN EFI_HANDLE Handle\r
2822 )\r
2823{\r
2824 UINT16 *BootOrder;\r
2825 UINT8 *BootOptionVar;\r
2826 UINTN BootOrderSize;\r
2827 UINTN BootOptionSize;\r
2828 EFI_STATUS Status;\r
2829 UINTN Index;\r
2830 UINT16 BootOption[BOOT_OPTION_MAX_CHAR];\r
2831 UINTN DevicePathSize;\r
2832 UINTN OptionDevicePathSize;\r
2833 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
2834 EFI_DEVICE_PATH_PROTOCOL *OptionDevicePath;\r
2835 UINT8 *TempPtr;\r
2836\r
2837 Status = EFI_SUCCESS;\r
2838 BootOrder = NULL;\r
2839 BootOrderSize = 0;\r
2840\r
2841 //\r
2842 // Check "BootOrder" variable, if no, means there is no any boot order.\r
2843 //\r
2844 BootOrder = BdsLibGetVariableAndSize (\r
2845 L"BootOrder",\r
2846 &gEfiGlobalVariableGuid,\r
2847 &BootOrderSize\r
2848 );\r
2849 if (BootOrder == NULL) {\r
2850 return EFI_NOT_FOUND;\r
2851 }\r
2852\r
2853 //\r
2854 // Convert device handle to device path protocol instance\r
2855 //\r
2856 DevicePath = DevicePathFromHandle (Handle);\r
2857 if (DevicePath == NULL) {\r
2858 return EFI_NOT_FOUND;\r
2859 }\r
2860 DevicePathSize = GetDevicePathSize (DevicePath);\r
2861\r
2862 //\r
2863 // Loop all boot order variable and find the matching device path\r
2864 //\r
2865 Index = 0;\r
2866 while (Index < BootOrderSize / sizeof (UINT16)) {\r
2867 UnicodeSPrint (BootOption, sizeof (BootOption), L"Boot%04x", BootOrder[Index]);\r
2868 BootOptionVar = BdsLibGetVariableAndSize (\r
2869 BootOption,\r
2870 &gEfiGlobalVariableGuid,\r
2871 &BootOptionSize\r
2872 );\r
128efbbc 2873\r
5c08e117 2874 if (BootOptionVar == NULL) {\r
2875 FreePool (BootOrder);\r
2876 return EFI_OUT_OF_RESOURCES;\r
2877 }\r
2878\r
8c08a567
ED
2879 if (!ValidateOption(BootOptionVar, BootOptionSize)) {\r
2880 BdsDeleteBootOption (BootOrder[Index], BootOrder, &BootOrderSize);\r
2881 FreePool (BootOptionVar);\r
2882 Index++;\r
2883 continue;\r
2884 }\r
2885\r
5c08e117 2886 TempPtr = BootOptionVar;\r
2887 TempPtr += sizeof (UINT32) + sizeof (UINT16);\r
2888 TempPtr += StrSize ((CHAR16 *) TempPtr);\r
2889 OptionDevicePath = (EFI_DEVICE_PATH_PROTOCOL *) TempPtr;\r
2890 OptionDevicePathSize = GetDevicePathSize (OptionDevicePath);\r
2891\r
2892 //\r
2893 // Check whether the device path match\r
2894 //\r
2895 if ((OptionDevicePathSize == DevicePathSize) &&\r
2896 (CompareMem (DevicePath, OptionDevicePath, DevicePathSize) == 0)) {\r
2897 BdsDeleteBootOption (BootOrder[Index], BootOrder, &BootOrderSize);\r
2898 FreePool (BootOptionVar);\r
2899 break;\r
2900 }\r
2901\r
2902 FreePool (BootOptionVar);\r
2903 Index++;\r
2904 }\r
2905\r
2906 //\r
2907 // Adjust number of boot option for "BootOrder" variable.\r
2908 //\r
2909 Status = gRT->SetVariable (\r
2910 L"BootOrder",\r
2911 &gEfiGlobalVariableGuid,\r
2912 EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r
2913 BootOrderSize,\r
2914 BootOrder\r
2915 );\r
69fc8f08
RN
2916 //\r
2917 // Shrinking variable with existing variable implementation shouldn't fail.\r
2918 //\r
2919 ASSERT_EFI_ERROR (Status);\r
5c08e117 2920\r
2921 FreePool (BootOrder);\r
2922\r
2923 return Status;\r
2924}\r
2925\r
2926\r
2927/**\r
3384a9bc 2928 Delete all invalid EFI boot options.\r
5c08e117 2929\r
2930 @retval EFI_SUCCESS Delete all invalid boot option success\r
2931 @retval EFI_NOT_FOUND Variable "BootOrder" is not found\r
2932 @retval EFI_OUT_OF_RESOURCES Lack of memory resource\r
2933 @retval Other Error return value from SetVariable()\r
2934\r
2935**/\r
2936EFI_STATUS\r
2937BdsDeleteAllInvalidEfiBootOption (\r
2938 VOID\r
2939 )\r
2940{\r
2941 UINT16 *BootOrder;\r
2942 UINT8 *BootOptionVar;\r
2943 UINTN BootOrderSize;\r
2944 UINTN BootOptionSize;\r
2945 EFI_STATUS Status;\r
2946 UINTN Index;\r
2947 UINTN Index2;\r
2948 UINT16 BootOption[BOOT_OPTION_MAX_CHAR];\r
2949 EFI_DEVICE_PATH_PROTOCOL *OptionDevicePath;\r
2950 UINT8 *TempPtr;\r
3384a9bc 2951 CHAR16 *Description;\r
8c08a567 2952 BOOLEAN Corrupted;\r
5c08e117 2953\r
8c08a567
ED
2954 Status = EFI_SUCCESS;\r
2955 BootOrder = NULL;\r
2956 Description = NULL;\r
2957 OptionDevicePath = NULL;\r
2958 BootOrderSize = 0;\r
2959 Corrupted = FALSE;\r
5c08e117 2960\r
2961 //\r
2962 // Check "BootOrder" variable firstly, this variable hold the number of boot options\r
2963 //\r
2964 BootOrder = BdsLibGetVariableAndSize (\r
2965 L"BootOrder",\r
2966 &gEfiGlobalVariableGuid,\r
2967 &BootOrderSize\r
2968 );\r
2969 if (NULL == BootOrder) {\r
2970 return EFI_NOT_FOUND;\r
2971 }\r
2972\r
2973 Index = 0;\r
2974 while (Index < BootOrderSize / sizeof (UINT16)) {\r
2975 UnicodeSPrint (BootOption, sizeof (BootOption), L"Boot%04x", BootOrder[Index]);\r
2976 BootOptionVar = BdsLibGetVariableAndSize (\r
2977 BootOption,\r
2978 &gEfiGlobalVariableGuid,\r
2979 &BootOptionSize\r
2980 );\r
2981 if (NULL == BootOptionVar) {\r
2982 FreePool (BootOrder);\r
2983 return EFI_OUT_OF_RESOURCES;\r
2984 }\r
2985\r
8c08a567
ED
2986 if (!ValidateOption(BootOptionVar, BootOptionSize)) {\r
2987 Corrupted = TRUE;\r
2988 } else {\r
2989 TempPtr = BootOptionVar;\r
2990 TempPtr += sizeof (UINT32) + sizeof (UINT16);\r
2991 Description = (CHAR16 *) TempPtr;\r
2992 TempPtr += StrSize ((CHAR16 *) TempPtr);\r
2993 OptionDevicePath = (EFI_DEVICE_PATH_PROTOCOL *) TempPtr;\r
5c08e117 2994\r
8c08a567
ED
2995 //\r
2996 // Skip legacy boot option (BBS boot device)\r
2997 //\r
2998 if ((DevicePathType (OptionDevicePath) == BBS_DEVICE_PATH) &&\r
2999 (DevicePathSubType (OptionDevicePath) == BBS_BBS_DP)) {\r
3000 FreePool (BootOptionVar);\r
3001 Index++;\r
3002 continue;\r
3003 }\r
5c08e117 3004 }\r
3005\r
8c08a567 3006 if (Corrupted || !BdsLibIsValidEFIBootOptDevicePathExt (OptionDevicePath, FALSE, Description)) {\r
5c08e117 3007 //\r
3008 // Delete this invalid boot option "Boot####"\r
3009 //\r
3010 Status = gRT->SetVariable (\r
3011 BootOption,\r
3012 &gEfiGlobalVariableGuid,\r
3013 EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r
3014 0,\r
3015 NULL\r
3016 );\r
3017 //\r
69fc8f08
RN
3018 // Deleting variable with current variable implementation shouldn't fail.\r
3019 //\r
3020 ASSERT_EFI_ERROR (Status);\r
3021 //\r
5c08e117 3022 // Mark this boot option in boot order as deleted\r
3023 //\r
3024 BootOrder[Index] = 0xffff;\r
8c08a567 3025 Corrupted = FALSE;\r
5c08e117 3026 }\r
3027\r
3028 FreePool (BootOptionVar);\r
3029 Index++;\r
3030 }\r
3031\r
3032 //\r
3033 // Adjust boot order array\r
3034 //\r
3035 Index2 = 0;\r
3036 for (Index = 0; Index < BootOrderSize / sizeof (UINT16); Index++) {\r
3037 if (BootOrder[Index] != 0xffff) {\r
3038 BootOrder[Index2] = BootOrder[Index];\r
3039 Index2 ++;\r
3040 }\r
3041 }\r
3042 Status = gRT->SetVariable (\r
3043 L"BootOrder",\r
3044 &gEfiGlobalVariableGuid,\r
3045 EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r
3046 Index2 * sizeof (UINT16),\r
3047 BootOrder\r
3048 );\r
69fc8f08
RN
3049 //\r
3050 // Shrinking variable with current variable implementation shouldn't fail.\r
3051 //\r
3052 ASSERT_EFI_ERROR (Status);\r
5c08e117 3053\r
3054 FreePool (BootOrder);\r
3055\r
3056 return Status;\r
3057}\r
3058\r
3059\r
3060/**\r
3384a9bc 3061 For EFI boot option, BDS separate them as six types:\r
128efbbc 3062 1. Network - The boot option points to the SimpleNetworkProtocol device.\r
3384a9bc 3063 Bds will try to automatically create this type boot option when enumerate.\r
128efbbc 3064 2. Shell - The boot option points to internal flash shell.\r
3384a9bc 3065 Bds will try to automatically create this type boot option when enumerate.\r
3066 3. Removable BlockIo - The boot option only points to the removable media\r
3067 device, like USB flash disk, DVD, Floppy etc.\r
3068 These device should contain a *removable* blockIo\r
3069 protocol in their device handle.\r
128efbbc 3070 Bds will try to automatically create this type boot option\r
3384a9bc 3071 when enumerate.\r
128efbbc 3072 4. Fixed BlockIo - The boot option only points to a Fixed blockIo device,\r
3384a9bc 3073 like HardDisk.\r
3074 These device should contain a *fixed* blockIo\r
3075 protocol in their device handle.\r
3076 BDS will skip fixed blockIo devices, and NOT\r
128efbbc 3077 automatically create boot option for them. But BDS\r
3078 will help to delete those fixed blockIo boot option,\r
3384a9bc 3079 whose description rule conflict with other auto-created\r
3080 boot options.\r
128efbbc 3081 5. Non-BlockIo Simplefile - The boot option points to a device whose handle\r
3384a9bc 3082 has SimpleFileSystem Protocol, but has no blockio\r
3083 protocol. These devices do not offer blockIo\r
128efbbc 3084 protocol, but BDS still can get the\r
3384a9bc 3085 \EFI\BOOT\boot{machinename}.EFI by SimpleFileSystem\r
3086 Protocol.\r
128efbbc 3087 6. File - The boot option points to a file. These boot options are usually\r
3384a9bc 3088 created by user manually or OS loader. BDS will not delete or modify\r
128efbbc 3089 these boot options.\r
3090\r
3384a9bc 3091 This function will enumerate all possible boot device in the system, and\r
128efbbc 3092 automatically create boot options for Network, Shell, Removable BlockIo,\r
3384a9bc 3093 and Non-BlockIo Simplefile devices.\r
8d3b5aff 3094 It will only execute once of every boot.\r
128efbbc 3095\r
5c08e117 3096 @param BdsBootOptionList The header of the link list which indexed all\r
3097 current boot options\r
3098\r
3099 @retval EFI_SUCCESS Finished all the boot device enumerate and create\r
3100 the boot option base on that boot device\r
3101\r
e83c9064 3102 @retval EFI_OUT_OF_RESOURCES Failed to enumerate the boot device and create the boot option list\r
5c08e117 3103**/\r
3104EFI_STATUS\r
3105EFIAPI\r
3106BdsLibEnumerateAllBootOption (\r
3107 IN OUT LIST_ENTRY *BdsBootOptionList\r
3108 )\r
3109{\r
3110 EFI_STATUS Status;\r
3111 UINT16 FloppyNumber;\r
889a4bc2 3112 UINT16 HarddriveNumber;\r
5c08e117 3113 UINT16 CdromNumber;\r
3114 UINT16 UsbNumber;\r
3115 UINT16 MiscNumber;\r
8d3b5aff 3116 UINT16 ScsiNumber;\r
5c08e117 3117 UINT16 NonBlockNumber;\r
3118 UINTN NumberBlockIoHandles;\r
3119 EFI_HANDLE *BlockIoHandles;\r
3120 EFI_BLOCK_IO_PROTOCOL *BlkIo;\r
35bc0e9f
RN
3121 BOOLEAN Removable[2];\r
3122 UINTN RemovableIndex;\r
5c08e117 3123 UINTN Index;\r
a7a523e0 3124 UINTN NumOfLoadFileHandles;\r
3125 EFI_HANDLE *LoadFileHandles;\r
5c08e117 3126 UINTN FvHandleCount;\r
3127 EFI_HANDLE *FvHandleBuffer;\r
3128 EFI_FV_FILETYPE Type;\r
3129 UINTN Size;\r
3130 EFI_FV_FILE_ATTRIBUTES Attributes;\r
3131 UINT32 AuthenticationStatus;\r
8d3b5aff 3132 EFI_FIRMWARE_VOLUME2_PROTOCOL *Fv;\r
3133 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
5c08e117 3134 UINTN DevicePathType;\r
3135 CHAR16 Buffer[40];\r
3136 EFI_HANDLE *FileSystemHandles;\r
3137 UINTN NumberFileSystemHandles;\r
3138 BOOLEAN NeedDelete;\r
3139 EFI_IMAGE_DOS_HEADER DosHeader;\r
9aa7ba01 3140 CHAR8 *PlatLang;\r
3141 CHAR8 *LastLang;\r
5c08e117 3142 EFI_IMAGE_OPTIONAL_HEADER_UNION HdrData;\r
3143 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr;\r
3144\r
889a4bc2
RN
3145 FloppyNumber = 0;\r
3146 HarddriveNumber = 0;\r
3147 CdromNumber = 0;\r
3148 UsbNumber = 0;\r
3149 MiscNumber = 0;\r
3150 ScsiNumber = 0;\r
3151 PlatLang = NULL;\r
3152 LastLang = NULL;\r
5c08e117 3153 ZeroMem (Buffer, sizeof (Buffer));\r
128efbbc 3154\r
5c08e117 3155 //\r
3156 // If the boot device enumerate happened, just get the boot\r
3157 // device from the boot order variable\r
3158 //\r
3159 if (mEnumBootDevice) {\r
f01b91ae
ED
3160 GetVariable2 (LAST_ENUM_LANGUAGE_VARIABLE_NAME, &gLastEnumLangGuid, (VOID**)&LastLang, NULL);\r
3161 GetEfiGlobalVariable2 (L"PlatformLang", (VOID**)&PlatLang, NULL);\r
0fa3ac1b
RN
3162 ASSERT (PlatLang != NULL);\r
3163 if ((LastLang != NULL) && (AsciiStrCmp (LastLang, PlatLang) == 0)) {\r
9aa7ba01 3164 Status = BdsLibBuildOptionFromVar (BdsBootOptionList, L"BootOrder");\r
0fa3ac1b
RN
3165 FreePool (LastLang);\r
3166 FreePool (PlatLang);\r
9aa7ba01 3167 return Status;\r
3168 } else {\r
3169 Status = gRT->SetVariable (\r
e24fc103
LG
3170 LAST_ENUM_LANGUAGE_VARIABLE_NAME,\r
3171 &gLastEnumLangGuid,\r
9aa7ba01 3172 EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r
0fa3ac1b 3173 AsciiStrSize (PlatLang),\r
9aa7ba01 3174 PlatLang\r
3175 );\r
69fc8f08
RN
3176 //\r
3177 // Failure to set the variable only impacts the performance next time enumerating the boot options.\r
3178 //\r
0fa3ac1b
RN
3179\r
3180 if (LastLang != NULL) {\r
3181 FreePool (LastLang);\r
3182 }\r
3183 FreePool (PlatLang);\r
9aa7ba01 3184 }\r
5c08e117 3185 }\r
128efbbc 3186\r
5c08e117 3187 //\r
3188 // Notes: this dirty code is to get the legacy boot option from the\r
3189 // BBS table and create to variable as the EFI boot option, it should\r
3190 // be removed after the CSM can provide legacy boot option directly\r
3191 //\r
3192 REFRESH_LEGACY_BOOT_OPTIONS;\r
3193\r
3194 //\r
3195 // Delete invalid boot option\r
3196 //\r
3197 BdsDeleteAllInvalidEfiBootOption ();\r
128efbbc 3198\r
5c08e117 3199 //\r
701e17e5
RN
3200 // Parse removable media followed by fixed media.\r
3201 // The Removable[] array is used by the for-loop below to create removable media boot options \r
3202 // at first, and then to create fixed media boot options.\r
5c08e117 3203 //\r
701e17e5
RN
3204 Removable[0] = FALSE;\r
3205 Removable[1] = TRUE;\r
3206\r
5c08e117 3207 gBS->LocateHandleBuffer (\r
3208 ByProtocol,\r
3209 &gEfiBlockIoProtocolGuid,\r
3210 NULL,\r
3211 &NumberBlockIoHandles,\r
3212 &BlockIoHandles\r
3213 );\r
128efbbc 3214\r
35bc0e9f
RN
3215 for (RemovableIndex = 0; RemovableIndex < 2; RemovableIndex++) {\r
3216 for (Index = 0; Index < NumberBlockIoHandles; Index++) {\r
3217 Status = gBS->HandleProtocol (\r
3218 BlockIoHandles[Index],\r
3219 &gEfiBlockIoProtocolGuid,\r
3220 (VOID **) &BlkIo\r
3221 );\r
3222 //\r
7d84fbbb 3223 // skip the logical partition\r
35bc0e9f 3224 //\r
7d84fbbb
RN
3225 if (EFI_ERROR (Status) || BlkIo->Media->LogicalPartition) {\r
3226 continue;\r
3227 }\r
3228\r
3229 //\r
3230 // firstly fixed block io then the removable block io\r
3231 //\r
3232 if (BlkIo->Media->RemovableMedia == Removable[RemovableIndex]) {\r
5c08e117 3233 continue;\r
3234 }\r
35bc0e9f
RN
3235 DevicePath = DevicePathFromHandle (BlockIoHandles[Index]);\r
3236 DevicePathType = BdsGetBootTypeFromDevicePath (DevicePath);\r
5c08e117 3237\r
35bc0e9f
RN
3238 switch (DevicePathType) {\r
3239 case BDS_EFI_ACPI_FLOPPY_BOOT:\r
3240 if (FloppyNumber != 0) {\r
3241 UnicodeSPrint (Buffer, sizeof (Buffer), L"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_FLOPPY)), FloppyNumber);\r
3242 } else {\r
3243 UnicodeSPrint (Buffer, sizeof (Buffer), L"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_FLOPPY)));\r
3244 }\r
3245 BdsLibBuildOptionFromHandle (BlockIoHandles[Index], BdsBootOptionList, Buffer);\r
3246 FloppyNumber++;\r
3247 break;\r
128efbbc 3248\r
35bc0e9f 3249 //\r
889a4bc2 3250 // Assume a removable SATA device should be the DVD/CD device, a fixed SATA device should be the Hard Drive device.\r
35bc0e9f
RN
3251 //\r
3252 case BDS_EFI_MESSAGE_ATAPI_BOOT:\r
3253 case BDS_EFI_MESSAGE_SATA_BOOT:\r
889a4bc2
RN
3254 if (BlkIo->Media->RemovableMedia) {\r
3255 if (CdromNumber != 0) {\r
3256 UnicodeSPrint (Buffer, sizeof (Buffer), L"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_CD_DVD)), CdromNumber);\r
3257 } else {\r
3258 UnicodeSPrint (Buffer, sizeof (Buffer), L"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_CD_DVD)));\r
3259 }\r
3260 CdromNumber++;\r
35bc0e9f 3261 } else {\r
889a4bc2
RN
3262 if (HarddriveNumber != 0) {\r
3263 UnicodeSPrint (Buffer, sizeof (Buffer), L"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_HARDDRIVE)), HarddriveNumber);\r
3264 } else {\r
3265 UnicodeSPrint (Buffer, sizeof (Buffer), L"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_HARDDRIVE)));\r
3266 }\r
3267 HarddriveNumber++;\r
35bc0e9f
RN
3268 }\r
3269 DEBUG ((DEBUG_INFO | DEBUG_LOAD, "Buffer: %S\n", Buffer));\r
3270 BdsLibBuildOptionFromHandle (BlockIoHandles[Index], BdsBootOptionList, Buffer);\r
35bc0e9f
RN
3271 break;\r
3272\r
3273 case BDS_EFI_MESSAGE_USB_DEVICE_BOOT:\r
3274 if (UsbNumber != 0) {\r
3275 UnicodeSPrint (Buffer, sizeof (Buffer), L"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_USB)), UsbNumber);\r
3276 } else {\r
3277 UnicodeSPrint (Buffer, sizeof (Buffer), L"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_USB)));\r
3278 }\r
3279 BdsLibBuildOptionFromHandle (BlockIoHandles[Index], BdsBootOptionList, Buffer);\r
3280 UsbNumber++;\r
3281 break;\r
5c08e117 3282\r
35bc0e9f
RN
3283 case BDS_EFI_MESSAGE_SCSI_BOOT:\r
3284 if (ScsiNumber != 0) {\r
3285 UnicodeSPrint (Buffer, sizeof (Buffer), L"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_SCSI)), ScsiNumber);\r
3286 } else {\r
3287 UnicodeSPrint (Buffer, sizeof (Buffer), L"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_SCSI)));\r
3288 }\r
3289 BdsLibBuildOptionFromHandle (BlockIoHandles[Index], BdsBootOptionList, Buffer);\r
3290 ScsiNumber++;\r
3291 break;\r
5c08e117 3292\r
35bc0e9f 3293 case BDS_EFI_MESSAGE_MISC_BOOT:\r
277fe9aa 3294 default:\r
35bc0e9f
RN
3295 if (MiscNumber != 0) {\r
3296 UnicodeSPrint (Buffer, sizeof (Buffer), L"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_MISC)), MiscNumber);\r
3297 } else {\r
3298 UnicodeSPrint (Buffer, sizeof (Buffer), L"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_MISC)));\r
3299 }\r
3300 BdsLibBuildOptionFromHandle (BlockIoHandles[Index], BdsBootOptionList, Buffer);\r
3301 MiscNumber++;\r
3302 break;\r
9aa7ba01 3303 }\r
5c08e117 3304 }\r
3305 }\r
3306\r
3307 if (NumberBlockIoHandles != 0) {\r
3308 FreePool (BlockIoHandles);\r
3309 }\r
3310\r
3311 //\r
3312 // If there is simple file protocol which does not consume block Io protocol, create a boot option for it here.\r
3313 //\r
3314 NonBlockNumber = 0;\r
3315 gBS->LocateHandleBuffer (\r
3316 ByProtocol,\r
3317 &gEfiSimpleFileSystemProtocolGuid,\r
3318 NULL,\r
3319 &NumberFileSystemHandles,\r
3320 &FileSystemHandles\r
3321 );\r
3322 for (Index = 0; Index < NumberFileSystemHandles; Index++) {\r
3323 Status = gBS->HandleProtocol (\r
3324 FileSystemHandles[Index],\r
3325 &gEfiBlockIoProtocolGuid,\r
3326 (VOID **) &BlkIo\r
3327 );\r
3328 if (!EFI_ERROR (Status)) {\r
3329 //\r
3330 // Skip if the file system handle supports a BlkIo protocol,\r
3331 //\r
3332 continue;\r
3333 }\r
3334\r
3335 //\r
3336 // Do the removable Media thing. \EFI\BOOT\boot{machinename}.EFI\r
3337 // machinename is ia32, ia64, x64, ...\r
3338 //\r
35bc0e9f 3339 Hdr.Union = &HdrData;\r
5c08e117 3340 NeedDelete = TRUE;\r
3341 Status = BdsLibGetImageHeader (\r
3342 FileSystemHandles[Index],\r
c62dbf31 3343 EFI_REMOVABLE_MEDIA_FILE_NAME,\r
5c08e117 3344 &DosHeader,\r
3345 Hdr\r
3346 );\r
3347 if (!EFI_ERROR (Status) &&\r
3348 EFI_IMAGE_MACHINE_TYPE_SUPPORTED (Hdr.Pe32->FileHeader.Machine) &&\r
3349 Hdr.Pe32->OptionalHeader.Subsystem == EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION) {\r
3350 NeedDelete = FALSE;\r
3351 }\r
3352\r
3353 if (NeedDelete) {\r
3354 //\r
3355 // No such file or the file is not a EFI application, delete this boot option\r
3356 //\r
3357 BdsLibDeleteOptionFromHandle (FileSystemHandles[Index]);\r
3358 } else {\r
9aa7ba01 3359 if (NonBlockNumber != 0) {\r
3360 UnicodeSPrint (Buffer, sizeof (Buffer), L"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NON_BLOCK)), NonBlockNumber);\r
3361 } else {\r
3362 UnicodeSPrint (Buffer, sizeof (Buffer), L"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NON_BLOCK)));\r
3363 }\r
5c08e117 3364 BdsLibBuildOptionFromHandle (FileSystemHandles[Index], BdsBootOptionList, Buffer);\r
3365 NonBlockNumber++;\r
3366 }\r
3367 }\r
3368\r
3369 if (NumberFileSystemHandles != 0) {\r
3370 FreePool (FileSystemHandles);\r
3371 }\r
3372\r
3373 //\r
3374 // Parse Network Boot Device\r
3375 //\r
a7a523e0 3376 NumOfLoadFileHandles = 0;\r
ff482c56 3377 //\r
a7a523e0 3378 // Search Load File protocol for PXE boot option.\r
ff482c56 3379 //\r
5c08e117 3380 gBS->LocateHandleBuffer (\r
3381 ByProtocol,\r
a7a523e0 3382 &gEfiLoadFileProtocolGuid,\r
5c08e117 3383 NULL,\r
a7a523e0 3384 &NumOfLoadFileHandles,\r
3385 &LoadFileHandles\r
5c08e117 3386 );\r
8d3b5aff 3387\r
a7a523e0 3388 for (Index = 0; Index < NumOfLoadFileHandles; Index++) {\r
9aa7ba01 3389 if (Index != 0) {\r
3390 UnicodeSPrint (Buffer, sizeof (Buffer), L"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NETWORK)), Index);\r
3391 } else {\r
3392 UnicodeSPrint (Buffer, sizeof (Buffer), L"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NETWORK)));\r
3393 }\r
a7a523e0 3394 BdsLibBuildOptionFromHandle (LoadFileHandles[Index], BdsBootOptionList, Buffer);\r
5c08e117 3395 }\r
3396\r
a7a523e0 3397 if (NumOfLoadFileHandles != 0) {\r
3398 FreePool (LoadFileHandles);\r
5c08e117 3399 }\r
3400\r
3401 //\r
3402 // Check if we have on flash shell\r
3403 //\r
3404 gBS->LocateHandleBuffer (\r
3405 ByProtocol,\r
3406 &gEfiFirmwareVolume2ProtocolGuid,\r
3407 NULL,\r
3408 &FvHandleCount,\r
3409 &FvHandleBuffer\r
3410 );\r
3411 for (Index = 0; Index < FvHandleCount; Index++) {\r
5c08e117 3412 gBS->HandleProtocol (\r
3413 FvHandleBuffer[Index],\r
3414 &gEfiFirmwareVolume2ProtocolGuid,\r
3415 (VOID **) &Fv\r
3416 );\r
3417\r
3418 Status = Fv->ReadFile (\r
3419 Fv,\r
d46f3632 3420 PcdGetPtr(PcdShellFile),\r
5c08e117 3421 NULL,\r
3422 &Size,\r
3423 &Type,\r
3424 &Attributes,\r
3425 &AuthenticationStatus\r
3426 );\r
3427 if (EFI_ERROR (Status)) {\r
3428 //\r
3429 // Skip if no shell file in the FV\r
3430 //\r
3431 continue;\r
3432 }\r
3433 //\r
3434 // Build the shell boot option\r
3435 //\r
3436 BdsLibBuildOptionFromShell (FvHandleBuffer[Index], BdsBootOptionList);\r
3437 }\r
3438\r
3439 if (FvHandleCount != 0) {\r
3440 FreePool (FvHandleBuffer);\r
3441 }\r
3442 //\r
3443 // Make sure every boot only have one time\r
3444 // boot device enumerate\r
3445 //\r
e83c9064 3446 Status = BdsLibBuildOptionFromVar (BdsBootOptionList, L"BootOrder");\r
5c08e117 3447 mEnumBootDevice = TRUE;\r
3448\r
e83c9064 3449 return Status;\r
5c08e117 3450}\r
3451\r
3452/**\r
3453 Build the boot option with the handle parsed in\r
3454\r
3455 @param Handle The handle which present the device path to create\r
3456 boot option\r
3457 @param BdsBootOptionList The header of the link list which indexed all\r
3458 current boot options\r
3459 @param String The description of the boot option.\r
3460\r
3461**/\r
3462VOID\r
3463EFIAPI\r
3464BdsLibBuildOptionFromHandle (\r
3465 IN EFI_HANDLE Handle,\r
3466 IN LIST_ENTRY *BdsBootOptionList,\r
3467 IN CHAR16 *String\r
3468 )\r
3469{\r
3470 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
128efbbc 3471\r
8d3b5aff 3472 DevicePath = DevicePathFromHandle (Handle);\r
5c08e117 3473\r
3474 //\r
3475 // Create and register new boot option\r
3476 //\r
3477 BdsLibRegisterNewOption (BdsBootOptionList, DevicePath, String, L"BootOrder");\r
3478}\r
3479\r
3480\r
3481/**\r
3482 Build the on flash shell boot option with the handle parsed in.\r
3483\r
3484 @param Handle The handle which present the device path to create\r
3485 on flash shell boot option\r
3486 @param BdsBootOptionList The header of the link list which indexed all\r
3487 current boot options\r
3488\r
3489**/\r
3490VOID\r
3491EFIAPI\r
3492BdsLibBuildOptionFromShell (\r
3493 IN EFI_HANDLE Handle,\r
3494 IN OUT LIST_ENTRY *BdsBootOptionList\r
3495 )\r
3496{\r
3497 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
3498 MEDIA_FW_VOL_FILEPATH_DEVICE_PATH ShellNode;\r
3499\r
3500 DevicePath = DevicePathFromHandle (Handle);\r
3501\r
3502 //\r
3503 // Build the shell device path\r
3504 //\r
d46f3632 3505 EfiInitializeFwVolDevicepathNode (&ShellNode, PcdGetPtr(PcdShellFile));\r
5c08e117 3506\r
3507 DevicePath = AppendDevicePathNode (DevicePath, (EFI_DEVICE_PATH_PROTOCOL *) &ShellNode);\r
3508\r
3509 //\r
3510 // Create and register the shell boot option\r
3511 //\r
3512 BdsLibRegisterNewOption (BdsBootOptionList, DevicePath, L"EFI Internal Shell", L"BootOrder");\r
3513\r
3514}\r
3515\r
3516/**\r
3517 Boot from the UEFI spec defined "BootNext" variable.\r
3518\r
3519**/\r
3520VOID\r
3521EFIAPI\r
3522BdsLibBootNext (\r
3523 VOID\r
3524 )\r
3525{\r
69fc8f08 3526 EFI_STATUS Status;\r
5c08e117 3527 UINT16 *BootNext;\r
3528 UINTN BootNextSize;\r
3529 CHAR16 Buffer[20];\r
3530 BDS_COMMON_OPTION *BootOption;\r
3531 LIST_ENTRY TempList;\r
3532 UINTN ExitDataSize;\r
3533 CHAR16 *ExitData;\r
3534\r
3535 //\r
3536 // Init the boot option name buffer and temp link list\r
3537 //\r
3538 InitializeListHead (&TempList);\r
3539 ZeroMem (Buffer, sizeof (Buffer));\r
3540\r
3541 BootNext = BdsLibGetVariableAndSize (\r
3542 L"BootNext",\r
3543 &gEfiGlobalVariableGuid,\r
3544 &BootNextSize\r
3545 );\r
3546\r
3547 //\r
3548 // Clear the boot next variable first\r
3549 //\r
3550 if (BootNext != NULL) {\r
69fc8f08
RN
3551 Status = gRT->SetVariable (\r
3552 L"BootNext",\r
3553 &gEfiGlobalVariableGuid,\r
3554 EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r
3555 0,\r
3556 NULL\r
3557 );\r
3558 //\r
3559 // Deleting variable with current variable implementation shouldn't fail.\r
3560 //\r
3561 ASSERT_EFI_ERROR (Status);\r
5c08e117 3562\r
3563 //\r
3564 // Start to build the boot option and try to boot\r
3565 //\r
3566 UnicodeSPrint (Buffer, sizeof (Buffer), L"Boot%04x", *BootNext);\r
3567 BootOption = BdsLibVariableToOption (&TempList, Buffer);\r
3568 ASSERT (BootOption != NULL);\r
3569 BdsLibConnectDevicePath (BootOption->DevicePath);\r
3570 BdsLibBootViaBootOption (BootOption, BootOption->DevicePath, &ExitDataSize, &ExitData);\r
3571 }\r
3572\r
3573}\r
3574\r
3575/**\r
3576 Return the bootable media handle.\r
3577 First, check the device is connected\r
3578 Second, check whether the device path point to a device which support SimpleFileSystemProtocol,\r
3579 Third, detect the the default boot file in the Media, and return the removable Media handle.\r
3580\r
e83c9064 3581 @param DevicePath Device Path to a bootable device\r
5c08e117 3582\r
e83c9064 3583 @return The bootable media handle. If the media on the DevicePath is not bootable, NULL will return.\r
5c08e117 3584\r
3585**/\r
3586EFI_HANDLE\r
3587EFIAPI\r
3588BdsLibGetBootableHandle (\r
3589 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
3590 )\r
3591{\r
3592 EFI_STATUS Status;\r
ef949581 3593 EFI_TPL OldTpl;\r
5c08e117 3594 EFI_DEVICE_PATH_PROTOCOL *UpdatedDevicePath;\r
3595 EFI_DEVICE_PATH_PROTOCOL *DupDevicePath;\r
3596 EFI_HANDLE Handle;\r
3597 EFI_BLOCK_IO_PROTOCOL *BlockIo;\r
3598 VOID *Buffer;\r
3599 EFI_DEVICE_PATH_PROTOCOL *TempDevicePath;\r
3600 UINTN Size;\r
3601 UINTN TempSize;\r
3602 EFI_HANDLE ReturnHandle;\r
3603 EFI_HANDLE *SimpleFileSystemHandles;\r
3604\r
3605 UINTN NumberSimpleFileSystemHandles;\r
3606 UINTN Index;\r
3607 EFI_IMAGE_DOS_HEADER DosHeader;\r
3608 EFI_IMAGE_OPTIONAL_HEADER_UNION HdrData;\r
3609 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr;\r
3610\r
3611 UpdatedDevicePath = DevicePath;\r
128efbbc 3612\r
ef949581
RN
3613 //\r
3614 // Enter to critical section to protect the acquired BlockIo instance \r
3615 // from getting released due to the USB mass storage hotplug event\r
3616 //\r
3617 OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
3618\r
5c08e117 3619 //\r
3620 // Check whether the device is connected\r
3621 //\r
3622 Status = gBS->LocateDevicePath (&gEfiBlockIoProtocolGuid, &UpdatedDevicePath, &Handle);\r
3623 if (EFI_ERROR (Status)) {\r
3624 //\r
3625 // Skip the case that the boot option point to a simple file protocol which does not consume block Io protocol,\r
3626 //\r
3627 Status = gBS->LocateDevicePath (&gEfiSimpleFileSystemProtocolGuid, &UpdatedDevicePath, &Handle);\r
3628 if (EFI_ERROR (Status)) {\r
3629 //\r
3630 // Fail to find the proper BlockIo and simple file protocol, maybe because device not present, we need to connect it firstly\r
3631 //\r
3632 UpdatedDevicePath = DevicePath;\r
3633 Status = gBS->LocateDevicePath (&gEfiDevicePathProtocolGuid, &UpdatedDevicePath, &Handle);\r
3634 gBS->ConnectController (Handle, NULL, NULL, TRUE);\r
3635 }\r
3636 } else {\r
e74f510b
RN
3637 //\r
3638 // For removable device boot option, its contained device path only point to the removable device handle, \r
3639 // should make sure all its children handles (its child partion or media handles) are created and connected. \r
3640 //\r
3641 gBS->ConnectController (Handle, NULL, NULL, TRUE); \r
5c08e117 3642 //\r
3643 // Get BlockIo protocol and check removable attribute\r
3644 //\r
3645 Status = gBS->HandleProtocol (Handle, &gEfiBlockIoProtocolGuid, (VOID **)&BlockIo);\r
ef949581
RN
3646 ASSERT_EFI_ERROR (Status);\r
3647\r
5c08e117 3648 //\r
3649 // Issue a dummy read to the device to check for media change.\r
3650 // When the removable media is changed, any Block IO read/write will\r
3651 // cause the BlockIo protocol be reinstalled and EFI_MEDIA_CHANGED is\r
3652 // returned. After the Block IO protocol is reinstalled, subsequent\r
3653 // Block IO read/write will success.\r
3654 //\r
3655 Buffer = AllocatePool (BlockIo->Media->BlockSize);\r
3656 if (Buffer != NULL) {\r
3657 BlockIo->ReadBlocks (\r
3658 BlockIo,\r
3659 BlockIo->Media->MediaId,\r
3660 0,\r
3661 BlockIo->Media->BlockSize,\r
3662 Buffer\r
3663 );\r
3664 FreePool(Buffer);\r
3665 }\r
3666 }\r
3667\r
3668 //\r
3669 // Detect the the default boot file from removable Media\r
3670 //\r
3671\r
3672 //\r
3673 // If fail to get bootable handle specified by a USB boot option, the BDS should try to find other bootable device in the same USB bus\r
3674 // Try to locate the USB node device path first, if fail then use its previous PCI node to search\r
3675 //\r
3676 DupDevicePath = DuplicateDevicePath (DevicePath);\r
3677 ASSERT (DupDevicePath != NULL);\r
128efbbc 3678\r
5c08e117 3679 UpdatedDevicePath = DupDevicePath;\r
3680 Status = gBS->LocateDevicePath (&gEfiDevicePathProtocolGuid, &UpdatedDevicePath, &Handle);\r
3681 //\r
3682 // if the resulting device path point to a usb node, and the usb node is a dummy node, should only let device path only point to the previous Pci node\r
3683 // Acpi()/Pci()/Usb() --> Acpi()/Pci()\r
3684 //\r
3685 if ((DevicePathType (UpdatedDevicePath) == MESSAGING_DEVICE_PATH) &&\r
3686 (DevicePathSubType (UpdatedDevicePath) == MSG_USB_DP)) {\r
3687 //\r
3688 // Remove the usb node, let the device path only point to PCI node\r
3689 //\r
3690 SetDevicePathEndNode (UpdatedDevicePath);\r
3691 UpdatedDevicePath = DupDevicePath;\r
3692 } else {\r
3693 UpdatedDevicePath = DevicePath;\r
3694 }\r
3695\r
3696 //\r
3697 // Get the device path size of boot option\r
3698 //\r
3699 Size = GetDevicePathSize(UpdatedDevicePath) - sizeof (EFI_DEVICE_PATH_PROTOCOL); // minus the end node\r
3700 ReturnHandle = NULL;\r
3701 gBS->LocateHandleBuffer (\r
3702 ByProtocol,\r
3703 &gEfiSimpleFileSystemProtocolGuid,\r
3704 NULL,\r
3705 &NumberSimpleFileSystemHandles,\r
3706 &SimpleFileSystemHandles\r
3707 );\r
3708 for (Index = 0; Index < NumberSimpleFileSystemHandles; Index++) {\r
3709 //\r
3710 // Get the device path size of SimpleFileSystem handle\r
3711 //\r
3712 TempDevicePath = DevicePathFromHandle (SimpleFileSystemHandles[Index]);\r
3713 TempSize = GetDevicePathSize (TempDevicePath)- sizeof (EFI_DEVICE_PATH_PROTOCOL); // minus the end node\r
3714 //\r
3715 // Check whether the device path of boot option is part of the SimpleFileSystem handle's device path\r
3716 //\r
3717 if (Size <= TempSize && CompareMem (TempDevicePath, UpdatedDevicePath, Size)==0) {\r
3718 //\r
3719 // Load the default boot file \EFI\BOOT\boot{machinename}.EFI from removable Media\r
3720 // machinename is ia32, ia64, x64, ...\r
3721 //\r
3722 Hdr.Union = &HdrData;\r
3723 Status = BdsLibGetImageHeader (\r
3724 SimpleFileSystemHandles[Index],\r
c62dbf31 3725 EFI_REMOVABLE_MEDIA_FILE_NAME,\r
5c08e117 3726 &DosHeader,\r
3727 Hdr\r
3728 );\r
3729 if (!EFI_ERROR (Status) &&\r
3730 EFI_IMAGE_MACHINE_TYPE_SUPPORTED (Hdr.Pe32->FileHeader.Machine) &&\r
3731 Hdr.Pe32->OptionalHeader.Subsystem == EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION) {\r
3732 ReturnHandle = SimpleFileSystemHandles[Index];\r
3733 break;\r
3734 }\r
3735 }\r
3736 }\r
3737\r
3738 FreePool(DupDevicePath);\r
3739\r
3740 if (SimpleFileSystemHandles != NULL) {\r
3741 FreePool(SimpleFileSystemHandles);\r
3742 }\r
3743\r
ef949581
RN
3744 gBS->RestoreTPL (OldTpl);\r
3745\r
5c08e117 3746 return ReturnHandle;\r
3747}\r
3748\r
3749/**\r
3750 Check to see if the network cable is plugged in. If the DevicePath is not\r
3751 connected it will be connected.\r
3752\r
3753 @param DevicePath Device Path to check\r
3754\r
3755 @retval TRUE DevicePath points to an Network that is connected\r
3756 @retval FALSE DevicePath does not point to a bootable network\r
3757\r
3758**/\r
3759BOOLEAN\r
3760BdsLibNetworkBootWithMediaPresent (\r
3761 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
3762 )\r
3763{\r
3764 EFI_STATUS Status;\r
3765 EFI_DEVICE_PATH_PROTOCOL *UpdatedDevicePath;\r
3766 EFI_HANDLE Handle;\r
3767 EFI_SIMPLE_NETWORK_PROTOCOL *Snp;\r
3768 BOOLEAN MediaPresent;\r
e51e619e 3769 UINT32 InterruptStatus;\r
5c08e117 3770\r
3771 MediaPresent = FALSE;\r
3772\r
3773 UpdatedDevicePath = DevicePath;\r
ff482c56 3774 //\r
a7a523e0 3775 // Locate Load File Protocol for PXE boot option first\r
ff482c56 3776 //\r
a7a523e0 3777 Status = gBS->LocateDevicePath (&gEfiLoadFileProtocolGuid, &UpdatedDevicePath, &Handle);\r
5c08e117 3778 if (EFI_ERROR (Status)) {\r
3779 //\r
3780 // Device not present so see if we need to connect it\r
3781 //\r
3782 Status = BdsLibConnectDevicePath (DevicePath);\r
3783 if (!EFI_ERROR (Status)) {\r
3784 //\r
3785 // This one should work after we did the connect\r
3786 //\r
a7a523e0 3787 Status = gBS->LocateDevicePath (&gEfiLoadFileProtocolGuid, &UpdatedDevicePath, &Handle);\r
5c08e117 3788 }\r
3789 }\r
3790\r
3791 if (!EFI_ERROR (Status)) {\r
3792 Status = gBS->HandleProtocol (Handle, &gEfiSimpleNetworkProtocolGuid, (VOID **)&Snp);\r
ff482c56 3793 if (EFI_ERROR (Status)) {\r
3794 //\r
3795 // Failed to open SNP from this handle, try to get SNP from parent handle\r
3796 //\r
3797 UpdatedDevicePath = DevicePathFromHandle (Handle);\r
3798 if (UpdatedDevicePath != NULL) {\r
3799 Status = gBS->LocateDevicePath (&gEfiSimpleNetworkProtocolGuid, &UpdatedDevicePath, &Handle);\r
3800 if (!EFI_ERROR (Status)) {\r
3801 //\r
3802 // SNP handle found, get SNP from it\r
3803 //\r
3804 Status = gBS->HandleProtocol (Handle, &gEfiSimpleNetworkProtocolGuid, (VOID **) &Snp);\r
3805 }\r
3806 }\r
3807 }\r
3808\r
5c08e117 3809 if (!EFI_ERROR (Status)) {\r
3810 if (Snp->Mode->MediaPresentSupported) {\r
3811 if (Snp->Mode->State == EfiSimpleNetworkInitialized) {\r
e51e619e 3812 //\r
3813 // Invoke Snp->GetStatus() to refresh the media status\r
3814 //\r
3815 Snp->GetStatus (Snp, &InterruptStatus, NULL);\r
3816\r
5c08e117 3817 //\r
3818 // In case some one else is using the SNP check to see if it's connected\r
3819 //\r
3820 MediaPresent = Snp->Mode->MediaPresent;\r
3821 } else {\r
3822 //\r
3823 // No one is using SNP so we need to Start and Initialize so\r
3824 // MediaPresent will be valid.\r
3825 //\r
3826 Status = Snp->Start (Snp);\r
3827 if (!EFI_ERROR (Status)) {\r
3828 Status = Snp->Initialize (Snp, 0, 0);\r
3829 if (!EFI_ERROR (Status)) {\r
3830 MediaPresent = Snp->Mode->MediaPresent;\r
3831 Snp->Shutdown (Snp);\r
3832 }\r
3833 Snp->Stop (Snp);\r
3834 }\r
3835 }\r
3836 } else {\r
3837 MediaPresent = TRUE;\r
3838 }\r
3839 }\r
3840 }\r
3841\r
3842 return MediaPresent;\r
3843}\r
3844\r
3845/**\r
3846 For a bootable Device path, return its boot type.\r
3847\r
3848 @param DevicePath The bootable device Path to check\r
3849\r
128efbbc 3850 @retval BDS_EFI_MEDIA_HD_BOOT If given device path contains MEDIA_DEVICE_PATH type device path node\r
11c5022d 3851 which subtype is MEDIA_HARDDRIVE_DP\r
3852 @retval BDS_EFI_MEDIA_CDROM_BOOT If given device path contains MEDIA_DEVICE_PATH type device path node\r
3853 which subtype is MEDIA_CDROM_DP\r
3854 @retval BDS_EFI_ACPI_FLOPPY_BOOT If given device path contains ACPI_DEVICE_PATH type device path node\r
3855 which HID is floppy device.\r
3856 @retval BDS_EFI_MESSAGE_ATAPI_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node\r
3857 and its last device path node's subtype is MSG_ATAPI_DP.\r
3858 @retval BDS_EFI_MESSAGE_SCSI_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node\r
3859 and its last device path node's subtype is MSG_SCSI_DP.\r
3860 @retval BDS_EFI_MESSAGE_USB_DEVICE_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node\r
3861 and its last device path node's subtype is MSG_USB_DP.\r
5c08e117 3862 @retval BDS_EFI_MESSAGE_MISC_BOOT If the device path not contains any media device path node, and\r
11c5022d 3863 its last device path node point to a message device path node.\r
3864 @retval BDS_LEGACY_BBS_BOOT If given device path contains BBS_DEVICE_PATH type device path node.\r
128efbbc 3865 @retval BDS_EFI_UNSUPPORT An EFI Removable BlockIO device path not point to a media and message device,\r
5c08e117 3866\r
3867**/\r
3868UINT32\r
3869EFIAPI\r
3870BdsGetBootTypeFromDevicePath (\r
3871 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
3872 )\r
3873{\r
3874 ACPI_HID_DEVICE_PATH *Acpi;\r
3875 EFI_DEVICE_PATH_PROTOCOL *TempDevicePath;\r
3876 EFI_DEVICE_PATH_PROTOCOL *LastDeviceNode;\r
ff482c56 3877 UINT32 BootType;\r
5c08e117 3878\r
3879 if (NULL == DevicePath) {\r
3880 return BDS_EFI_UNSUPPORT;\r
3881 }\r
3882\r
3883 TempDevicePath = DevicePath;\r
3884\r
3885 while (!IsDevicePathEndType (TempDevicePath)) {\r
3886 switch (DevicePathType (TempDevicePath)) {\r
3887 case BBS_DEVICE_PATH:\r
3888 return BDS_LEGACY_BBS_BOOT;\r
3889 case MEDIA_DEVICE_PATH:\r
3890 if (DevicePathSubType (TempDevicePath) == MEDIA_HARDDRIVE_DP) {\r
3891 return BDS_EFI_MEDIA_HD_BOOT;\r
3892 } else if (DevicePathSubType (TempDevicePath) == MEDIA_CDROM_DP) {\r
3893 return BDS_EFI_MEDIA_CDROM_BOOT;\r
128efbbc 3894 }\r
5c08e117 3895 break;\r
3896 case ACPI_DEVICE_PATH:\r
3897 Acpi = (ACPI_HID_DEVICE_PATH *) TempDevicePath;\r
3898 if (EISA_ID_TO_NUM (Acpi->HID) == 0x0604) {\r
3899 return BDS_EFI_ACPI_FLOPPY_BOOT;\r
3900 }\r
3901 break;\r
3902 case MESSAGING_DEVICE_PATH:\r
3903 //\r
3904 // Get the last device path node\r
3905 //\r
3906 LastDeviceNode = NextDevicePathNode (TempDevicePath);\r
3907 if (DevicePathSubType(LastDeviceNode) == MSG_DEVICE_LOGICAL_UNIT_DP) {\r
3908 //\r
3909 // if the next node type is Device Logical Unit, which specify the Logical Unit Number (LUN),\r
ff482c56 3910 // skip it\r
5c08e117 3911 //\r
3912 LastDeviceNode = NextDevicePathNode (LastDeviceNode);\r
3913 }\r
3914 //\r
3915 // if the device path not only point to driver device, it is not a messaging device path,\r
3916 //\r
3917 if (!IsDevicePathEndType (LastDeviceNode)) {\r
128efbbc 3918 break;\r
5c08e117 3919 }\r
3920\r
ff482c56 3921 switch (DevicePathSubType (TempDevicePath)) {\r
3922 case MSG_ATAPI_DP:\r
3923 BootType = BDS_EFI_MESSAGE_ATAPI_BOOT;\r
3924 break;\r
3925\r
3926 case MSG_USB_DP:\r
3927 BootType = BDS_EFI_MESSAGE_USB_DEVICE_BOOT;\r
3928 break;\r
3929\r
3930 case MSG_SCSI_DP:\r
3931 BootType = BDS_EFI_MESSAGE_SCSI_BOOT;\r
3932 break;\r
3933\r
3934 case MSG_SATA_DP:\r
3935 BootType = BDS_EFI_MESSAGE_SATA_BOOT;\r
3936 break;\r
3937\r
3938 case MSG_MAC_ADDR_DP:\r
3939 case MSG_VLAN_DP:\r
a7a523e0 3940 case MSG_IPv4_DP:\r
3941 case MSG_IPv6_DP:\r
ff482c56 3942 BootType = BDS_EFI_MESSAGE_MAC_BOOT;\r
3943 break;\r
3944\r
3945 default:\r
3946 BootType = BDS_EFI_MESSAGE_MISC_BOOT;\r
3947 break;\r
5c08e117 3948 }\r
ff482c56 3949 return BootType;\r
3950\r
5c08e117 3951 default:\r
3952 break;\r
3953 }\r
3954 TempDevicePath = NextDevicePathNode (TempDevicePath);\r
3955 }\r
3956\r
3957 return BDS_EFI_UNSUPPORT;\r
3958}\r
3959\r
3960/**\r
3961 Check whether the Device path in a boot option point to a valid bootable device,\r
3962 And if CheckMedia is true, check the device is ready to boot now.\r
3963\r
3964 @param DevPath the Device path in a boot option\r
3965 @param CheckMedia if true, check the device is ready to boot now.\r
3966\r
3967 @retval TRUE the Device path is valid\r
3968 @retval FALSE the Device path is invalid .\r
3969\r
3970**/\r
3971BOOLEAN\r
3972EFIAPI\r
3973BdsLibIsValidEFIBootOptDevicePath (\r
3974 IN EFI_DEVICE_PATH_PROTOCOL *DevPath,\r
3975 IN BOOLEAN CheckMedia\r
3976 )\r
3384a9bc 3977{\r
3978 return BdsLibIsValidEFIBootOptDevicePathExt (DevPath, CheckMedia, NULL);\r
3979}\r
3980\r
3981/**\r
3982 Check whether the Device path in a boot option point to a valid bootable device,\r
3983 And if CheckMedia is true, check the device is ready to boot now.\r
3984 If Description is not NULL and the device path point to a fixed BlockIo\r
3985 device, check the description whether conflict with other auto-created\r
3986 boot options.\r
3987\r
3988 @param DevPath the Device path in a boot option\r
3989 @param CheckMedia if true, check the device is ready to boot now.\r
3990 @param Description the description in a boot option\r
3991\r
3992 @retval TRUE the Device path is valid\r
3993 @retval FALSE the Device path is invalid .\r
3994\r
3995**/\r
3996BOOLEAN\r
3997EFIAPI\r
3998BdsLibIsValidEFIBootOptDevicePathExt (\r
3999 IN EFI_DEVICE_PATH_PROTOCOL *DevPath,\r
4000 IN BOOLEAN CheckMedia,\r
4001 IN CHAR16 *Description\r
4002 )\r
5c08e117 4003{\r
4004 EFI_STATUS Status;\r
4005 EFI_HANDLE Handle;\r
4006 EFI_DEVICE_PATH_PROTOCOL *TempDevicePath;\r
4007 EFI_DEVICE_PATH_PROTOCOL *LastDeviceNode;\r
4008 EFI_BLOCK_IO_PROTOCOL *BlockIo;\r
4009\r
4010 TempDevicePath = DevPath;\r
4011 LastDeviceNode = DevPath;\r
128efbbc 4012\r
5c08e117 4013 //\r
a7a523e0 4014 // Check if it's a valid boot option for network boot device.\r
4015 // Check if there is EfiLoadFileProtocol installed. \r
4016 // If yes, that means there is a boot option for network.\r
5c08e117 4017 //\r
4018 Status = gBS->LocateDevicePath (\r
a7a523e0 4019 &gEfiLoadFileProtocolGuid,\r
5c08e117 4020 &TempDevicePath,\r
4021 &Handle\r
4022 );\r
4023 if (EFI_ERROR (Status)) {\r
4024 //\r
4025 // Device not present so see if we need to connect it\r
4026 //\r
4027 TempDevicePath = DevPath;\r
4028 BdsLibConnectDevicePath (TempDevicePath);\r
4029 Status = gBS->LocateDevicePath (\r
a7a523e0 4030 &gEfiLoadFileProtocolGuid,\r
5c08e117 4031 &TempDevicePath,\r
4032 &Handle\r
4033 );\r
4034 }\r
128efbbc 4035\r
5c08e117 4036 if (!EFI_ERROR (Status)) {\r
a7a523e0 4037 if (!IsDevicePathEnd (TempDevicePath)) {\r
4038 //\r
4039 // LoadFile protocol is not installed on handle with exactly the same DevPath\r
4040 //\r
4041 return FALSE;\r
4042 }\r
ff482c56 4043\r
a7a523e0 4044 if (CheckMedia) {\r
4045 //\r
4046 // Test if it is ready to boot now\r
4047 //\r
4048 if (BdsLibNetworkBootWithMediaPresent(DevPath)) {\r
5c08e117 4049 return TRUE;\r
4050 }\r
a7a523e0 4051 } else {\r
4052 return TRUE;\r
4053 } \r
5c08e117 4054 }\r
4055\r
4056 //\r
4057 // If the boot option point to a file, it is a valid EFI boot option,\r
4058 // and assume it is ready to boot now\r
4059 //\r
4060 while (!IsDevicePathEnd (TempDevicePath)) {\r
7389fdd0 4061 //\r
4062 // If there is USB Class or USB WWID device path node, treat it as valid EFI\r
4063 // Boot Option. BdsExpandUsbShortFormDevicePath () will be used to expand it\r
4064 // to full device path.\r
4065 //\r
4066 if ((DevicePathType (TempDevicePath) == MESSAGING_DEVICE_PATH) &&\r
4067 ((DevicePathSubType (TempDevicePath) == MSG_USB_CLASS_DP) ||\r
4068 (DevicePathSubType (TempDevicePath) == MSG_USB_WWID_DP))) {\r
4069 return TRUE;\r
4070 }\r
4071\r
4072 LastDeviceNode = TempDevicePath;\r
4073 TempDevicePath = NextDevicePathNode (TempDevicePath);\r
5c08e117 4074 }\r
4075 if ((DevicePathType (LastDeviceNode) == MEDIA_DEVICE_PATH) &&\r
4076 (DevicePathSubType (LastDeviceNode) == MEDIA_FILEPATH_DP)) {\r
4077 return TRUE;\r
4078 }\r
4079\r
4080 //\r
6617d838 4081 // Check if it's a valid boot option for internal FV application\r
5c08e117 4082 //\r
4083 if (EfiGetNameGuidFromFwVolDevicePathNode ((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *) LastDeviceNode) != NULL) {\r
4084 //\r
6617d838 4085 // If the boot option point to internal FV application, make sure it is valid\r
5c08e117 4086 //\r
128efbbc 4087 TempDevicePath = DevPath;\r
6617d838
RN
4088 Status = BdsLibUpdateFvFileDevicePath (\r
4089 &TempDevicePath,\r
4090 EfiGetNameGuidFromFwVolDevicePathNode ((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *) LastDeviceNode)\r
4091 );\r
5c08e117 4092 if (Status == EFI_ALREADY_STARTED) {\r
4093 return TRUE;\r
4094 } else {\r
4095 if (Status == EFI_SUCCESS) {\r
128efbbc 4096 FreePool (TempDevicePath);\r
5c08e117 4097 }\r
4098 return FALSE;\r
4099 }\r
4100 }\r
128efbbc 4101\r
5c08e117 4102 //\r
3384a9bc 4103 // If the boot option point to a blockIO device:\r
8d3b5aff 4104 // if it is a removable blockIo device, it is valid.\r
128efbbc 4105 // if it is a fixed blockIo device, check its description confliction.\r
5c08e117 4106 //\r
4107 TempDevicePath = DevPath;\r
4108 Status = gBS->LocateDevicePath (&gEfiBlockIoProtocolGuid, &TempDevicePath, &Handle);\r
4109 if (EFI_ERROR (Status)) {\r
4110 //\r
4111 // Device not present so see if we need to connect it\r
4112 //\r
4113 Status = BdsLibConnectDevicePath (DevPath);\r
4114 if (!EFI_ERROR (Status)) {\r
4115 //\r
4116 // Try again to get the Block Io protocol after we did the connect\r
4117 //\r
4118 TempDevicePath = DevPath;\r
4119 Status = gBS->LocateDevicePath (&gEfiBlockIoProtocolGuid, &TempDevicePath, &Handle);\r
4120 }\r
4121 }\r
128efbbc 4122\r
5c08e117 4123 if (!EFI_ERROR (Status)) {\r
4124 Status = gBS->HandleProtocol (Handle, &gEfiBlockIoProtocolGuid, (VOID **)&BlockIo);\r
4125 if (!EFI_ERROR (Status)) {\r
4126 if (CheckMedia) {\r
4127 //\r
4128 // Test if it is ready to boot now\r
4129 //\r
4130 if (BdsLibGetBootableHandle (DevPath) != NULL) {\r
4131 return TRUE;\r
4132 }\r
4133 } else {\r
4134 return TRUE;\r
4135 }\r
4136 }\r
4137 } else {\r
4138 //\r
4139 // if the boot option point to a simple file protocol which does not consume block Io protocol, it is also a valid EFI boot option,\r
4140 //\r
4141 Status = gBS->LocateDevicePath (&gEfiSimpleFileSystemProtocolGuid, &TempDevicePath, &Handle);\r
4142 if (!EFI_ERROR (Status)) {\r
4143 if (CheckMedia) {\r
4144 //\r
4145 // Test if it is ready to boot now\r
4146 //\r
4147 if (BdsLibGetBootableHandle (DevPath) != NULL) {\r
4148 return TRUE;\r
4149 }\r
4150 } else {\r
4151 return TRUE;\r
4152 }\r
4153 }\r
4154 }\r
4155\r
4156 return FALSE;\r
4157}\r
4158\r
4159\r
4160/**\r
4161 According to a file guild, check a Fv file device path is valid. If it is invalid,\r
4162 try to return the valid device path.\r
4163 FV address maybe changes for memory layout adjust from time to time, use this function\r
4164 could promise the Fv file device path is right.\r
4165\r
4166 @param DevicePath on input, the Fv file device path need to check on\r
4167 output, the updated valid Fv file device path\r
4168 @param FileGuid the Fv file guild\r
4169\r
4170 @retval EFI_INVALID_PARAMETER the input DevicePath or FileGuid is invalid\r
4171 parameter\r
4172 @retval EFI_UNSUPPORTED the input DevicePath does not contain Fv file\r
4173 guild at all\r
4174 @retval EFI_ALREADY_STARTED the input DevicePath has pointed to Fv file, it is\r
4175 valid\r
4176 @retval EFI_SUCCESS has successfully updated the invalid DevicePath,\r
4177 and return the updated device path in DevicePath\r
4178\r
4179**/\r
4180EFI_STATUS\r
4181EFIAPI\r
4182BdsLibUpdateFvFileDevicePath (\r
4183 IN OUT EFI_DEVICE_PATH_PROTOCOL ** DevicePath,\r
4184 IN EFI_GUID *FileGuid\r
4185 )\r
4186{\r
4187 EFI_DEVICE_PATH_PROTOCOL *TempDevicePath;\r
4188 EFI_DEVICE_PATH_PROTOCOL *LastDeviceNode;\r
4189 EFI_STATUS Status;\r
4190 EFI_GUID *GuidPoint;\r
4191 UINTN Index;\r
4192 UINTN FvHandleCount;\r
4193 EFI_HANDLE *FvHandleBuffer;\r
4194 EFI_FV_FILETYPE Type;\r
4195 UINTN Size;\r
4196 EFI_FV_FILE_ATTRIBUTES Attributes;\r
4197 UINT32 AuthenticationStatus;\r
4198 BOOLEAN FindFvFile;\r
4199 EFI_LOADED_IMAGE_PROTOCOL *LoadedImage;\r
4200 EFI_FIRMWARE_VOLUME2_PROTOCOL *Fv;\r
4201 MEDIA_FW_VOL_FILEPATH_DEVICE_PATH FvFileNode;\r
4202 EFI_HANDLE FoundFvHandle;\r
4203 EFI_DEVICE_PATH_PROTOCOL *NewDevicePath;\r
4204\r
4205 if ((DevicePath == NULL) || (*DevicePath == NULL)) {\r
4206 return EFI_INVALID_PARAMETER;\r
4207 }\r
4208 if (FileGuid == NULL) {\r
4209 return EFI_INVALID_PARAMETER;\r
4210 }\r
128efbbc 4211\r
5c08e117 4212 //\r
4213 // Check whether the device path point to the default the input Fv file\r
4214 //\r
4215 TempDevicePath = *DevicePath;\r
4216 LastDeviceNode = TempDevicePath;\r
4217 while (!IsDevicePathEnd (TempDevicePath)) {\r
4218 LastDeviceNode = TempDevicePath;\r
4219 TempDevicePath = NextDevicePathNode (TempDevicePath);\r
4220 }\r
4221 GuidPoint = EfiGetNameGuidFromFwVolDevicePathNode (\r
4222 (MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *) LastDeviceNode\r
4223 );\r
4224 if (GuidPoint == NULL) {\r
4225 //\r
4226 // if this option does not points to a Fv file, just return EFI_UNSUPPORTED\r
4227 //\r
4228 return EFI_UNSUPPORTED;\r
4229 }\r
4230 if (!CompareGuid (GuidPoint, FileGuid)) {\r
4231 //\r
4232 // If the Fv file is not the input file guid, just return EFI_UNSUPPORTED\r
4233 //\r
4234 return EFI_UNSUPPORTED;\r
4235 }\r
4236\r
4237 //\r
4238 // Check whether the input Fv file device path is valid\r
4239 //\r
4240 TempDevicePath = *DevicePath;\r
4241 FoundFvHandle = NULL;\r
4242 Status = gBS->LocateDevicePath (\r
4243 &gEfiFirmwareVolume2ProtocolGuid,\r
4244 &TempDevicePath,\r
4245 &FoundFvHandle\r
4246 );\r
4247 if (!EFI_ERROR (Status)) {\r
4248 Status = gBS->HandleProtocol (\r
4249 FoundFvHandle,\r
4250 &gEfiFirmwareVolume2ProtocolGuid,\r
4251 (VOID **) &Fv\r
4252 );\r
4253 if (!EFI_ERROR (Status)) {\r
4254 //\r
4255 // Set FV ReadFile Buffer as NULL, only need to check whether input Fv file exist there\r
4256 //\r
4257 Status = Fv->ReadFile (\r
4258 Fv,\r
4259 FileGuid,\r
4260 NULL,\r
4261 &Size,\r
4262 &Type,\r
4263 &Attributes,\r
4264 &AuthenticationStatus\r
4265 );\r
4266 if (!EFI_ERROR (Status)) {\r
4267 return EFI_ALREADY_STARTED;\r
4268 }\r
4269 }\r
4270 }\r
4271\r
4272 //\r
4273 // Look for the input wanted FV file in current FV\r
4274 // First, try to look for in Bds own FV. Bds and input wanted FV file usually are in the same FV\r
4275 //\r
4276 FindFvFile = FALSE;\r
4277 FoundFvHandle = NULL;\r
4278 Status = gBS->HandleProtocol (\r
fefefa4c 4279 gImageHandle,\r
5c08e117 4280 &gEfiLoadedImageProtocolGuid,\r
4281 (VOID **) &LoadedImage\r
4282 );\r
4283 if (!EFI_ERROR (Status)) {\r
4284 Status = gBS->HandleProtocol (\r
4285 LoadedImage->DeviceHandle,\r
4286 &gEfiFirmwareVolume2ProtocolGuid,\r
4287 (VOID **) &Fv\r
4288 );\r
4289 if (!EFI_ERROR (Status)) {\r
4290 Status = Fv->ReadFile (\r
4291 Fv,\r
4292 FileGuid,\r
4293 NULL,\r
4294 &Size,\r
4295 &Type,\r
4296 &Attributes,\r
4297 &AuthenticationStatus\r
4298 );\r
4299 if (!EFI_ERROR (Status)) {\r
4300 FindFvFile = TRUE;\r
4301 FoundFvHandle = LoadedImage->DeviceHandle;\r
4302 }\r
4303 }\r
4304 }\r
4305 //\r
4306 // Second, if fail to find, try to enumerate all FV\r
4307 //\r
4308 if (!FindFvFile) {\r
4309 FvHandleBuffer = NULL;\r
4310 gBS->LocateHandleBuffer (\r
4311 ByProtocol,\r
4312 &gEfiFirmwareVolume2ProtocolGuid,\r
4313 NULL,\r
4314 &FvHandleCount,\r
4315 &FvHandleBuffer\r
4316 );\r
4317 for (Index = 0; Index < FvHandleCount; Index++) {\r
4318 gBS->HandleProtocol (\r
4319 FvHandleBuffer[Index],\r
4320 &gEfiFirmwareVolume2ProtocolGuid,\r
4321 (VOID **) &Fv\r
4322 );\r
4323\r
4324 Status = Fv->ReadFile (\r
4325 Fv,\r
4326 FileGuid,\r
4327 NULL,\r
4328 &Size,\r
4329 &Type,\r
4330 &Attributes,\r
4331 &AuthenticationStatus\r
4332 );\r
4333 if (EFI_ERROR (Status)) {\r
4334 //\r
4335 // Skip if input Fv file not in the FV\r
4336 //\r
4337 continue;\r
4338 }\r
4339 FindFvFile = TRUE;\r
4340 FoundFvHandle = FvHandleBuffer[Index];\r
4341 break;\r
4342 }\r
4343\r
4344 if (FvHandleBuffer != NULL) {\r
128efbbc 4345 FreePool (FvHandleBuffer);\r
5c08e117 4346 }\r
4347 }\r
4348\r
4349 if (FindFvFile) {\r
4350 //\r
4351 // Build the shell device path\r
4352 //\r
4353 NewDevicePath = DevicePathFromHandle (FoundFvHandle);\r
4354 EfiInitializeFwVolDevicepathNode (&FvFileNode, FileGuid);\r
4355 NewDevicePath = AppendDevicePathNode (NewDevicePath, (EFI_DEVICE_PATH_PROTOCOL *) &FvFileNode);\r
45295cf5 4356 ASSERT (NewDevicePath != NULL);\r
5c08e117 4357 *DevicePath = NewDevicePath;\r
4358 return EFI_SUCCESS;\r
4359 }\r
4360 return EFI_NOT_FOUND;\r
4361}\r