2 BDS Lib functions which relate with create or process the boot option.
4 Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #include "InternalBdsLib.h"
18 BOOLEAN mEnumBootDevice
= FALSE
;
19 EFI_HII_HANDLE gBdsLibStringPackHandle
= NULL
;
22 The constructor function register UNI strings into imageHandle.
24 It will ASSERT() if that operation fails and it will always return EFI_SUCCESS.
26 @param ImageHandle The firmware allocated handle for the EFI image.
27 @param SystemTable A pointer to the EFI System Table.
29 @retval EFI_SUCCESS The constructor successfully added string package.
30 @retval Other value The constructor can't add string package.
35 GenericBdsLibConstructor (
36 IN EFI_HANDLE ImageHandle
,
37 IN EFI_SYSTEM_TABLE
*SystemTable
41 gBdsLibStringPackHandle
= HiiAddPackages (
42 &gBdsLibStringPackageGuid
,
48 ASSERT (gBdsLibStringPackHandle
!= NULL
);
54 Deletete the Boot Option from EFI Variable. The Boot Order Arrray
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.
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
68 IN UINTN OptionNumber
,
69 IN OUT UINT16
*BootOrder
,
70 IN OUT UINTN
*BootOrderSize
77 UnicodeSPrint (BootOption
, sizeof (BootOption
), L
"Boot%04x", OptionNumber
);
78 Status
= gRT
->SetVariable (
80 &gEfiGlobalVariableGuid
,
86 // Deleting variable with existing variable implementation shouldn't fail.
88 ASSERT_EFI_ERROR (Status
);
91 // adjust boot order array
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
);
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.
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.
126 while (AStr
[Idx
] != 0) {
127 UStr
[Idx
] = (CHAR16
) AStr
[Idx
];
138 Build Legacy Device Name String according.
140 @param CurBBSEntry BBS Table.
142 @param BufSize The buffer size.
143 @param BootString The output string.
147 BdsBuildLegacyDevNameString (
148 IN BBS_TABLE
*CurBBSEntry
,
151 OUT CHAR16
*BootString
164 Fmt
= L
"Primary Master %s";
171 Fmt
= L
"Primary Slave %s";
178 Fmt
= L
"Secondary Master %s";
185 Fmt
= L
"Secondary Slave %s";
193 switch (CurBBSEntry
->DeviceType
) {
214 case BBS_EMBED_NETWORK
:
228 // If current BBS entry has its description then use it.
230 StringDesc
= (UINT8
*) (UINTN
) ((CurBBSEntry
->DescStringSegment
<< 4) + CurBBSEntry
->DescStringOffset
);
231 if (NULL
!= StringDesc
) {
233 // Only get fisrt 32 characters, this is suggested by BBS spec
235 AsciiToUnicodeSize (StringDesc
, 32, Temp
);
241 // BbsTable 16 entries are for onboard IDE.
242 // Set description string for SATA harddisks, Harddisk 0 ~ Harddisk 11
244 if (Index
>= 5 && Index
<= 16 && (CurBBSEntry
->DeviceType
== BBS_HARDDISK
|| CurBBSEntry
->DeviceType
== BBS_CDROM
)) {
246 UnicodeSPrint (BootString
, BufSize
, Fmt
, Type
, Index
- 5);
248 UnicodeSPrint (BootString
, BufSize
, Fmt
, Type
);
254 Create a legacy boot option for the specified entry of
255 BBS table, save it as variable, and append it to the boot
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
265 @param BootOrderListSize On input, the original size of boot order list.
266 On output, the size of new boot order list.
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.
274 BdsCreateLegacyBootOption (
275 IN BBS_TABLE
*CurrentBbsEntry
,
276 IN EFI_DEVICE_PATH_PROTOCOL
*CurrentBbsDevPath
,
278 IN OUT UINT16
**BootOrderList
,
279 IN OUT UINTN
*BootOrderListSize
283 UINT16 CurrentBootOptionNo
;
284 UINT16 BootString
[10];
285 CHAR16 BootDesc
[100];
286 CHAR8 HelpString
[100];
287 UINT16
*NewBootOrderList
;
292 UINT16 CurrentBbsDevPathSize
;
293 UINTN BootOrderIndex
;
294 UINTN BootOrderLastIndex
;
296 BOOLEAN IndexNotFound
;
297 BBS_BBS_DEVICE_PATH
*NewBbsDevPathNode
;
299 if ((*BootOrderList
) == NULL
) {
300 CurrentBootOptionNo
= 0;
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
;
311 if (!IndexNotFound
) {
318 CurrentBootOptionNo
= (UINT16
) ArrayIndex
;
328 BdsBuildLegacyDevNameString (CurrentBbsEntry
, Index
, sizeof (BootDesc
), BootDesc
);
331 // Create new BBS device path node with description string
333 UnicodeStrToAsciiStrS (BootDesc
, HelpString
, sizeof (HelpString
));
335 StringLen
= AsciiStrLen (HelpString
);
336 NewBbsDevPathNode
= AllocateZeroPool (sizeof (BBS_BBS_DEVICE_PATH
) + StringLen
);
337 if (NewBbsDevPathNode
== NULL
) {
338 return EFI_OUT_OF_RESOURCES
;
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
);
345 // Create entire new CurrentBbsDevPath with end node
347 CurrentBbsDevPath
= AppendDevicePathNode (
349 (EFI_DEVICE_PATH_PROTOCOL
*) NewBbsDevPathNode
351 if (CurrentBbsDevPath
== NULL
) {
352 FreePool (NewBbsDevPathNode
);
353 return EFI_OUT_OF_RESOURCES
;
356 CurrentBbsDevPathSize
= (UINT16
) (GetDevicePathSize (CurrentBbsDevPath
));
358 BufferSize
= sizeof (UINT32
) +
361 CurrentBbsDevPathSize
+
365 Buffer
= AllocateZeroPool (BufferSize
);
366 if (Buffer
== NULL
) {
367 FreePool (NewBbsDevPathNode
);
368 FreePool (CurrentBbsDevPath
);
369 return EFI_OUT_OF_RESOURCES
;
372 Ptr
= (UINT8
*) Buffer
;
374 *((UINT32
*) Ptr
) = LOAD_OPTION_ACTIVE
;
375 Ptr
+= sizeof (UINT32
);
377 *((UINT16
*) Ptr
) = CurrentBbsDevPathSize
;
378 Ptr
+= sizeof (UINT16
);
385 Ptr
+= StrSize (BootDesc
);
390 CurrentBbsDevPathSize
392 Ptr
+= CurrentBbsDevPathSize
;
400 Ptr
+= sizeof (BBS_TABLE
);
401 *((UINT16
*) Ptr
) = (UINT16
) Index
;
403 Status
= gRT
->SetVariable (
405 &gEfiGlobalVariableGuid
,
406 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
415 NewBootOrderList
= AllocateZeroPool (*BootOrderListSize
+ sizeof (UINT16
));
416 if (NULL
== NewBootOrderList
) {
417 FreePool (NewBbsDevPathNode
);
418 FreePool (CurrentBbsDevPath
);
419 return EFI_OUT_OF_RESOURCES
;
422 if (*BootOrderList
!= NULL
) {
423 CopyMem (NewBootOrderList
, *BootOrderList
, *BootOrderListSize
);
424 FreePool (*BootOrderList
);
427 BootOrderLastIndex
= (UINTN
) (*BootOrderListSize
/ sizeof (UINT16
));
428 NewBootOrderList
[BootOrderLastIndex
] = CurrentBootOptionNo
;
429 *BootOrderListSize
+= sizeof (UINT16
);
430 *BootOrderList
= NewBootOrderList
;
432 FreePool (NewBbsDevPathNode
);
433 FreePool (CurrentBbsDevPath
);
438 Check if the boot option is a legacy one.
440 @param BootOptionVar The boot option data payload.
441 @param BbsEntry The BBS Table.
442 @param BbsIndex The table index.
444 @retval TRUE It is a legacy boot option.
445 @retval FALSE It is not a legacy boot option.
449 BdsIsLegacyBootOption (
450 IN UINT8
*BootOptionVar
,
451 OUT BBS_TABLE
**BbsEntry
,
456 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
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
)) {
468 *BbsEntry
= (BBS_TABLE
*) Ptr
;
469 Ptr
+= sizeof (BBS_TABLE
);
470 *BbsIndex
= *(UINT16
*) Ptr
;
481 Delete all the invalid legacy boot options.
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.
489 BdsDeleteAllInvalidLegacyBootOptions (
494 UINT8
*BootOptionVar
;
496 UINTN BootOptionSize
;
500 HDD_INFO
*LocalHddInfo
;
501 BBS_TABLE
*LocalBbsTable
;
504 EFI_LEGACY_BIOS_PROTOCOL
*LegacyBios
;
506 UINT16 BootOption
[10];
507 UINT16 BootDesc
[100];
508 BOOLEAN DescStringMatch
;
510 Status
= EFI_SUCCESS
;
516 LocalBbsTable
= NULL
;
519 Status
= gBS
->LocateProtocol (&gEfiLegacyBiosProtocolGuid
, NULL
, (VOID
**) &LegacyBios
);
520 if (EFI_ERROR (Status
)) {
524 BootOrder
= BdsLibGetVariableAndSize (
526 &gEfiGlobalVariableGuid
,
529 if (BootOrder
== NULL
) {
530 return EFI_NOT_FOUND
;
533 LegacyBios
->GetBbsInfo (
542 while (Index
< BootOrderSize
/ sizeof (UINT16
)) {
543 UnicodeSPrint (BootOption
, sizeof (BootOption
), L
"Boot%04x", BootOrder
[Index
]);
544 BootOptionVar
= BdsLibGetVariableAndSize (
546 &gEfiGlobalVariableGuid
,
549 if (NULL
== BootOptionVar
) {
551 Status
= gRT
->GetVariable (
553 &gEfiGlobalVariableGuid
,
558 if (Status
== EFI_NOT_FOUND
) {
562 BdsDeleteBootOption (
569 FreePool (BootOrder
);
570 return EFI_OUT_OF_RESOURCES
;
575 // Skip Non-Legacy boot option
577 if (!BdsIsLegacyBootOption (BootOptionVar
, &BbsEntry
, &BbsIndex
)) {
578 if (BootOptionVar
!= NULL
) {
579 FreePool (BootOptionVar
);
585 if (BbsIndex
< BbsCount
) {
587 // Check if BBS Description String is changed
589 DescStringMatch
= FALSE
;
590 BdsBuildLegacyDevNameString (
591 &LocalBbsTable
[BbsIndex
],
597 if (StrCmp (BootDesc
, (UINT16
*)(BootOptionVar
+ sizeof (UINT32
) + sizeof (UINT16
))) == 0) {
598 DescStringMatch
= TRUE
;
601 if (!((LocalBbsTable
[BbsIndex
].BootPriority
== BBS_IGNORE_ENTRY
) ||
602 (LocalBbsTable
[BbsIndex
].BootPriority
== BBS_DO_NOT_BOOT_FROM
)) &&
603 (LocalBbsTable
[BbsIndex
].DeviceType
== BbsEntry
->DeviceType
) &&
610 if (BootOptionVar
!= NULL
) {
611 FreePool (BootOptionVar
);
616 BdsDeleteBootOption (
624 // Adjust the number of boot options.
626 Status
= gRT
->SetVariable (
628 &gEfiGlobalVariableGuid
,
629 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
634 // Shrinking variable with existing variable implementation shouldn't fail.
636 ASSERT_EFI_ERROR (Status
);
637 FreePool (BootOrder
);
643 Find all legacy boot option by device type.
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.
653 @retval TRUE The Legacy boot option is found.
654 @retval FALSE The legacy boot option is not found.
658 BdsFindLegacyBootOptionByDevTypeAndName (
659 IN UINT16
*BootOrder
,
660 IN UINTN BootOptionNum
,
663 OUT UINT32
*Attribute
,
664 OUT UINT16
*BbsIndex
,
665 OUT UINT16
*OptionNumber
669 CHAR16 BootOption
[9];
670 UINTN BootOptionSize
;
671 UINT8
*BootOptionVar
;
678 if (NULL
== BootOrder
) {
683 // Loop all boot option from variable
685 for (Index
= 0; Index
< BootOptionNum
; Index
++) {
686 UnicodeSPrint (BootOption
, sizeof (BootOption
), L
"Boot%04x", (UINTN
) BootOrder
[Index
]);
687 BootOptionVar
= BdsLibGetVariableAndSize (
689 &gEfiGlobalVariableGuid
,
692 if (NULL
== BootOptionVar
) {
697 // Skip Non-legacy boot option
699 if (!BdsIsLegacyBootOption (BootOptionVar
, &BbsEntry
, BbsIndex
)) {
700 FreePool (BootOptionVar
);
705 (BbsEntry
->DeviceType
!= DevType
) ||
706 (StrCmp (DevName
, (CHAR16
*)(BootOptionVar
+ sizeof (UINT32
) + sizeof (UINT16
))) != 0)
708 FreePool (BootOptionVar
);
712 *Attribute
= *(UINT32
*) BootOptionVar
;
713 *OptionNumber
= BootOrder
[Index
];
715 FreePool (BootOptionVar
);
723 Create a legacy boot option.
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.
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.
736 BdsCreateOneLegacyBootOption (
737 IN BBS_TABLE
*BbsItem
,
739 IN OUT UINT16
**BootOrderList
,
740 IN OUT UINTN
*BootOrderListSize
743 BBS_BBS_DEVICE_PATH BbsDevPathNode
;
745 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
750 // Create device path node.
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
));
758 DevPath
= AppendDevicePathNode (
760 (EFI_DEVICE_PATH_PROTOCOL
*) &BbsDevPathNode
762 if (NULL
== DevPath
) {
763 return EFI_OUT_OF_RESOURCES
;
766 Status
= BdsCreateLegacyBootOption (
773 BbsItem
->BootPriority
= 0x00;
781 Add the legacy boot options from BBS table if they do not exist.
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.
791 BdsAddNonExistingLegacyBootOptions (
801 HDD_INFO
*LocalHddInfo
;
802 BBS_TABLE
*LocalBbsTable
;
804 EFI_LEGACY_BIOS_PROTOCOL
*LegacyBios
;
813 LocalBbsTable
= NULL
;
815 Status
= gBS
->LocateProtocol (&gEfiLegacyBiosProtocolGuid
, NULL
, (VOID
**) &LegacyBios
);
816 if (EFI_ERROR (Status
)) {
820 LegacyBios
->GetBbsInfo (
828 BootOrder
= BdsLibGetVariableAndSize (
830 &gEfiGlobalVariableGuid
,
833 if (BootOrder
== NULL
) {
837 for (Index
= 0; Index
< BbsCount
; Index
++) {
838 if ((LocalBbsTable
[Index
].BootPriority
== BBS_IGNORE_ENTRY
) ||
839 (LocalBbsTable
[Index
].BootPriority
== BBS_DO_NOT_BOOT_FROM
)
844 BdsBuildLegacyDevNameString (&LocalBbsTable
[Index
], Index
, sizeof (Desc
), Desc
);
846 Exist
= BdsFindLegacyBootOptionByDevTypeAndName (
848 BootOrderSize
/ sizeof (UINT16
),
849 LocalBbsTable
[Index
].DeviceType
,
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
860 Status
= BdsCreateOneLegacyBootOption (
861 &LocalBbsTable
[Index
],
866 if (!EFI_ERROR (Status
)) {
867 ASSERT (BootOrder
!= NULL
);
869 OptionNumber
= BootOrder
[BootOrderSize
/ sizeof (UINT16
) - 1];
873 ASSERT (BbsIndex
== Index
);
876 Status
= gRT
->SetVariable (
878 &gEfiGlobalVariableGuid
,
879 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
883 if (BootOrder
!= NULL
) {
884 FreePool (BootOrder
);
891 Fill the device order buffer.
893 @param BbsTable The BBS table.
894 @param BbsType The BBS Type.
895 @param BbsCount The BBS Count.
896 @param Buf device order buffer.
898 @return The device order buffer.
903 IN BBS_TABLE
*BbsTable
,
911 for (Index
= 0; Index
< BbsCount
; Index
++) {
912 if (BbsTable
[Index
].BootPriority
== BBS_IGNORE_ENTRY
) {
916 if (BbsTable
[Index
].DeviceType
!= BbsType
) {
920 *Buf
= (UINT16
) (Index
& 0xFF);
928 Create the device order buffer.
930 @param BbsTable The BBS table.
931 @param BbsCount The BBS Count.
933 @retval EFI_SUCCES The buffer is created and the EFI variable named
934 VAR_LEGACY_DEV_ORDER and gEfiLegacyDevOrderVariableGuid is
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.
942 IN BBS_TABLE
*BbsTable
,
954 LEGACY_DEV_ORDER_ENTRY
*DevOrder
;
955 LEGACY_DEV_ORDER_ENTRY
*DevOrderPtr
;
964 HeaderSize
= sizeof (BBS_TYPE
) + sizeof (UINT16
);
966 Status
= EFI_SUCCESS
;
969 // Count all boot devices
971 for (Index
= 0; Index
< BbsCount
; Index
++) {
972 if (BbsTable
[Index
].BootPriority
== BBS_IGNORE_ENTRY
) {
976 switch (BbsTable
[Index
].DeviceType
) {
989 case BBS_EMBED_NETWORK
:
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
);
1009 // Create buffer to hold all boot device order
1011 DevOrder
= AllocateZeroPool (TotalSize
);
1012 if (NULL
== DevOrder
) {
1013 return EFI_OUT_OF_RESOURCES
;
1015 DevOrderPtr
= DevOrder
;
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
);
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
);
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
);
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
);
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
);
1037 ASSERT (TotalSize
== (UINTN
) ((UINT8
*) DevOrderPtr
- (UINT8
*) DevOrder
));
1040 // Save device order for legacy boot device to variable.
1042 Status
= gRT
->SetVariable (
1043 VAR_LEGACY_DEV_ORDER
,
1044 &gEfiLegacyDevOrderVariableGuid
,
1045 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
1049 FreePool (DevOrder
);
1055 Add the legacy boot devices from BBS table into
1056 the legacy device boot order.
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.
1066 BdsUpdateLegacyDevOrder (
1070 LEGACY_DEV_ORDER_ENTRY
*DevOrder
;
1071 LEGACY_DEV_ORDER_ENTRY
*NewDevOrder
;
1072 LEGACY_DEV_ORDER_ENTRY
*Ptr
;
1073 LEGACY_DEV_ORDER_ENTRY
*NewPtr
;
1075 EFI_LEGACY_BIOS_PROTOCOL
*LegacyBios
;
1079 HDD_INFO
*LocalHddInfo
;
1080 BBS_TABLE
*LocalBbsTable
;
1110 HeaderSize
= sizeof (BBS_TYPE
) + sizeof (UINT16
);
1118 Status
= gBS
->LocateProtocol (&gEfiLegacyBiosProtocolGuid
, NULL
, (VOID
**) &LegacyBios
);
1119 if (EFI_ERROR (Status
)) {
1123 Status
= LegacyBios
->GetBbsInfo (
1130 if (EFI_ERROR (Status
)) {
1134 DevOrder
= BdsLibGetVariableAndSize (
1135 VAR_LEGACY_DEV_ORDER
,
1136 &gEfiLegacyDevOrderVariableGuid
,
1139 if (NULL
== DevOrder
) {
1140 return BdsCreateDevOrder (LocalBbsTable
, BbsCount
);
1143 // First we figure out how many boot devices with same device type respectively
1145 for (Index
= 0; Index
< BbsCount
; Index
++) {
1146 if ((LocalBbsTable
[Index
].BootPriority
== BBS_IGNORE_ENTRY
) ||
1147 (LocalBbsTable
[Index
].BootPriority
== BBS_DO_NOT_BOOT_FROM
)
1152 switch (LocalBbsTable
[Index
].DeviceType
) {
1165 case BBS_EMBED_NETWORK
:
1169 case BBS_BEV_DEVICE
:
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
));
1184 NewDevOrder
= AllocateZeroPool (TotalSize
);
1185 if (NULL
== NewDevOrder
) {
1186 return EFI_OUT_OF_RESOURCES
;
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
1206 NewPtr
->Data
[FDIndex
] = Ptr
->Data
[Index
];
1209 NewFDPtr
= NewPtr
->Data
;
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
1227 NewPtr
->Data
[HDIndex
] = Ptr
->Data
[Index
];
1230 NewHDPtr
= NewPtr
->Data
;
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
1248 NewPtr
->Data
[CDIndex
] = Ptr
->Data
[Index
];
1251 NewCDPtr
= NewPtr
->Data
;
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
1269 NewPtr
->Data
[NETIndex
] = Ptr
->Data
[Index
];
1272 NewNETPtr
= NewPtr
->Data
;
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
1290 NewPtr
->Data
[BEVIndex
] = Ptr
->Data
[Index
];
1293 NewBEVPtr
= NewPtr
->Data
;
1295 for (Index
= 0; Index
< BbsCount
; Index
++) {
1296 if ((LocalBbsTable
[Index
].BootPriority
== BBS_IGNORE_ENTRY
) ||
1297 (LocalBbsTable
[Index
].BootPriority
== BBS_DO_NOT_BOOT_FROM
)
1302 switch (LocalBbsTable
[Index
].DeviceType
) {
1305 NewDevPtr
= NewFDPtr
;
1310 NewDevPtr
= NewHDPtr
;
1315 NewDevPtr
= NewCDPtr
;
1318 case BBS_EMBED_NETWORK
:
1320 NewDevPtr
= NewNETPtr
;
1323 case BBS_BEV_DEVICE
:
1325 NewDevPtr
= NewBEVPtr
;
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
1337 for (Index2
= 0; Index2
< *Idx
; Index2
++) {
1338 if ((NewDevPtr
[Index2
] & 0xFF) == (UINT16
) Index
) {
1343 if (Index2
== *Idx
) {
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.
1349 for (Index2
= 0; Index2
< *Idx
; Index2
++) {
1350 if ((NewDevPtr
[Index2
] & 0xFF00) == 0xFF00) {
1354 CopyMem (&NewDevPtr
[Index2
+ 1], &NewDevPtr
[Index2
], (*Idx
- Index2
) * sizeof (UINT16
));
1355 NewDevPtr
[Index2
] = (UINT16
) (Index
& 0xFF);
1361 FreePool (DevOrder
);
1363 Status
= gRT
->SetVariable (
1364 VAR_LEGACY_DEV_ORDER
,
1365 &gEfiLegacyDevOrderVariableGuid
,
1366 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
1370 FreePool (NewDevOrder
);
1376 Set Boot Priority for specified device type.
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.
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.
1389 BdsSetBootPriority4SameTypeDev (
1390 IN UINT16 DeviceType
,
1392 IN OUT BBS_TABLE
*LocalBbsTable
,
1393 IN OUT UINT16
*Priority
1396 LEGACY_DEV_ORDER_ENTRY
*DevOrder
;
1397 LEGACY_DEV_ORDER_ENTRY
*DevOrderPtr
;
1401 DevOrder
= BdsLibGetVariableAndSize (
1402 VAR_LEGACY_DEV_ORDER
,
1403 &gEfiLegacyDevOrderVariableGuid
,
1406 if (NULL
== DevOrder
) {
1407 return EFI_OUT_OF_RESOURCES
;
1410 DevOrderPtr
= DevOrder
;
1411 while ((UINT8
*) DevOrderPtr
< (UINT8
*) DevOrder
+ DevOrderSize
) {
1412 if (DevOrderPtr
->BbsType
== DeviceType
) {
1416 DevOrderPtr
= (LEGACY_DEV_ORDER_ENTRY
*) ((UINTN
) DevOrderPtr
+ sizeof (BBS_TYPE
) + DevOrderPtr
->Length
);
1419 if ((UINT8
*) DevOrderPtr
>= (UINT8
*) DevOrder
+ DevOrderSize
) {
1420 FreePool (DevOrder
);
1421 return EFI_NOT_FOUND
;
1424 if (BbsIndex
!= (UINTN
) -1) {
1425 LocalBbsTable
[BbsIndex
].BootPriority
= *Priority
;
1429 // If the high byte of the DevIndex is 0xFF, it indicates that this device has been disabled.
1431 for (Index
= 0; Index
< DevOrderPtr
->Length
/ sizeof (UINT16
) - 1; Index
++) {
1432 if ((DevOrderPtr
->Data
[Index
] & 0xFF00) == 0xFF00) {
1434 // LocalBbsTable[DevIndex[Index] & 0xFF].BootPriority = BBS_DISABLED_ENTRY;
1436 } else if (DevOrderPtr
->Data
[Index
] != BbsIndex
) {
1437 LocalBbsTable
[DevOrderPtr
->Data
[Index
]].BootPriority
= *Priority
;
1442 FreePool (DevOrder
);
1447 Print the BBS Table.
1449 @param LocalBbsTable The BBS table.
1450 @param BbsCount The count of entry in BBS table.
1454 IN BBS_TABLE
*LocalBbsTable
,
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
)
1473 " %02x: %04x %02x/%02x/%02x %02x/%02x %04x %04x %04x:%04x\n",
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
))
1490 DEBUG ((DEBUG_ERROR
, "\n"));
1494 Set the boot priority for BBS entries based on boot option entry and boot order.
1496 @param Entry The boot option is to be checked for refresh BBS table.
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.
1504 BdsRefreshBbsTableForBoot (
1505 IN BDS_COMMON_OPTION
*Entry
1512 HDD_INFO
*LocalHddInfo
;
1513 BBS_TABLE
*LocalBbsTable
;
1515 EFI_LEGACY_BIOS_PROTOCOL
*LegacyBios
;
1519 UINTN BootOrderSize
;
1520 UINT8
*BootOptionVar
;
1521 UINTN BootOptionSize
;
1522 CHAR16 BootOption
[9];
1525 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
1527 UINTN DeviceTypeCount
;
1528 UINTN DeviceTypeIndex
;
1532 LocalHddInfo
= NULL
;
1533 LocalBbsTable
= NULL
;
1534 DevType
= BBS_UNKNOWN
;
1536 Status
= gBS
->LocateProtocol (&gEfiLegacyBiosProtocolGuid
, NULL
, (VOID
**) &LegacyBios
);
1537 if (EFI_ERROR (Status
)) {
1541 LegacyBios
->GetBbsInfo (
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
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
;
1560 // boot priority always starts at 0
1563 if (Entry
->LoadOptionsSize
== sizeof (BBS_TABLE
) + sizeof (UINT16
)) {
1565 // If Entry stands for a legacy boot option, we prioritize the devices with the same type first.
1567 DevType
= ((BBS_TABLE
*) Entry
->LoadOptions
)->DeviceType
;
1568 BbsIndex
= *(UINT16
*) ((BBS_TABLE
*) Entry
->LoadOptions
+ 1);
1569 Status
= BdsSetBootPriority4SameTypeDev (
1575 if (EFI_ERROR (Status
)) {
1580 // we have to set the boot priority for other BBS entries with different device types
1582 BootOrder
= BdsLibGetVariableAndSize (
1584 &gEfiGlobalVariableGuid
,
1587 DeviceType
= AllocatePool (BootOrderSize
+ sizeof (UINT16
));
1588 ASSERT (DeviceType
!= NULL
);
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 (
1596 &gEfiGlobalVariableGuid
,
1599 if (NULL
== BootOptionVar
) {
1603 Ptr
= BootOptionVar
;
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
);
1616 DevType
= ((BBS_TABLE
*) Ptr
)->DeviceType
;
1617 for (DeviceTypeIndex
= 0; DeviceTypeIndex
< DeviceTypeCount
; DeviceTypeIndex
++) {
1618 if (DeviceType
[DeviceTypeIndex
] == DevType
) {
1622 if (DeviceTypeIndex
< DeviceTypeCount
) {
1624 // We don't want to process twice for a device type
1626 FreePool (BootOptionVar
);
1630 DeviceType
[DeviceTypeCount
] = DevType
;
1633 Status
= BdsSetBootPriority4SameTypeDev (
1639 FreePool (BootOptionVar
);
1640 if (EFI_ERROR (Status
)) {
1645 FreePool (DeviceType
);
1647 if (BootOrder
!= NULL
) {
1648 FreePool (BootOrder
);
1652 PrintBbsTable (LocalBbsTable
, BbsCount
);
1659 Boot the legacy system with the boot option
1661 @param Option The legacy boot option which have BBS device path
1663 @retval EFI_UNSUPPORTED There is no legacybios protocol, do not support
1665 @retval EFI_STATUS Return the status of LegacyBios->LegacyBoot ().
1669 BdsLibDoLegacyBoot (
1670 IN BDS_COMMON_OPTION
*Option
1674 EFI_LEGACY_BIOS_PROTOCOL
*LegacyBios
;
1675 EFI_EVENT LegacyBootEvent
;
1677 Status
= gBS
->LocateProtocol (&gEfiLegacyBiosProtocolGuid
, NULL
, (VOID
**) &LegacyBios
);
1678 if (EFI_ERROR (Status
)) {
1680 // If no LegacyBios protocol we do not support legacy boot
1682 return EFI_UNSUPPORTED
;
1685 // Notes: if we separate the int 19, then we don't need to refresh BBS
1687 BdsRefreshBbsTableForBoot (Option
);
1690 // Write boot to OS performance data for legacy boot.
1694 // Create an event to be signalled when Legacy Boot occurs to write performance data.
1696 Status
= EfiCreateEventLegacyBootEx(
1698 WriteBootToOsPerformanceData
,
1702 ASSERT_EFI_ERROR (Status
);
1705 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Legacy Boot: %S\n", Option
->Description
));
1706 return LegacyBios
->LegacyBoot (
1708 (BBS_BBS_DEVICE_PATH
*) Option
->DevicePath
,
1709 Option
->LoadOptionsSize
,
1715 Internal function to check if the input boot option is a valid EFI NV Boot####.
1717 @param OptionToCheck Boot option to be checked.
1719 @retval TRUE This boot option matches a valid EFI NV Boot####.
1720 @retval FALSE If not.
1724 IsBootOptionValidNVVarialbe (
1725 IN BDS_COMMON_OPTION
*OptionToCheck
1728 LIST_ENTRY TempList
;
1729 BDS_COMMON_OPTION
*BootOption
;
1731 CHAR16 OptionName
[20];
1735 InitializeListHead (&TempList
);
1736 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Boot%04x", OptionToCheck
->BootCurrent
);
1738 BootOption
= BdsLibVariableToOption (&TempList
, OptionName
);
1739 if (BootOption
== NULL
) {
1744 // If the Boot Option Number and Device Path matches, OptionToCheck matches a
1745 // valid EFI NV Boot####.
1747 if ((OptionToCheck
->BootCurrent
== BootOption
->BootCurrent
) &&
1748 (CompareMem (OptionToCheck
->DevicePath
, BootOption
->DevicePath
, GetDevicePathSize (OptionToCheck
->DevicePath
)) == 0))
1753 FreePool (BootOption
);
1759 Check whether a USB device match the specified USB Class device path. This
1760 function follows "Load Option Processing" behavior in UEFI specification.
1762 @param UsbIo USB I/O protocol associated with the USB device.
1763 @param UsbClass The USB Class device path to match.
1765 @retval TRUE The USB device match the USB Class device path.
1766 @retval FALSE The USB device does not match the USB Class device path.
1771 IN EFI_USB_IO_PROTOCOL
*UsbIo
,
1772 IN USB_CLASS_DEVICE_PATH
*UsbClass
1776 EFI_USB_DEVICE_DESCRIPTOR DevDesc
;
1777 EFI_USB_INTERFACE_DESCRIPTOR IfDesc
;
1779 UINT8 DeviceSubClass
;
1780 UINT8 DeviceProtocol
;
1782 if ((DevicePathType (UsbClass
) != MESSAGING_DEVICE_PATH
) ||
1783 (DevicePathSubType (UsbClass
) != MSG_USB_CLASS_DP
)){
1788 // Check Vendor Id and Product Id.
1790 Status
= UsbIo
->UsbGetDeviceDescriptor (UsbIo
, &DevDesc
);
1791 if (EFI_ERROR (Status
)) {
1795 if ((UsbClass
->VendorId
!= 0xffff) &&
1796 (UsbClass
->VendorId
!= DevDesc
.IdVendor
)) {
1800 if ((UsbClass
->ProductId
!= 0xffff) &&
1801 (UsbClass
->ProductId
!= DevDesc
.IdProduct
)) {
1805 DeviceClass
= DevDesc
.DeviceClass
;
1806 DeviceSubClass
= DevDesc
.DeviceSubClass
;
1807 DeviceProtocol
= DevDesc
.DeviceProtocol
;
1808 if (DeviceClass
== 0) {
1810 // If Class in Device Descriptor is set to 0, use the Class, SubClass and
1811 // Protocol in Interface Descriptor instead.
1813 Status
= UsbIo
->UsbGetInterfaceDescriptor (UsbIo
, &IfDesc
);
1814 if (EFI_ERROR (Status
)) {
1818 DeviceClass
= IfDesc
.InterfaceClass
;
1819 DeviceSubClass
= IfDesc
.InterfaceSubClass
;
1820 DeviceProtocol
= IfDesc
.InterfaceProtocol
;
1824 // Check Class, SubClass and Protocol.
1826 if ((UsbClass
->DeviceClass
!= 0xff) &&
1827 (UsbClass
->DeviceClass
!= DeviceClass
)) {
1831 if ((UsbClass
->DeviceSubClass
!= 0xff) &&
1832 (UsbClass
->DeviceSubClass
!= DeviceSubClass
)) {
1836 if ((UsbClass
->DeviceProtocol
!= 0xff) &&
1837 (UsbClass
->DeviceProtocol
!= DeviceProtocol
)) {
1845 Check whether a USB device match the specified USB WWID device path. This
1846 function follows "Load Option Processing" behavior in UEFI specification.
1848 @param UsbIo USB I/O protocol associated with the USB device.
1849 @param UsbWwid The USB WWID device path to match.
1851 @retval TRUE The USB device match the USB WWID device path.
1852 @retval FALSE The USB device does not match the USB WWID device path.
1857 IN EFI_USB_IO_PROTOCOL
*UsbIo
,
1858 IN USB_WWID_DEVICE_PATH
*UsbWwid
1862 EFI_USB_DEVICE_DESCRIPTOR DevDesc
;
1863 EFI_USB_INTERFACE_DESCRIPTOR IfDesc
;
1864 UINT16
*LangIdTable
;
1869 CHAR16
*SerialNumberStr
;
1872 if ((DevicePathType (UsbWwid
) != MESSAGING_DEVICE_PATH
) ||
1873 (DevicePathSubType (UsbWwid
) != MSG_USB_WWID_DP
)){
1878 // Check Vendor Id and Product Id.
1880 Status
= UsbIo
->UsbGetDeviceDescriptor (UsbIo
, &DevDesc
);
1881 if (EFI_ERROR (Status
)) {
1884 if ((DevDesc
.IdVendor
!= UsbWwid
->VendorId
) ||
1885 (DevDesc
.IdProduct
!= UsbWwid
->ProductId
)) {
1890 // Check Interface Number.
1892 Status
= UsbIo
->UsbGetInterfaceDescriptor (UsbIo
, &IfDesc
);
1893 if (EFI_ERROR (Status
)) {
1896 if (IfDesc
.InterfaceNumber
!= UsbWwid
->InterfaceNumber
) {
1901 // Check Serial Number.
1903 if (DevDesc
.StrSerialNumber
== 0) {
1908 // Get all supported languages.
1912 Status
= UsbIo
->UsbGetSupportedLanguages (UsbIo
, &LangIdTable
, &TableSize
);
1913 if (EFI_ERROR (Status
) || (TableSize
== 0) || (LangIdTable
== NULL
)) {
1918 // Serial number in USB WWID device path is the last 64-or-less UTF-16 characters.
1920 CompareStr
= (CHAR16
*) (UINTN
) (UsbWwid
+ 1);
1921 CompareLen
= (DevicePathNodeLength (UsbWwid
) - sizeof (USB_WWID_DEVICE_PATH
)) / sizeof (CHAR16
);
1922 if (CompareStr
[CompareLen
- 1] == L
'\0') {
1927 // Compare serial number in each supported language.
1929 for (Index
= 0; Index
< TableSize
/ sizeof (UINT16
); Index
++) {
1930 SerialNumberStr
= NULL
;
1931 Status
= UsbIo
->UsbGetStringDescriptor (
1934 DevDesc
.StrSerialNumber
,
1937 if (EFI_ERROR (Status
) || (SerialNumberStr
== NULL
)) {
1941 Length
= StrLen (SerialNumberStr
);
1942 if ((Length
>= CompareLen
) &&
1943 (CompareMem (SerialNumberStr
+ Length
- CompareLen
, CompareStr
, CompareLen
* sizeof (CHAR16
)) == 0)) {
1944 FreePool (SerialNumberStr
);
1948 FreePool (SerialNumberStr
);
1955 Find a USB device path which match the specified short-form device path start
1956 with USB Class or USB WWID device path and load the boot file then return the
1957 image handle. If ParentDevicePath is NULL, this function will search in all USB
1958 devices of the platform. If ParentDevicePath is not NULL,this function will only
1959 search in its child devices.
1961 @param ParentDevicePath The device path of the parent.
1962 @param ShortFormDevicePath The USB Class or USB WWID device path to match.
1964 @return The image Handle if find load file from specified short-form device path
1965 or NULL if not found.
1970 IN EFI_DEVICE_PATH_PROTOCOL
*ParentDevicePath
,
1971 IN EFI_DEVICE_PATH_PROTOCOL
*ShortFormDevicePath
1975 UINTN UsbIoHandleCount
;
1976 EFI_HANDLE
*UsbIoHandleBuffer
;
1977 EFI_DEVICE_PATH_PROTOCOL
*UsbIoDevicePath
;
1978 EFI_USB_IO_PROTOCOL
*UsbIo
;
1982 EFI_HANDLE ImageHandle
;
1984 EFI_DEVICE_PATH_PROTOCOL
*FullDevicePath
;
1985 EFI_DEVICE_PATH_PROTOCOL
*NextDevicePath
;
1987 FullDevicePath
= NULL
;
1991 // Get all UsbIo Handles.
1993 UsbIoHandleCount
= 0;
1994 UsbIoHandleBuffer
= NULL
;
1995 Status
= gBS
->LocateHandleBuffer (
1997 &gEfiUsbIoProtocolGuid
,
2002 if (EFI_ERROR (Status
) || (UsbIoHandleCount
== 0) || (UsbIoHandleBuffer
== NULL
)) {
2006 ParentSize
= (ParentDevicePath
== NULL
) ? 0 : GetDevicePathSize (ParentDevicePath
);
2007 for (Index
= 0; Index
< UsbIoHandleCount
; Index
++) {
2009 // Get the Usb IO interface.
2011 Status
= gBS
->HandleProtocol(
2012 UsbIoHandleBuffer
[Index
],
2013 &gEfiUsbIoProtocolGuid
,
2016 if (EFI_ERROR (Status
)) {
2020 UsbIoDevicePath
= DevicePathFromHandle (UsbIoHandleBuffer
[Index
]);
2021 if (UsbIoDevicePath
== NULL
) {
2025 if (ParentDevicePath
!= NULL
) {
2027 // Compare starting part of UsbIoHandle's device path with ParentDevicePath.
2029 Size
= GetDevicePathSize (UsbIoDevicePath
);
2030 if ((Size
< ParentSize
) ||
2031 (CompareMem (UsbIoDevicePath
, ParentDevicePath
, ParentSize
- END_DEVICE_PATH_LENGTH
) != 0)) {
2036 if (BdsMatchUsbClass (UsbIo
, (USB_CLASS_DEVICE_PATH
*) ShortFormDevicePath
) ||
2037 BdsMatchUsbWwid (UsbIo
, (USB_WWID_DEVICE_PATH
*) ShortFormDevicePath
)) {
2039 // Try to find if there is the boot file in this DevicePath
2041 NextDevicePath
= NextDevicePathNode (ShortFormDevicePath
);
2042 if (!IsDevicePathEnd (NextDevicePath
)) {
2043 FullDevicePath
= AppendDevicePath (UsbIoDevicePath
, NextDevicePath
);
2045 // Connect the full device path, so that Simple File System protocol
2046 // could be installed for this USB device.
2048 BdsLibConnectDevicePath (FullDevicePath
);
2049 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, PcdGet32 (PcdProgressCodeOsLoaderLoad
));
2050 Status
= gBS
->LoadImage (
2058 FreePool (FullDevicePath
);
2060 FullDevicePath
= UsbIoDevicePath
;
2061 Status
= EFI_NOT_FOUND
;
2065 // If we didn't find an image directly, we need to try as if it is a removable device boot option
2066 // and load the image according to the default boot behavior for removable device.
2068 if (EFI_ERROR (Status
)) {
2070 // check if there is a bootable removable media could be found in this device path ,
2071 // and get the bootable media handle
2073 Handle
= BdsLibGetBootableHandle(UsbIoDevicePath
);
2074 if (Handle
== NULL
) {
2078 // Load the default boot file \EFI\BOOT\boot{machinename}.EFI from removable Media
2079 // machinename is ia32, ia64, x64, ...
2081 FullDevicePath
= FileDevicePath (Handle
, EFI_REMOVABLE_MEDIA_FILE_NAME
);
2082 if (FullDevicePath
!= NULL
) {
2083 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, PcdGet32 (PcdProgressCodeOsLoaderLoad
));
2084 Status
= gBS
->LoadImage (
2092 if (EFI_ERROR (Status
)) {
2094 // The DevicePath failed, and it's not a valid
2095 // removable media device.
2107 FreePool (UsbIoHandleBuffer
);
2112 Expand USB Class or USB WWID device path node to be full device path of a USB
2113 device in platform then load the boot file on this full device path and return the
2116 This function support following 4 cases:
2117 1) Boot Option device path starts with a USB Class or USB WWID device path,
2118 and there is no Media FilePath device path in the end.
2119 In this case, it will follow Removable Media Boot Behavior.
2120 2) Boot Option device path starts with a USB Class or USB WWID device path,
2121 and ended with Media FilePath device path.
2122 3) Boot Option device path starts with a full device path to a USB Host Controller,
2123 contains a USB Class or USB WWID device path node, while not ended with Media
2124 FilePath device path. In this case, it will follow Removable Media Boot Behavior.
2125 4) Boot Option device path starts with a full device path to a USB Host Controller,
2126 contains a USB Class or USB WWID device path node, and ended with Media
2127 FilePath device path.
2129 @param DevicePath The Boot Option device path.
2131 @return The image handle of boot file, or NULL if there is no boot file found in
2132 the specified USB Class or USB WWID device path.
2136 BdsExpandUsbShortFormDevicePath (
2137 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
2140 EFI_HANDLE
*ImageHandle
;
2141 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
2142 EFI_DEVICE_PATH_PROTOCOL
*ShortFormDevicePath
;
2145 // Search for USB Class or USB WWID device path node.
2147 ShortFormDevicePath
= NULL
;
2149 TempDevicePath
= DevicePath
;
2150 while (!IsDevicePathEnd (TempDevicePath
)) {
2151 if ((DevicePathType (TempDevicePath
) == MESSAGING_DEVICE_PATH
) &&
2152 ((DevicePathSubType (TempDevicePath
) == MSG_USB_CLASS_DP
) ||
2153 (DevicePathSubType (TempDevicePath
) == MSG_USB_WWID_DP
))) {
2154 ShortFormDevicePath
= TempDevicePath
;
2157 TempDevicePath
= NextDevicePathNode (TempDevicePath
);
2160 if (ShortFormDevicePath
== NULL
) {
2162 // No USB Class or USB WWID device path node found, do nothing.
2167 if (ShortFormDevicePath
== DevicePath
) {
2169 // Boot Option device path starts with USB Class or USB WWID device path.
2171 ImageHandle
= BdsFindUsbDevice (NULL
, ShortFormDevicePath
);
2172 if (ImageHandle
== NULL
) {
2174 // Failed to find a match in existing devices, connect the short form USB
2175 // device path and try again.
2177 BdsLibConnectUsbDevByShortFormDP (0xff, ShortFormDevicePath
);
2178 ImageHandle
= BdsFindUsbDevice (NULL
, ShortFormDevicePath
);
2182 // Boot Option device path contains USB Class or USB WWID device path node.
2186 // Prepare the parent device path for search.
2188 TempDevicePath
= DuplicateDevicePath (DevicePath
);
2189 ASSERT (TempDevicePath
!= NULL
);
2190 SetDevicePathEndNode (((UINT8
*) TempDevicePath
) + ((UINTN
) ShortFormDevicePath
- (UINTN
) DevicePath
));
2193 // The USB Host Controller device path is already in Boot Option device path
2194 // and USB Bus driver already support RemainingDevicePath starts with USB
2195 // Class or USB WWID device path, so just search in existing USB devices and
2196 // doesn't perform ConnectController here.
2198 ImageHandle
= BdsFindUsbDevice (TempDevicePath
, ShortFormDevicePath
);
2199 FreePool (TempDevicePath
);
2206 Process the boot option follow the UEFI specification and
2207 special treat the legacy boot option with BBS_DEVICE_PATH.
2209 @param Option The boot option need to be processed
2210 @param DevicePath The device path which describe where to load the
2211 boot image or the legacy BBS device path to boot
2213 @param ExitDataSize The size of exit data.
2214 @param ExitData Data returned when Boot image failed.
2216 @retval EFI_SUCCESS Boot from the input boot option successfully.
2217 @retval EFI_NOT_FOUND If the Device Path is not found in the system
2222 BdsLibBootViaBootOption (
2223 IN BDS_COMMON_OPTION
*Option
,
2224 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
2225 OUT UINTN
*ExitDataSize
,
2226 OUT CHAR16
**ExitData OPTIONAL
2230 EFI_STATUS StatusLogo
;
2232 EFI_HANDLE ImageHandle
;
2233 EFI_DEVICE_PATH_PROTOCOL
*FilePath
;
2234 EFI_LOADED_IMAGE_PROTOCOL
*ImageInfo
;
2235 EFI_DEVICE_PATH_PROTOCOL
*WorkingDevicePath
;
2236 LIST_ENTRY TempBootLists
;
2237 EFI_BOOT_LOGO_PROTOCOL
*BootLogo
;
2239 Status
= EFI_SUCCESS
;
2244 // If it's Device Path that starts with a hard drive path, append it with the front part to compose a
2247 WorkingDevicePath
= NULL
;
2248 if ((DevicePathType (DevicePath
) == MEDIA_DEVICE_PATH
) &&
2249 (DevicePathSubType (DevicePath
) == MEDIA_HARDDRIVE_DP
)) {
2250 WorkingDevicePath
= BdsExpandPartitionPartialDevicePathToFull (
2251 (HARDDRIVE_DEVICE_PATH
*)DevicePath
2253 if (WorkingDevicePath
!= NULL
) {
2254 DevicePath
= WorkingDevicePath
;
2261 if (IsBootOptionValidNVVarialbe (Option
)) {
2263 // For a temporary boot (i.e. a boot by selected a EFI Shell using "Boot From File"), Boot Current is actually not valid.
2264 // In this case, "BootCurrent" is not created.
2265 // Only create the BootCurrent variable when it points to a valid Boot#### variable.
2267 SetVariableAndReportStatusCodeOnError (
2269 &gEfiGlobalVariableGuid
,
2270 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
2272 &Option
->BootCurrent
2277 // Signal the EVT_SIGNAL_READY_TO_BOOT event
2279 EfiSignalEventReadyToBoot();
2282 // Report Status Code to indicate ReadyToBoot event was signalled
2284 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_SW_DXE_BS_PC_READY_TO_BOOT_EVENT
));
2287 // Expand USB Class or USB WWID device path node to be full device path of a USB
2288 // device in platform then load the boot file on this full device path and get the
2291 ImageHandle
= BdsExpandUsbShortFormDevicePath (DevicePath
);
2294 // Adjust the different type memory page number just before booting
2295 // and save the updated info into the variable for next boot to use
2297 BdsSetMemoryTypeInformationVariable ();
2300 // By expanding the USB Class or WWID device path, the ImageHandle has returnned.
2301 // Here get the ImageHandle for the non USB class or WWID device path.
2303 if (ImageHandle
== NULL
) {
2304 ASSERT (Option
->DevicePath
!= NULL
);
2305 if ((DevicePathType (Option
->DevicePath
) == BBS_DEVICE_PATH
) &&
2306 (DevicePathSubType (Option
->DevicePath
) == BBS_BBS_DP
)
2309 // Check to see if we should legacy BOOT. If yes then do the legacy boot
2311 return BdsLibDoLegacyBoot (Option
);
2315 // If the boot option point to Internal FV shell, make sure it is valid
2317 Status
= BdsLibUpdateFvFileDevicePath (&DevicePath
, PcdGetPtr(PcdShellFile
));
2318 if (!EFI_ERROR(Status
)) {
2319 if (Option
->DevicePath
!= NULL
) {
2320 FreePool(Option
->DevicePath
);
2322 Option
->DevicePath
= AllocateZeroPool (GetDevicePathSize (DevicePath
));
2323 ASSERT(Option
->DevicePath
!= NULL
);
2324 CopyMem (Option
->DevicePath
, DevicePath
, GetDevicePathSize (DevicePath
));
2326 // Update the shell boot option
2328 InitializeListHead (&TempBootLists
);
2329 BdsLibRegisterNewOption (&TempBootLists
, DevicePath
, L
"EFI Internal Shell", L
"BootOrder");
2332 // free the temporary device path created by BdsLibUpdateFvFileDevicePath()
2334 FreePool (DevicePath
);
2335 DevicePath
= Option
->DevicePath
;
2340 if (Option
->Description
== NULL
) {
2341 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Booting from unknown device path\n"));
2343 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Booting %S\n", Option
->Description
));
2349 // Report status code for OS Loader LoadImage.
2351 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, PcdGet32 (PcdProgressCodeOsLoaderLoad
));
2352 Status
= gBS
->LoadImage (
2362 // If we didn't find an image directly, we need to try as if it is a removable device boot option
2363 // and load the image according to the default boot behavior for removable device.
2365 if (EFI_ERROR (Status
)) {
2367 // check if there is a bootable removable media could be found in this device path ,
2368 // and get the bootable media handle
2370 Handle
= BdsLibGetBootableHandle(DevicePath
);
2371 if (Handle
!= NULL
) {
2373 // Load the default boot file \EFI\BOOT\boot{machinename}.EFI from removable Media
2374 // machinename is ia32, ia64, x64, ...
2376 FilePath
= FileDevicePath (Handle
, EFI_REMOVABLE_MEDIA_FILE_NAME
);
2377 if (FilePath
!= NULL
) {
2378 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, PcdGet32 (PcdProgressCodeOsLoaderLoad
));
2379 Status
= gBS
->LoadImage (
2392 // Provide the image with it's load options
2394 if ((ImageHandle
== NULL
) || (EFI_ERROR(Status
))) {
2396 // Report Status Code to indicate that the failure to load boot option
2398 REPORT_STATUS_CODE (
2399 EFI_ERROR_CODE
| EFI_ERROR_MINOR
,
2400 (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_SW_DXE_BS_EC_BOOT_OPTION_LOAD_ERROR
)
2405 Status
= gBS
->HandleProtocol (ImageHandle
, &gEfiLoadedImageProtocolGuid
, (VOID
**) &ImageInfo
);
2406 ASSERT_EFI_ERROR (Status
);
2408 if (Option
->LoadOptionsSize
!= 0) {
2409 ImageInfo
->LoadOptionsSize
= Option
->LoadOptionsSize
;
2410 ImageInfo
->LoadOptions
= Option
->LoadOptions
;
2414 // Clean to NULL because the image is loaded directly from the firmwares boot manager.
2416 ImageInfo
->ParentHandle
= NULL
;
2419 // Before calling the image, enable the Watchdog Timer for
2420 // the 5 Minute period
2422 gBS
->SetWatchdogTimer (5 * 60, 0x0000, 0x00, NULL
);
2425 // Write boot to OS performance data for UEFI boot
2428 WriteBootToOsPerformanceData (NULL
, NULL
);
2432 // Report status code for OS Loader StartImage.
2434 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, PcdGet32 (PcdProgressCodeOsLoaderStart
));
2436 Status
= gBS
->StartImage (ImageHandle
, ExitDataSize
, ExitData
);
2437 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Image Return Status = %r\n", Status
));
2438 if (EFI_ERROR (Status
)) {
2440 // Report Status Code to indicate that boot failure
2442 REPORT_STATUS_CODE (
2443 EFI_ERROR_CODE
| EFI_ERROR_MINOR
,
2444 (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_SW_DXE_BS_EC_BOOT_OPTION_FAILED
)
2449 // Clear the Watchdog Timer after the image returns
2451 gBS
->SetWatchdogTimer (0x0000, 0x0000, 0x0000, NULL
);
2455 // Set Logo status invalid after trying one boot option
2458 StatusLogo
= gBS
->LocateProtocol (&gEfiBootLogoProtocolGuid
, NULL
, (VOID
**) &BootLogo
);
2459 if (!EFI_ERROR (StatusLogo
) && (BootLogo
!= NULL
)) {
2460 BootLogo
->SetBootLogo (BootLogo
, NULL
, 0, 0, 0, 0);
2464 // Clear Boot Current
2465 // Deleting variable with current implementation shouldn't fail.
2469 &gEfiGlobalVariableGuid
,
2470 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
2480 Expand a device path that starts with a hard drive media device path node to be a
2481 full device path that includes the full hardware path to the device. We need
2482 to do this so it can be booted. As an optimization the front match (the part point
2483 to the partition node. E.g. ACPI() /PCI()/ATA()/Partition() ) is saved in a variable
2484 so a connect all is not required on every boot. All successful history device path
2485 which point to partition node (the front part) will be saved.
2487 @param HardDriveDevicePath EFI Device Path to boot, if it starts with a hard
2488 drive media device path.
2489 @return A Pointer to the full device path or NULL if a valid Hard Drive devic path
2493 EFI_DEVICE_PATH_PROTOCOL
*
2495 BdsExpandPartitionPartialDevicePathToFull (
2496 IN HARDDRIVE_DEVICE_PATH
*HardDriveDevicePath
2500 UINTN BlockIoHandleCount
;
2501 EFI_HANDLE
*BlockIoBuffer
;
2502 EFI_DEVICE_PATH_PROTOCOL
*FullDevicePath
;
2503 EFI_DEVICE_PATH_PROTOCOL
*BlockIoDevicePath
;
2504 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
2507 EFI_DEVICE_PATH_PROTOCOL
*CachedDevicePath
;
2508 EFI_DEVICE_PATH_PROTOCOL
*TempNewDevicePath
;
2509 UINTN CachedDevicePathSize
;
2510 BOOLEAN DeviceExist
;
2512 EFI_DEVICE_PATH_PROTOCOL
*Instance
;
2515 FullDevicePath
= NULL
;
2517 // Check if there is prestore HD_BOOT_DEVICE_PATH_VARIABLE_NAME variable.
2518 // If exist, search the front path which point to partition node in the variable instants.
2519 // If fail to find or HD_BOOT_DEVICE_PATH_VARIABLE_NAME not exist, reconnect all and search in all system
2522 HD_BOOT_DEVICE_PATH_VARIABLE_NAME
,
2523 &gHdBootDevicePathVariablGuid
,
2524 (VOID
**) &CachedDevicePath
,
2525 &CachedDevicePathSize
2529 // Delete the invalid HD_BOOT_DEVICE_PATH_VARIABLE_NAME variable.
2531 if ((CachedDevicePath
!= NULL
) && !IsDevicePathValid (CachedDevicePath
, CachedDevicePathSize
)) {
2532 FreePool (CachedDevicePath
);
2533 CachedDevicePath
= NULL
;
2534 Status
= gRT
->SetVariable (
2535 HD_BOOT_DEVICE_PATH_VARIABLE_NAME
,
2536 &gHdBootDevicePathVariablGuid
,
2541 ASSERT_EFI_ERROR (Status
);
2544 if (CachedDevicePath
!= NULL
) {
2545 TempNewDevicePath
= CachedDevicePath
;
2546 DeviceExist
= FALSE
;
2550 // Check every instance of the variable
2551 // First, check whether the instance contain the partition node, which is needed for distinguishing multi
2552 // partial partition boot option. Second, check whether the instance could be connected.
2554 Instance
= GetNextDevicePathInstance (&TempNewDevicePath
, &Size
);
2555 if (MatchPartitionDevicePathNode (Instance
, HardDriveDevicePath
)) {
2557 // Connect the device path instance, the device path point to hard drive media device path node
2558 // e.g. ACPI() /PCI()/ATA()/Partition()
2560 Status
= BdsLibConnectDevicePath (Instance
);
2561 if (!EFI_ERROR (Status
)) {
2567 // Come here means the first instance is not matched
2571 } while (TempNewDevicePath
!= NULL
);
2575 // Find the matched device path.
2576 // Append the file path information from the boot option and return the fully expanded device path.
2578 DevicePath
= NextDevicePathNode ((EFI_DEVICE_PATH_PROTOCOL
*) HardDriveDevicePath
);
2579 FullDevicePath
= AppendDevicePath (Instance
, DevicePath
);
2582 // Adjust the HD_BOOT_DEVICE_PATH_VARIABLE_NAME instances sequence if the matched one is not first one.
2586 // First delete the matched instance.
2588 TempNewDevicePath
= CachedDevicePath
;
2589 CachedDevicePath
= BdsLibDelPartMatchInstance (CachedDevicePath
, Instance
);
2590 FreePool (TempNewDevicePath
);
2593 // Second, append the remaining path after the matched instance
2595 TempNewDevicePath
= CachedDevicePath
;
2596 CachedDevicePath
= AppendDevicePathInstance (Instance
, CachedDevicePath
);
2597 FreePool (TempNewDevicePath
);
2599 // Save the matching Device Path so we don't need to do a connect all next time
2600 // Failure to set the variable only impacts the performance when next time expanding the short-form device path.
2602 Status
= gRT
->SetVariable (
2603 HD_BOOT_DEVICE_PATH_VARIABLE_NAME
,
2604 &gHdBootDevicePathVariablGuid
,
2605 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
2606 GetDevicePathSize (CachedDevicePath
),
2611 FreePool (Instance
);
2612 FreePool (CachedDevicePath
);
2613 return FullDevicePath
;
2618 // If we get here we fail to find or HD_BOOT_DEVICE_PATH_VARIABLE_NAME not exist, and now we need
2619 // to search all devices in the system for a matched partition
2621 BdsLibConnectAllDriversToAllControllers ();
2622 Status
= gBS
->LocateHandleBuffer (ByProtocol
, &gEfiBlockIoProtocolGuid
, NULL
, &BlockIoHandleCount
, &BlockIoBuffer
);
2623 if (EFI_ERROR (Status
) || BlockIoHandleCount
== 0 || BlockIoBuffer
== NULL
) {
2625 // If there was an error or there are no device handles that support
2626 // the BLOCK_IO Protocol, then return.
2631 // Loop through all the device handles that support the BLOCK_IO Protocol
2633 for (Index
= 0; Index
< BlockIoHandleCount
; Index
++) {
2635 Status
= gBS
->HandleProtocol (BlockIoBuffer
[Index
], &gEfiDevicePathProtocolGuid
, (VOID
*) &BlockIoDevicePath
);
2636 if (EFI_ERROR (Status
) || BlockIoDevicePath
== NULL
) {
2640 if (MatchPartitionDevicePathNode (BlockIoDevicePath
, HardDriveDevicePath
)) {
2642 // Find the matched partition device path
2644 DevicePath
= NextDevicePathNode ((EFI_DEVICE_PATH_PROTOCOL
*) HardDriveDevicePath
);
2645 FullDevicePath
= AppendDevicePath (BlockIoDevicePath
, DevicePath
);
2648 // Save the matched partition device path in HD_BOOT_DEVICE_PATH_VARIABLE_NAME variable
2650 if (CachedDevicePath
!= NULL
) {
2652 // Save the matched partition device path as first instance of HD_BOOT_DEVICE_PATH_VARIABLE_NAME variable
2654 if (BdsLibMatchDevicePaths (CachedDevicePath
, BlockIoDevicePath
)) {
2655 TempNewDevicePath
= CachedDevicePath
;
2656 CachedDevicePath
= BdsLibDelPartMatchInstance (CachedDevicePath
, BlockIoDevicePath
);
2657 FreePool(TempNewDevicePath
);
2660 if (CachedDevicePath
!= NULL
) {
2661 TempNewDevicePath
= CachedDevicePath
;
2662 CachedDevicePath
= AppendDevicePathInstance (BlockIoDevicePath
, CachedDevicePath
);
2663 FreePool(TempNewDevicePath
);
2665 CachedDevicePath
= DuplicateDevicePath (BlockIoDevicePath
);
2669 // Here limit the device path instance number to 12, which is max number for a system support 3 IDE controller
2670 // If the user try to boot many OS in different HDs or partitions, in theory,
2671 // the HD_BOOT_DEVICE_PATH_VARIABLE_NAME variable maybe become larger and larger.
2674 ASSERT (CachedDevicePath
!= NULL
);
2675 TempNewDevicePath
= CachedDevicePath
;
2676 while (!IsDevicePathEnd (TempNewDevicePath
)) {
2677 TempNewDevicePath
= NextDevicePathNode (TempNewDevicePath
);
2679 // Parse one instance
2681 while (!IsDevicePathEndType (TempNewDevicePath
)) {
2682 TempNewDevicePath
= NextDevicePathNode (TempNewDevicePath
);
2686 // If the CachedDevicePath variable contain too much instance, only remain 12 instances.
2688 if (InstanceNum
>= 12) {
2689 SetDevicePathEndNode (TempNewDevicePath
);
2694 CachedDevicePath
= DuplicateDevicePath (BlockIoDevicePath
);
2698 // Save the matching Device Path so we don't need to do a connect all next time
2699 // Failure to set the variable only impacts the performance when next time expanding the short-form device path.
2701 Status
= gRT
->SetVariable (
2702 HD_BOOT_DEVICE_PATH_VARIABLE_NAME
,
2703 &gHdBootDevicePathVariablGuid
,
2704 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
2705 GetDevicePathSize (CachedDevicePath
),
2713 if (CachedDevicePath
!= NULL
) {
2714 FreePool (CachedDevicePath
);
2716 if (BlockIoBuffer
!= NULL
) {
2717 FreePool (BlockIoBuffer
);
2719 return FullDevicePath
;
2723 Check whether there is a instance in BlockIoDevicePath, which contain multi device path
2724 instances, has the same partition node with HardDriveDevicePath device path
2726 @param BlockIoDevicePath Multi device path instances which need to check
2727 @param HardDriveDevicePath A device path which starts with a hard drive media
2730 @retval TRUE There is a matched device path instance.
2731 @retval FALSE There is no matched device path instance.
2736 MatchPartitionDevicePathNode (
2737 IN EFI_DEVICE_PATH_PROTOCOL
*BlockIoDevicePath
,
2738 IN HARDDRIVE_DEVICE_PATH
*HardDriveDevicePath
2741 HARDDRIVE_DEVICE_PATH
*TmpHdPath
;
2742 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
2744 EFI_DEVICE_PATH_PROTOCOL
*BlockIoHdDevicePathNode
;
2746 if ((BlockIoDevicePath
== NULL
) || (HardDriveDevicePath
== NULL
)) {
2751 // Make PreviousDevicePath == the device path node before the end node
2753 DevicePath
= BlockIoDevicePath
;
2754 BlockIoHdDevicePathNode
= NULL
;
2757 // find the partition device path node
2759 while (!IsDevicePathEnd (DevicePath
)) {
2760 if ((DevicePathType (DevicePath
) == MEDIA_DEVICE_PATH
) &&
2761 (DevicePathSubType (DevicePath
) == MEDIA_HARDDRIVE_DP
)
2763 BlockIoHdDevicePathNode
= DevicePath
;
2767 DevicePath
= NextDevicePathNode (DevicePath
);
2770 if (BlockIoHdDevicePathNode
== NULL
) {
2774 // See if the harddrive device path in blockio matches the orig Hard Drive Node
2776 TmpHdPath
= (HARDDRIVE_DEVICE_PATH
*) BlockIoHdDevicePathNode
;
2780 // Check for the match
2782 if ((TmpHdPath
->MBRType
== HardDriveDevicePath
->MBRType
) &&
2783 (TmpHdPath
->SignatureType
== HardDriveDevicePath
->SignatureType
)) {
2784 switch (TmpHdPath
->SignatureType
) {
2785 case SIGNATURE_TYPE_GUID
:
2786 Match
= CompareGuid ((EFI_GUID
*)TmpHdPath
->Signature
, (EFI_GUID
*)HardDriveDevicePath
->Signature
);
2788 case SIGNATURE_TYPE_MBR
:
2789 Match
= (BOOLEAN
)(*((UINT32
*)(&(TmpHdPath
->Signature
[0]))) == ReadUnaligned32((UINT32
*)(&(HardDriveDevicePath
->Signature
[0]))));
2801 Delete the boot option associated with the handle passed in.
2803 @param Handle The handle which present the device path to create
2806 @retval EFI_SUCCESS Delete the boot option success
2807 @retval EFI_NOT_FOUND If the Device Path is not found in the system
2808 @retval EFI_OUT_OF_RESOURCES Lack of memory resource
2809 @retval Other Error return value from SetVariable()
2813 BdsLibDeleteOptionFromHandle (
2814 IN EFI_HANDLE Handle
2818 UINT8
*BootOptionVar
;
2819 UINTN BootOrderSize
;
2820 UINTN BootOptionSize
;
2823 UINT16 BootOption
[BOOT_OPTION_MAX_CHAR
];
2824 UINTN DevicePathSize
;
2825 UINTN OptionDevicePathSize
;
2826 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
2827 EFI_DEVICE_PATH_PROTOCOL
*OptionDevicePath
;
2830 Status
= EFI_SUCCESS
;
2835 // Check "BootOrder" variable, if no, means there is no any boot order.
2837 BootOrder
= BdsLibGetVariableAndSize (
2839 &gEfiGlobalVariableGuid
,
2842 if (BootOrder
== NULL
) {
2843 return EFI_NOT_FOUND
;
2847 // Convert device handle to device path protocol instance
2849 DevicePath
= DevicePathFromHandle (Handle
);
2850 if (DevicePath
== NULL
) {
2851 return EFI_NOT_FOUND
;
2853 DevicePathSize
= GetDevicePathSize (DevicePath
);
2856 // Loop all boot order variable and find the matching device path
2859 while (Index
< BootOrderSize
/ sizeof (UINT16
)) {
2860 UnicodeSPrint (BootOption
, sizeof (BootOption
), L
"Boot%04x", BootOrder
[Index
]);
2861 BootOptionVar
= BdsLibGetVariableAndSize (
2863 &gEfiGlobalVariableGuid
,
2867 if (BootOptionVar
== NULL
) {
2868 FreePool (BootOrder
);
2869 return EFI_OUT_OF_RESOURCES
;
2872 if (!ValidateOption(BootOptionVar
, BootOptionSize
)) {
2873 BdsDeleteBootOption (BootOrder
[Index
], BootOrder
, &BootOrderSize
);
2874 FreePool (BootOptionVar
);
2879 TempPtr
= BootOptionVar
;
2880 TempPtr
+= sizeof (UINT32
) + sizeof (UINT16
);
2881 TempPtr
+= StrSize ((CHAR16
*) TempPtr
);
2882 OptionDevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) TempPtr
;
2883 OptionDevicePathSize
= GetDevicePathSize (OptionDevicePath
);
2886 // Check whether the device path match
2888 if ((OptionDevicePathSize
== DevicePathSize
) &&
2889 (CompareMem (DevicePath
, OptionDevicePath
, DevicePathSize
) == 0)) {
2890 BdsDeleteBootOption (BootOrder
[Index
], BootOrder
, &BootOrderSize
);
2891 FreePool (BootOptionVar
);
2895 FreePool (BootOptionVar
);
2900 // Adjust number of boot option for "BootOrder" variable.
2902 Status
= gRT
->SetVariable (
2904 &gEfiGlobalVariableGuid
,
2905 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
2910 // Shrinking variable with existing variable implementation shouldn't fail.
2912 ASSERT_EFI_ERROR (Status
);
2914 FreePool (BootOrder
);
2921 Delete all invalid EFI boot options.
2923 @retval EFI_SUCCESS Delete all invalid boot option success
2924 @retval EFI_NOT_FOUND Variable "BootOrder" is not found
2925 @retval EFI_OUT_OF_RESOURCES Lack of memory resource
2926 @retval Other Error return value from SetVariable()
2930 BdsDeleteAllInvalidEfiBootOption (
2935 UINT8
*BootOptionVar
;
2936 UINTN BootOrderSize
;
2937 UINTN BootOptionSize
;
2941 UINT16 BootOption
[BOOT_OPTION_MAX_CHAR
];
2942 EFI_DEVICE_PATH_PROTOCOL
*OptionDevicePath
;
2944 CHAR16
*Description
;
2947 Status
= EFI_SUCCESS
;
2950 OptionDevicePath
= NULL
;
2955 // Check "BootOrder" variable firstly, this variable hold the number of boot options
2957 BootOrder
= BdsLibGetVariableAndSize (
2959 &gEfiGlobalVariableGuid
,
2962 if (NULL
== BootOrder
) {
2963 return EFI_NOT_FOUND
;
2967 while (Index
< BootOrderSize
/ sizeof (UINT16
)) {
2968 UnicodeSPrint (BootOption
, sizeof (BootOption
), L
"Boot%04x", BootOrder
[Index
]);
2969 BootOptionVar
= BdsLibGetVariableAndSize (
2971 &gEfiGlobalVariableGuid
,
2974 if (NULL
== BootOptionVar
) {
2975 FreePool (BootOrder
);
2976 return EFI_OUT_OF_RESOURCES
;
2979 if (!ValidateOption(BootOptionVar
, BootOptionSize
)) {
2982 TempPtr
= BootOptionVar
;
2983 TempPtr
+= sizeof (UINT32
) + sizeof (UINT16
);
2984 Description
= (CHAR16
*) TempPtr
;
2985 TempPtr
+= StrSize ((CHAR16
*) TempPtr
);
2986 OptionDevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) TempPtr
;
2989 // Skip legacy boot option (BBS boot device)
2991 if ((DevicePathType (OptionDevicePath
) == BBS_DEVICE_PATH
) &&
2992 (DevicePathSubType (OptionDevicePath
) == BBS_BBS_DP
)) {
2993 FreePool (BootOptionVar
);
2999 if (Corrupted
|| !BdsLibIsValidEFIBootOptDevicePathExt (OptionDevicePath
, FALSE
, Description
)) {
3001 // Delete this invalid boot option "Boot####"
3003 Status
= gRT
->SetVariable (
3005 &gEfiGlobalVariableGuid
,
3006 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
3011 // Deleting variable with current variable implementation shouldn't fail.
3013 ASSERT_EFI_ERROR (Status
);
3015 // Mark this boot option in boot order as deleted
3017 BootOrder
[Index
] = 0xffff;
3021 FreePool (BootOptionVar
);
3026 // Adjust boot order array
3029 for (Index
= 0; Index
< BootOrderSize
/ sizeof (UINT16
); Index
++) {
3030 if (BootOrder
[Index
] != 0xffff) {
3031 BootOrder
[Index2
] = BootOrder
[Index
];
3035 Status
= gRT
->SetVariable (
3037 &gEfiGlobalVariableGuid
,
3038 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
3039 Index2
* sizeof (UINT16
),
3043 // Shrinking variable with current variable implementation shouldn't fail.
3045 ASSERT_EFI_ERROR (Status
);
3047 FreePool (BootOrder
);
3054 For EFI boot option, BDS separate them as six types:
3055 1. Network - The boot option points to the SimpleNetworkProtocol device.
3056 Bds will try to automatically create this type boot option when enumerate.
3057 2. Shell - The boot option points to internal flash shell.
3058 Bds will try to automatically create this type boot option when enumerate.
3059 3. Removable BlockIo - The boot option only points to the removable media
3060 device, like USB flash disk, DVD, Floppy etc.
3061 These device should contain a *removable* blockIo
3062 protocol in their device handle.
3063 Bds will try to automatically create this type boot option
3065 4. Fixed BlockIo - The boot option only points to a Fixed blockIo device,
3067 These device should contain a *fixed* blockIo
3068 protocol in their device handle.
3069 BDS will skip fixed blockIo devices, and NOT
3070 automatically create boot option for them. But BDS
3071 will help to delete those fixed blockIo boot option,
3072 whose description rule conflict with other auto-created
3074 5. Non-BlockIo Simplefile - The boot option points to a device whose handle
3075 has SimpleFileSystem Protocol, but has no blockio
3076 protocol. These devices do not offer blockIo
3077 protocol, but BDS still can get the
3078 \EFI\BOOT\boot{machinename}.EFI by SimpleFileSystem
3080 6. File - The boot option points to a file. These boot options are usually
3081 created by user manually or OS loader. BDS will not delete or modify
3084 This function will enumerate all possible boot device in the system, and
3085 automatically create boot options for Network, Shell, Removable BlockIo,
3086 and Non-BlockIo Simplefile devices.
3087 It will only execute once of every boot.
3089 @param BdsBootOptionList The header of the link list which indexed all
3090 current boot options
3092 @retval EFI_SUCCESS Finished all the boot device enumerate and create
3093 the boot option base on that boot device
3095 @retval EFI_OUT_OF_RESOURCES Failed to enumerate the boot device and create the boot option list
3099 BdsLibEnumerateAllBootOption (
3100 IN OUT LIST_ENTRY
*BdsBootOptionList
3104 UINT16 FloppyNumber
;
3105 UINT16 HarddriveNumber
;
3110 UINT16 NonBlockNumber
;
3111 UINTN NumberBlockIoHandles
;
3112 EFI_HANDLE
*BlockIoHandles
;
3113 EFI_BLOCK_IO_PROTOCOL
*BlkIo
;
3114 BOOLEAN Removable
[2];
3115 UINTN RemovableIndex
;
3117 UINTN NumOfLoadFileHandles
;
3118 EFI_HANDLE
*LoadFileHandles
;
3119 UINTN FvHandleCount
;
3120 EFI_HANDLE
*FvHandleBuffer
;
3121 EFI_FV_FILETYPE Type
;
3123 EFI_FV_FILE_ATTRIBUTES Attributes
;
3124 UINT32 AuthenticationStatus
;
3125 EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
;
3126 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
3127 UINTN DevicePathType
;
3129 EFI_HANDLE
*FileSystemHandles
;
3130 UINTN NumberFileSystemHandles
;
3132 EFI_IMAGE_DOS_HEADER DosHeader
;
3135 EFI_IMAGE_OPTIONAL_HEADER_UNION HdrData
;
3136 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
;
3139 HarddriveNumber
= 0;
3146 ZeroMem (Buffer
, sizeof (Buffer
));
3149 // If the boot device enumerate happened, just get the boot
3150 // device from the boot order variable
3152 if (mEnumBootDevice
) {
3153 GetVariable2 (LAST_ENUM_LANGUAGE_VARIABLE_NAME
, &gLastEnumLangGuid
, (VOID
**)&LastLang
, NULL
);
3154 GetEfiGlobalVariable2 (L
"PlatformLang", (VOID
**)&PlatLang
, NULL
);
3155 ASSERT (PlatLang
!= NULL
);
3156 if ((LastLang
!= NULL
) && (AsciiStrCmp (LastLang
, PlatLang
) == 0)) {
3157 Status
= BdsLibBuildOptionFromVar (BdsBootOptionList
, L
"BootOrder");
3158 FreePool (LastLang
);
3159 FreePool (PlatLang
);
3162 Status
= gRT
->SetVariable (
3163 LAST_ENUM_LANGUAGE_VARIABLE_NAME
,
3165 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
3166 AsciiStrSize (PlatLang
),
3170 // Failure to set the variable only impacts the performance next time enumerating the boot options.
3173 if (LastLang
!= NULL
) {
3174 FreePool (LastLang
);
3176 FreePool (PlatLang
);
3181 // Notes: this dirty code is to get the legacy boot option from the
3182 // BBS table and create to variable as the EFI boot option, it should
3183 // be removed after the CSM can provide legacy boot option directly
3185 REFRESH_LEGACY_BOOT_OPTIONS
;
3188 // Delete invalid boot option
3190 BdsDeleteAllInvalidEfiBootOption ();
3193 // Parse removable media followed by fixed media.
3194 // The Removable[] array is used by the for-loop below to create removable media boot options
3195 // at first, and then to create fixed media boot options.
3197 Removable
[0] = FALSE
;
3198 Removable
[1] = TRUE
;
3200 gBS
->LocateHandleBuffer (
3202 &gEfiBlockIoProtocolGuid
,
3204 &NumberBlockIoHandles
,
3208 for (RemovableIndex
= 0; RemovableIndex
< 2; RemovableIndex
++) {
3209 for (Index
= 0; Index
< NumberBlockIoHandles
; Index
++) {
3210 Status
= gBS
->HandleProtocol (
3211 BlockIoHandles
[Index
],
3212 &gEfiBlockIoProtocolGuid
,
3216 // skip the logical partition
3218 if (EFI_ERROR (Status
) || BlkIo
->Media
->LogicalPartition
) {
3223 // firstly fixed block io then the removable block io
3225 if (BlkIo
->Media
->RemovableMedia
== Removable
[RemovableIndex
]) {
3228 DevicePath
= DevicePathFromHandle (BlockIoHandles
[Index
]);
3229 DevicePathType
= BdsGetBootTypeFromDevicePath (DevicePath
);
3231 switch (DevicePathType
) {
3232 case BDS_EFI_ACPI_FLOPPY_BOOT
:
3233 if (FloppyNumber
!= 0) {
3234 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_FLOPPY
)), FloppyNumber
);
3236 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_FLOPPY
)));
3238 BdsLibBuildOptionFromHandle (BlockIoHandles
[Index
], BdsBootOptionList
, Buffer
);
3243 // Assume a removable SATA device should be the DVD/CD device, a fixed SATA device should be the Hard Drive device.
3245 case BDS_EFI_MESSAGE_ATAPI_BOOT
:
3246 case BDS_EFI_MESSAGE_SATA_BOOT
:
3247 if (BlkIo
->Media
->RemovableMedia
) {
3248 if (CdromNumber
!= 0) {
3249 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_CD_DVD
)), CdromNumber
);
3251 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_CD_DVD
)));
3255 if (HarddriveNumber
!= 0) {
3256 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_HARDDRIVE
)), HarddriveNumber
);
3258 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_HARDDRIVE
)));
3262 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Buffer: %S\n", Buffer
));
3263 BdsLibBuildOptionFromHandle (BlockIoHandles
[Index
], BdsBootOptionList
, Buffer
);
3266 case BDS_EFI_MESSAGE_USB_DEVICE_BOOT
:
3267 if (UsbNumber
!= 0) {
3268 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_USB
)), UsbNumber
);
3270 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_USB
)));
3272 BdsLibBuildOptionFromHandle (BlockIoHandles
[Index
], BdsBootOptionList
, Buffer
);
3276 case BDS_EFI_MESSAGE_SCSI_BOOT
:
3277 if (ScsiNumber
!= 0) {
3278 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_SCSI
)), ScsiNumber
);
3280 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_SCSI
)));
3282 BdsLibBuildOptionFromHandle (BlockIoHandles
[Index
], BdsBootOptionList
, Buffer
);
3286 case BDS_EFI_MESSAGE_MISC_BOOT
:
3288 if (MiscNumber
!= 0) {
3289 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_MISC
)), MiscNumber
);
3291 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_MISC
)));
3293 BdsLibBuildOptionFromHandle (BlockIoHandles
[Index
], BdsBootOptionList
, Buffer
);
3300 if (NumberBlockIoHandles
!= 0) {
3301 FreePool (BlockIoHandles
);
3305 // If there is simple file protocol which does not consume block Io protocol, create a boot option for it here.
3308 gBS
->LocateHandleBuffer (
3310 &gEfiSimpleFileSystemProtocolGuid
,
3312 &NumberFileSystemHandles
,
3315 for (Index
= 0; Index
< NumberFileSystemHandles
; Index
++) {
3316 Status
= gBS
->HandleProtocol (
3317 FileSystemHandles
[Index
],
3318 &gEfiBlockIoProtocolGuid
,
3321 if (!EFI_ERROR (Status
)) {
3323 // Skip if the file system handle supports a BlkIo protocol,
3329 // Do the removable Media thing. \EFI\BOOT\boot{machinename}.EFI
3330 // machinename is ia32, ia64, x64, ...
3332 Hdr
.Union
= &HdrData
;
3334 Status
= BdsLibGetImageHeader (
3335 FileSystemHandles
[Index
],
3336 EFI_REMOVABLE_MEDIA_FILE_NAME
,
3340 if (!EFI_ERROR (Status
) &&
3341 EFI_IMAGE_MACHINE_TYPE_SUPPORTED (Hdr
.Pe32
->FileHeader
.Machine
) &&
3342 Hdr
.Pe32
->OptionalHeader
.Subsystem
== EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION
) {
3348 // No such file or the file is not a EFI application, delete this boot option
3350 BdsLibDeleteOptionFromHandle (FileSystemHandles
[Index
]);
3352 if (NonBlockNumber
!= 0) {
3353 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NON_BLOCK
)), NonBlockNumber
);
3355 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NON_BLOCK
)));
3357 BdsLibBuildOptionFromHandle (FileSystemHandles
[Index
], BdsBootOptionList
, Buffer
);
3362 if (NumberFileSystemHandles
!= 0) {
3363 FreePool (FileSystemHandles
);
3367 // Parse Network Boot Device
3369 NumOfLoadFileHandles
= 0;
3371 // Search Load File protocol for PXE boot option.
3373 gBS
->LocateHandleBuffer (
3375 &gEfiLoadFileProtocolGuid
,
3377 &NumOfLoadFileHandles
,
3381 for (Index
= 0; Index
< NumOfLoadFileHandles
; Index
++) {
3383 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NETWORK
)), Index
);
3385 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NETWORK
)));
3387 BdsLibBuildOptionFromHandle (LoadFileHandles
[Index
], BdsBootOptionList
, Buffer
);
3390 if (NumOfLoadFileHandles
!= 0) {
3391 FreePool (LoadFileHandles
);
3395 // Check if we have on flash shell
3397 gBS
->LocateHandleBuffer (
3399 &gEfiFirmwareVolume2ProtocolGuid
,
3404 for (Index
= 0; Index
< FvHandleCount
; Index
++) {
3405 gBS
->HandleProtocol (
3406 FvHandleBuffer
[Index
],
3407 &gEfiFirmwareVolume2ProtocolGuid
,
3411 Status
= Fv
->ReadFile (
3413 PcdGetPtr(PcdShellFile
),
3418 &AuthenticationStatus
3420 if (EFI_ERROR (Status
)) {
3422 // Skip if no shell file in the FV
3427 // Build the shell boot option
3429 BdsLibBuildOptionFromShell (FvHandleBuffer
[Index
], BdsBootOptionList
);
3432 if (FvHandleCount
!= 0) {
3433 FreePool (FvHandleBuffer
);
3436 // Make sure every boot only have one time
3437 // boot device enumerate
3439 Status
= BdsLibBuildOptionFromVar (BdsBootOptionList
, L
"BootOrder");
3440 mEnumBootDevice
= TRUE
;
3446 Build the boot option with the handle parsed in
3448 @param Handle The handle which present the device path to create
3450 @param BdsBootOptionList The header of the link list which indexed all
3451 current boot options
3452 @param String The description of the boot option.
3457 BdsLibBuildOptionFromHandle (
3458 IN EFI_HANDLE Handle
,
3459 IN LIST_ENTRY
*BdsBootOptionList
,
3463 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
3465 DevicePath
= DevicePathFromHandle (Handle
);
3468 // Create and register new boot option
3470 BdsLibRegisterNewOption (BdsBootOptionList
, DevicePath
, String
, L
"BootOrder");
3475 Build the on flash shell boot option with the handle parsed in.
3477 @param Handle The handle which present the device path to create
3478 on flash shell boot option
3479 @param BdsBootOptionList The header of the link list which indexed all
3480 current boot options
3485 BdsLibBuildOptionFromShell (
3486 IN EFI_HANDLE Handle
,
3487 IN OUT LIST_ENTRY
*BdsBootOptionList
3490 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
3491 MEDIA_FW_VOL_FILEPATH_DEVICE_PATH ShellNode
;
3493 DevicePath
= DevicePathFromHandle (Handle
);
3496 // Build the shell device path
3498 EfiInitializeFwVolDevicepathNode (&ShellNode
, PcdGetPtr(PcdShellFile
));
3500 DevicePath
= AppendDevicePathNode (DevicePath
, (EFI_DEVICE_PATH_PROTOCOL
*) &ShellNode
);
3503 // Create and register the shell boot option
3505 BdsLibRegisterNewOption (BdsBootOptionList
, DevicePath
, L
"EFI Internal Shell", L
"BootOrder");
3510 Boot from the UEFI spec defined "BootNext" variable.
3523 BDS_COMMON_OPTION
*BootOption
;
3524 LIST_ENTRY TempList
;
3529 // Init the boot option name buffer and temp link list
3531 InitializeListHead (&TempList
);
3532 ZeroMem (Buffer
, sizeof (Buffer
));
3534 BootNext
= BdsLibGetVariableAndSize (
3536 &gEfiGlobalVariableGuid
,
3541 // Clear the boot next variable first
3543 if (BootNext
!= NULL
) {
3544 Status
= gRT
->SetVariable (
3546 &gEfiGlobalVariableGuid
,
3547 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
3552 // Deleting variable with current variable implementation shouldn't fail.
3554 ASSERT_EFI_ERROR (Status
);
3557 // Start to build the boot option and try to boot
3559 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"Boot%04x", *BootNext
);
3560 BootOption
= BdsLibVariableToOption (&TempList
, Buffer
);
3561 ASSERT (BootOption
!= NULL
);
3562 BdsLibConnectDevicePath (BootOption
->DevicePath
);
3563 BdsLibBootViaBootOption (BootOption
, BootOption
->DevicePath
, &ExitDataSize
, &ExitData
);
3564 FreePool(BootOption
);
3571 Return the bootable media handle.
3572 First, check the device is connected
3573 Second, check whether the device path point to a device which support SimpleFileSystemProtocol,
3574 Third, detect the the default boot file in the Media, and return the removable Media handle.
3576 @param DevicePath Device Path to a bootable device
3578 @return The bootable media handle. If the media on the DevicePath is not bootable, NULL will return.
3583 BdsLibGetBootableHandle (
3584 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
3589 EFI_DEVICE_PATH_PROTOCOL
*UpdatedDevicePath
;
3590 EFI_DEVICE_PATH_PROTOCOL
*DupDevicePath
;
3592 EFI_BLOCK_IO_PROTOCOL
*BlockIo
;
3594 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
3597 EFI_HANDLE ReturnHandle
;
3598 EFI_HANDLE
*SimpleFileSystemHandles
;
3600 UINTN NumberSimpleFileSystemHandles
;
3602 EFI_IMAGE_DOS_HEADER DosHeader
;
3603 EFI_IMAGE_OPTIONAL_HEADER_UNION HdrData
;
3604 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
;
3606 UpdatedDevicePath
= DevicePath
;
3609 // Enter to critical section to protect the acquired BlockIo instance
3610 // from getting released due to the USB mass storage hotplug event
3612 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
3615 // Check whether the device is connected
3617 Status
= gBS
->LocateDevicePath (&gEfiBlockIoProtocolGuid
, &UpdatedDevicePath
, &Handle
);
3618 if (EFI_ERROR (Status
)) {
3620 // Skip the case that the boot option point to a simple file protocol which does not consume block Io protocol,
3622 Status
= gBS
->LocateDevicePath (&gEfiSimpleFileSystemProtocolGuid
, &UpdatedDevicePath
, &Handle
);
3623 if (EFI_ERROR (Status
)) {
3625 // Fail to find the proper BlockIo and simple file protocol, maybe because device not present, we need to connect it firstly
3627 UpdatedDevicePath
= DevicePath
;
3628 Status
= gBS
->LocateDevicePath (&gEfiDevicePathProtocolGuid
, &UpdatedDevicePath
, &Handle
);
3629 gBS
->ConnectController (Handle
, NULL
, NULL
, TRUE
);
3633 // For removable device boot option, its contained device path only point to the removable device handle,
3634 // should make sure all its children handles (its child partion or media handles) are created and connected.
3636 gBS
->ConnectController (Handle
, NULL
, NULL
, TRUE
);
3638 // Get BlockIo protocol and check removable attribute
3640 Status
= gBS
->HandleProtocol (Handle
, &gEfiBlockIoProtocolGuid
, (VOID
**)&BlockIo
);
3641 ASSERT_EFI_ERROR (Status
);
3644 // Issue a dummy read to the device to check for media change.
3645 // When the removable media is changed, any Block IO read/write will
3646 // cause the BlockIo protocol be reinstalled and EFI_MEDIA_CHANGED is
3647 // returned. After the Block IO protocol is reinstalled, subsequent
3648 // Block IO read/write will success.
3650 Buffer
= AllocatePool (BlockIo
->Media
->BlockSize
);
3651 if (Buffer
!= NULL
) {
3652 BlockIo
->ReadBlocks (
3654 BlockIo
->Media
->MediaId
,
3656 BlockIo
->Media
->BlockSize
,
3664 // Detect the the default boot file from removable Media
3668 // 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
3669 // Try to locate the USB node device path first, if fail then use its previous PCI node to search
3671 DupDevicePath
= DuplicateDevicePath (DevicePath
);
3672 ASSERT (DupDevicePath
!= NULL
);
3674 UpdatedDevicePath
= DupDevicePath
;
3675 Status
= gBS
->LocateDevicePath (&gEfiDevicePathProtocolGuid
, &UpdatedDevicePath
, &Handle
);
3677 // 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
3678 // Acpi()/Pci()/Usb() --> Acpi()/Pci()
3680 if ((DevicePathType (UpdatedDevicePath
) == MESSAGING_DEVICE_PATH
) &&
3681 (DevicePathSubType (UpdatedDevicePath
) == MSG_USB_DP
)) {
3683 // Remove the usb node, let the device path only point to PCI node
3685 SetDevicePathEndNode (UpdatedDevicePath
);
3686 UpdatedDevicePath
= DupDevicePath
;
3688 UpdatedDevicePath
= DevicePath
;
3692 // Get the device path size of boot option
3694 Size
= GetDevicePathSize(UpdatedDevicePath
) - sizeof (EFI_DEVICE_PATH_PROTOCOL
); // minus the end node
3695 ReturnHandle
= NULL
;
3696 gBS
->LocateHandleBuffer (
3698 &gEfiSimpleFileSystemProtocolGuid
,
3700 &NumberSimpleFileSystemHandles
,
3701 &SimpleFileSystemHandles
3703 for (Index
= 0; Index
< NumberSimpleFileSystemHandles
; Index
++) {
3705 // Get the device path size of SimpleFileSystem handle
3707 TempDevicePath
= DevicePathFromHandle (SimpleFileSystemHandles
[Index
]);
3708 TempSize
= GetDevicePathSize (TempDevicePath
)- sizeof (EFI_DEVICE_PATH_PROTOCOL
); // minus the end node
3710 // Check whether the device path of boot option is part of the SimpleFileSystem handle's device path
3712 if (Size
<= TempSize
&& CompareMem (TempDevicePath
, UpdatedDevicePath
, Size
)==0) {
3714 // Load the default boot file \EFI\BOOT\boot{machinename}.EFI from removable Media
3715 // machinename is ia32, ia64, x64, ...
3717 Hdr
.Union
= &HdrData
;
3718 Status
= BdsLibGetImageHeader (
3719 SimpleFileSystemHandles
[Index
],
3720 EFI_REMOVABLE_MEDIA_FILE_NAME
,
3724 if (!EFI_ERROR (Status
) &&
3725 EFI_IMAGE_MACHINE_TYPE_SUPPORTED (Hdr
.Pe32
->FileHeader
.Machine
) &&
3726 Hdr
.Pe32
->OptionalHeader
.Subsystem
== EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION
) {
3727 ReturnHandle
= SimpleFileSystemHandles
[Index
];
3733 FreePool(DupDevicePath
);
3735 if (SimpleFileSystemHandles
!= NULL
) {
3736 FreePool(SimpleFileSystemHandles
);
3739 gBS
->RestoreTPL (OldTpl
);
3741 return ReturnHandle
;
3745 Check to see if the network cable is plugged in. If the DevicePath is not
3746 connected it will be connected.
3748 @param DevicePath Device Path to check
3750 @retval TRUE DevicePath points to an Network that is connected
3751 @retval FALSE DevicePath does not point to a bootable network
3755 BdsLibNetworkBootWithMediaPresent (
3756 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
3760 EFI_DEVICE_PATH_PROTOCOL
*UpdatedDevicePath
;
3762 EFI_SIMPLE_NETWORK_PROTOCOL
*Snp
;
3763 BOOLEAN MediaPresent
;
3764 UINT32 InterruptStatus
;
3766 MediaPresent
= FALSE
;
3768 UpdatedDevicePath
= DevicePath
;
3770 // Locate Load File Protocol for PXE boot option first
3772 Status
= gBS
->LocateDevicePath (&gEfiLoadFileProtocolGuid
, &UpdatedDevicePath
, &Handle
);
3773 if (EFI_ERROR (Status
)) {
3775 // Device not present so see if we need to connect it
3777 Status
= BdsLibConnectDevicePath (DevicePath
);
3778 if (!EFI_ERROR (Status
)) {
3780 // This one should work after we did the connect
3782 Status
= gBS
->LocateDevicePath (&gEfiLoadFileProtocolGuid
, &UpdatedDevicePath
, &Handle
);
3786 if (!EFI_ERROR (Status
)) {
3787 Status
= gBS
->HandleProtocol (Handle
, &gEfiSimpleNetworkProtocolGuid
, (VOID
**)&Snp
);
3788 if (EFI_ERROR (Status
)) {
3790 // Failed to open SNP from this handle, try to get SNP from parent handle
3792 UpdatedDevicePath
= DevicePathFromHandle (Handle
);
3793 if (UpdatedDevicePath
!= NULL
) {
3794 Status
= gBS
->LocateDevicePath (&gEfiSimpleNetworkProtocolGuid
, &UpdatedDevicePath
, &Handle
);
3795 if (!EFI_ERROR (Status
)) {
3797 // SNP handle found, get SNP from it
3799 Status
= gBS
->HandleProtocol (Handle
, &gEfiSimpleNetworkProtocolGuid
, (VOID
**) &Snp
);
3804 if (!EFI_ERROR (Status
)) {
3805 if (Snp
->Mode
->MediaPresentSupported
) {
3806 if (Snp
->Mode
->State
== EfiSimpleNetworkInitialized
) {
3808 // Invoke Snp->GetStatus() to refresh the media status
3810 Snp
->GetStatus (Snp
, &InterruptStatus
, NULL
);
3813 // In case some one else is using the SNP check to see if it's connected
3815 MediaPresent
= Snp
->Mode
->MediaPresent
;
3818 // No one is using SNP so we need to Start and Initialize so
3819 // MediaPresent will be valid.
3821 Status
= Snp
->Start (Snp
);
3822 if (!EFI_ERROR (Status
)) {
3823 Status
= Snp
->Initialize (Snp
, 0, 0);
3824 if (!EFI_ERROR (Status
)) {
3825 MediaPresent
= Snp
->Mode
->MediaPresent
;
3826 Snp
->Shutdown (Snp
);
3832 MediaPresent
= TRUE
;
3837 return MediaPresent
;
3841 For a bootable Device path, return its boot type.
3843 @param DevicePath The bootable device Path to check
3845 @retval BDS_EFI_MEDIA_HD_BOOT If given device path contains MEDIA_DEVICE_PATH type device path node
3846 which subtype is MEDIA_HARDDRIVE_DP
3847 @retval BDS_EFI_MEDIA_CDROM_BOOT If given device path contains MEDIA_DEVICE_PATH type device path node
3848 which subtype is MEDIA_CDROM_DP
3849 @retval BDS_EFI_ACPI_FLOPPY_BOOT If given device path contains ACPI_DEVICE_PATH type device path node
3850 which HID is floppy device.
3851 @retval BDS_EFI_MESSAGE_ATAPI_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node
3852 and its last device path node's subtype is MSG_ATAPI_DP.
3853 @retval BDS_EFI_MESSAGE_SCSI_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node
3854 and its last device path node's subtype is MSG_SCSI_DP.
3855 @retval BDS_EFI_MESSAGE_USB_DEVICE_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node
3856 and its last device path node's subtype is MSG_USB_DP.
3857 @retval BDS_EFI_MESSAGE_MISC_BOOT If the device path not contains any media device path node, and
3858 its last device path node point to a message device path node.
3859 @retval BDS_LEGACY_BBS_BOOT If given device path contains BBS_DEVICE_PATH type device path node.
3860 @retval BDS_EFI_UNSUPPORT An EFI Removable BlockIO device path not point to a media and message device,
3865 BdsGetBootTypeFromDevicePath (
3866 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
3869 ACPI_HID_DEVICE_PATH
*Acpi
;
3870 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
3871 EFI_DEVICE_PATH_PROTOCOL
*LastDeviceNode
;
3874 if (NULL
== DevicePath
) {
3875 return BDS_EFI_UNSUPPORT
;
3878 TempDevicePath
= DevicePath
;
3880 while (!IsDevicePathEndType (TempDevicePath
)) {
3881 switch (DevicePathType (TempDevicePath
)) {
3882 case BBS_DEVICE_PATH
:
3883 return BDS_LEGACY_BBS_BOOT
;
3884 case MEDIA_DEVICE_PATH
:
3885 if (DevicePathSubType (TempDevicePath
) == MEDIA_HARDDRIVE_DP
) {
3886 return BDS_EFI_MEDIA_HD_BOOT
;
3887 } else if (DevicePathSubType (TempDevicePath
) == MEDIA_CDROM_DP
) {
3888 return BDS_EFI_MEDIA_CDROM_BOOT
;
3891 case ACPI_DEVICE_PATH
:
3892 Acpi
= (ACPI_HID_DEVICE_PATH
*) TempDevicePath
;
3893 if (EISA_ID_TO_NUM (Acpi
->HID
) == 0x0604) {
3894 return BDS_EFI_ACPI_FLOPPY_BOOT
;
3897 case MESSAGING_DEVICE_PATH
:
3899 // Get the last device path node
3901 LastDeviceNode
= NextDevicePathNode (TempDevicePath
);
3902 if (DevicePathSubType(LastDeviceNode
) == MSG_DEVICE_LOGICAL_UNIT_DP
) {
3904 // if the next node type is Device Logical Unit, which specify the Logical Unit Number (LUN),
3907 LastDeviceNode
= NextDevicePathNode (LastDeviceNode
);
3910 // if the device path not only point to driver device, it is not a messaging device path,
3912 if (!IsDevicePathEndType (LastDeviceNode
)) {
3916 switch (DevicePathSubType (TempDevicePath
)) {
3918 BootType
= BDS_EFI_MESSAGE_ATAPI_BOOT
;
3922 BootType
= BDS_EFI_MESSAGE_USB_DEVICE_BOOT
;
3926 BootType
= BDS_EFI_MESSAGE_SCSI_BOOT
;
3930 BootType
= BDS_EFI_MESSAGE_SATA_BOOT
;
3933 case MSG_MAC_ADDR_DP
:
3937 BootType
= BDS_EFI_MESSAGE_MAC_BOOT
;
3941 BootType
= BDS_EFI_MESSAGE_MISC_BOOT
;
3949 TempDevicePath
= NextDevicePathNode (TempDevicePath
);
3952 return BDS_EFI_UNSUPPORT
;
3956 Check whether the Device path in a boot option point to a valid bootable device,
3957 And if CheckMedia is true, check the device is ready to boot now.
3959 @param DevPath the Device path in a boot option
3960 @param CheckMedia if true, check the device is ready to boot now.
3962 @retval TRUE the Device path is valid
3963 @retval FALSE the Device path is invalid .
3968 BdsLibIsValidEFIBootOptDevicePath (
3969 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
,
3970 IN BOOLEAN CheckMedia
3973 return BdsLibIsValidEFIBootOptDevicePathExt (DevPath
, CheckMedia
, NULL
);
3977 Check whether the Device path in a boot option point to a valid bootable device,
3978 And if CheckMedia is true, check the device is ready to boot now.
3979 If Description is not NULL and the device path point to a fixed BlockIo
3980 device, check the description whether conflict with other auto-created
3983 @param DevPath the Device path in a boot option
3984 @param CheckMedia if true, check the device is ready to boot now.
3985 @param Description the description in a boot option
3987 @retval TRUE the Device path is valid
3988 @retval FALSE the Device path is invalid .
3993 BdsLibIsValidEFIBootOptDevicePathExt (
3994 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
,
3995 IN BOOLEAN CheckMedia
,
3996 IN CHAR16
*Description
4001 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
4002 EFI_DEVICE_PATH_PROTOCOL
*LastDeviceNode
;
4003 EFI_BLOCK_IO_PROTOCOL
*BlockIo
;
4005 TempDevicePath
= DevPath
;
4006 LastDeviceNode
= DevPath
;
4009 // Check if it's a valid boot option for network boot device.
4010 // Check if there is EfiLoadFileProtocol installed.
4011 // If yes, that means there is a boot option for network.
4013 Status
= gBS
->LocateDevicePath (
4014 &gEfiLoadFileProtocolGuid
,
4018 if (EFI_ERROR (Status
)) {
4020 // Device not present so see if we need to connect it
4022 TempDevicePath
= DevPath
;
4023 BdsLibConnectDevicePath (TempDevicePath
);
4024 Status
= gBS
->LocateDevicePath (
4025 &gEfiLoadFileProtocolGuid
,
4031 if (!EFI_ERROR (Status
)) {
4032 if (!IsDevicePathEnd (TempDevicePath
)) {
4034 // LoadFile protocol is not installed on handle with exactly the same DevPath
4041 // Test if it is ready to boot now
4043 if (BdsLibNetworkBootWithMediaPresent(DevPath
)) {
4052 // If the boot option point to a file, it is a valid EFI boot option,
4053 // and assume it is ready to boot now
4055 while (!IsDevicePathEnd (TempDevicePath
)) {
4057 // If there is USB Class or USB WWID device path node, treat it as valid EFI
4058 // Boot Option. BdsExpandUsbShortFormDevicePath () will be used to expand it
4059 // to full device path.
4061 if ((DevicePathType (TempDevicePath
) == MESSAGING_DEVICE_PATH
) &&
4062 ((DevicePathSubType (TempDevicePath
) == MSG_USB_CLASS_DP
) ||
4063 (DevicePathSubType (TempDevicePath
) == MSG_USB_WWID_DP
))) {
4067 LastDeviceNode
= TempDevicePath
;
4068 TempDevicePath
= NextDevicePathNode (TempDevicePath
);
4070 if ((DevicePathType (LastDeviceNode
) == MEDIA_DEVICE_PATH
) &&
4071 (DevicePathSubType (LastDeviceNode
) == MEDIA_FILEPATH_DP
)) {
4076 // Check if it's a valid boot option for internal FV application
4078 if (EfiGetNameGuidFromFwVolDevicePathNode ((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
*) LastDeviceNode
) != NULL
) {
4080 // If the boot option point to internal FV application, make sure it is valid
4082 TempDevicePath
= DevPath
;
4083 Status
= BdsLibUpdateFvFileDevicePath (
4085 EfiGetNameGuidFromFwVolDevicePathNode ((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
*) LastDeviceNode
)
4087 if (Status
== EFI_ALREADY_STARTED
) {
4090 if (Status
== EFI_SUCCESS
) {
4091 FreePool (TempDevicePath
);
4098 // If the boot option point to a blockIO device:
4099 // if it is a removable blockIo device, it is valid.
4100 // if it is a fixed blockIo device, check its description confliction.
4102 TempDevicePath
= DevPath
;
4103 Status
= gBS
->LocateDevicePath (&gEfiBlockIoProtocolGuid
, &TempDevicePath
, &Handle
);
4104 if (EFI_ERROR (Status
)) {
4106 // Device not present so see if we need to connect it
4108 Status
= BdsLibConnectDevicePath (DevPath
);
4109 if (!EFI_ERROR (Status
)) {
4111 // Try again to get the Block Io protocol after we did the connect
4113 TempDevicePath
= DevPath
;
4114 Status
= gBS
->LocateDevicePath (&gEfiBlockIoProtocolGuid
, &TempDevicePath
, &Handle
);
4118 if (!EFI_ERROR (Status
)) {
4119 Status
= gBS
->HandleProtocol (Handle
, &gEfiBlockIoProtocolGuid
, (VOID
**)&BlockIo
);
4120 if (!EFI_ERROR (Status
)) {
4123 // Test if it is ready to boot now
4125 if (BdsLibGetBootableHandle (DevPath
) != NULL
) {
4134 // 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,
4136 Status
= gBS
->LocateDevicePath (&gEfiSimpleFileSystemProtocolGuid
, &TempDevicePath
, &Handle
);
4137 if (!EFI_ERROR (Status
)) {
4140 // Test if it is ready to boot now
4142 if (BdsLibGetBootableHandle (DevPath
) != NULL
) {
4156 According to a file guild, check a Fv file device path is valid. If it is invalid,
4157 try to return the valid device path.
4158 FV address maybe changes for memory layout adjust from time to time, use this function
4159 could promise the Fv file device path is right.
4161 @param DevicePath on input, the Fv file device path need to check on
4162 output, the updated valid Fv file device path
4163 @param FileGuid the Fv file guild
4165 @retval EFI_INVALID_PARAMETER the input DevicePath or FileGuid is invalid
4167 @retval EFI_UNSUPPORTED the input DevicePath does not contain Fv file
4169 @retval EFI_ALREADY_STARTED the input DevicePath has pointed to Fv file, it is
4171 @retval EFI_SUCCESS has successfully updated the invalid DevicePath,
4172 and return the updated device path in DevicePath
4177 BdsLibUpdateFvFileDevicePath (
4178 IN OUT EFI_DEVICE_PATH_PROTOCOL
** DevicePath
,
4179 IN EFI_GUID
*FileGuid
4182 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
4183 EFI_DEVICE_PATH_PROTOCOL
*LastDeviceNode
;
4185 EFI_GUID
*GuidPoint
;
4187 UINTN FvHandleCount
;
4188 EFI_HANDLE
*FvHandleBuffer
;
4189 EFI_FV_FILETYPE Type
;
4191 EFI_FV_FILE_ATTRIBUTES Attributes
;
4192 UINT32 AuthenticationStatus
;
4194 EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
;
4195 EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
;
4196 MEDIA_FW_VOL_FILEPATH_DEVICE_PATH FvFileNode
;
4197 EFI_HANDLE FoundFvHandle
;
4198 EFI_DEVICE_PATH_PROTOCOL
*NewDevicePath
;
4200 if ((DevicePath
== NULL
) || (*DevicePath
== NULL
)) {
4201 return EFI_INVALID_PARAMETER
;
4203 if (FileGuid
== NULL
) {
4204 return EFI_INVALID_PARAMETER
;
4208 // Check whether the device path point to the default the input Fv file
4210 TempDevicePath
= *DevicePath
;
4211 LastDeviceNode
= TempDevicePath
;
4212 while (!IsDevicePathEnd (TempDevicePath
)) {
4213 LastDeviceNode
= TempDevicePath
;
4214 TempDevicePath
= NextDevicePathNode (TempDevicePath
);
4216 GuidPoint
= EfiGetNameGuidFromFwVolDevicePathNode (
4217 (MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
*) LastDeviceNode
4219 if (GuidPoint
== NULL
) {
4221 // if this option does not points to a Fv file, just return EFI_UNSUPPORTED
4223 return EFI_UNSUPPORTED
;
4225 if (!CompareGuid (GuidPoint
, FileGuid
)) {
4227 // If the Fv file is not the input file guid, just return EFI_UNSUPPORTED
4229 return EFI_UNSUPPORTED
;
4233 // Check whether the input Fv file device path is valid
4235 TempDevicePath
= *DevicePath
;
4236 FoundFvHandle
= NULL
;
4237 Status
= gBS
->LocateDevicePath (
4238 &gEfiFirmwareVolume2ProtocolGuid
,
4242 if (!EFI_ERROR (Status
)) {
4243 Status
= gBS
->HandleProtocol (
4245 &gEfiFirmwareVolume2ProtocolGuid
,
4248 if (!EFI_ERROR (Status
)) {
4250 // Set FV ReadFile Buffer as NULL, only need to check whether input Fv file exist there
4252 Status
= Fv
->ReadFile (
4259 &AuthenticationStatus
4261 if (!EFI_ERROR (Status
)) {
4262 return EFI_ALREADY_STARTED
;
4268 // Look for the input wanted FV file in current FV
4269 // First, try to look for in Bds own FV. Bds and input wanted FV file usually are in the same FV
4272 FoundFvHandle
= NULL
;
4273 Status
= gBS
->HandleProtocol (
4275 &gEfiLoadedImageProtocolGuid
,
4276 (VOID
**) &LoadedImage
4278 if (!EFI_ERROR (Status
)) {
4279 Status
= gBS
->HandleProtocol (
4280 LoadedImage
->DeviceHandle
,
4281 &gEfiFirmwareVolume2ProtocolGuid
,
4284 if (!EFI_ERROR (Status
)) {
4285 Status
= Fv
->ReadFile (
4292 &AuthenticationStatus
4294 if (!EFI_ERROR (Status
)) {
4296 FoundFvHandle
= LoadedImage
->DeviceHandle
;
4301 // Second, if fail to find, try to enumerate all FV
4304 FvHandleBuffer
= NULL
;
4305 gBS
->LocateHandleBuffer (
4307 &gEfiFirmwareVolume2ProtocolGuid
,
4312 for (Index
= 0; Index
< FvHandleCount
; Index
++) {
4313 gBS
->HandleProtocol (
4314 FvHandleBuffer
[Index
],
4315 &gEfiFirmwareVolume2ProtocolGuid
,
4319 Status
= Fv
->ReadFile (
4326 &AuthenticationStatus
4328 if (EFI_ERROR (Status
)) {
4330 // Skip if input Fv file not in the FV
4335 FoundFvHandle
= FvHandleBuffer
[Index
];
4339 if (FvHandleBuffer
!= NULL
) {
4340 FreePool (FvHandleBuffer
);
4346 // Build the shell device path
4348 NewDevicePath
= DevicePathFromHandle (FoundFvHandle
);
4349 EfiInitializeFwVolDevicepathNode (&FvFileNode
, FileGuid
);
4350 NewDevicePath
= AppendDevicePathNode (NewDevicePath
, (EFI_DEVICE_PATH_PROTOCOL
*) &FvFileNode
);
4351 ASSERT (NewDevicePath
!= NULL
);
4352 *DevicePath
= NewDevicePath
;
4355 return EFI_NOT_FOUND
;