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