2 BDS Lib functions which relate with create or process the boot option.
4 Copyright (c) 2004 - 2014, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
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 UnicodeStrToAsciiStr (BootDesc
, 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
)) {
868 OptionNumber
= BootOrder
[BootOrderSize
/ sizeof (UINT16
) - 1];
872 ASSERT (BbsIndex
== Index
);
875 Status
= gRT
->SetVariable (
877 &gEfiGlobalVariableGuid
,
878 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
882 if (BootOrder
!= NULL
) {
883 FreePool (BootOrder
);
890 Fill the device order buffer.
892 @param BbsTable The BBS table.
893 @param BbsType The BBS Type.
894 @param BbsCount The BBS Count.
895 @param Buf device order buffer.
897 @return The device order buffer.
902 IN BBS_TABLE
*BbsTable
,
910 for (Index
= 0; Index
< BbsCount
; Index
++) {
911 if (BbsTable
[Index
].BootPriority
== BBS_IGNORE_ENTRY
) {
915 if (BbsTable
[Index
].DeviceType
!= BbsType
) {
919 *Buf
= (UINT16
) (Index
& 0xFF);
927 Create the device order buffer.
929 @param BbsTable The BBS table.
930 @param BbsCount The BBS Count.
932 @retval EFI_SUCCES The buffer is created and the EFI variable named
933 VAR_LEGACY_DEV_ORDER and gEfiLegacyDevOrderVariableGuid is
935 @retval EFI_OUT_OF_RESOURCES Memmory or storage is not enough.
936 @retval EFI_DEVICE_ERROR Fail to add the device order into EFI variable fail
937 because of hardware error.
941 IN BBS_TABLE
*BbsTable
,
953 LEGACY_DEV_ORDER_ENTRY
*DevOrder
;
954 LEGACY_DEV_ORDER_ENTRY
*DevOrderPtr
;
963 HeaderSize
= sizeof (BBS_TYPE
) + sizeof (UINT16
);
965 Status
= EFI_SUCCESS
;
968 // Count all boot devices
970 for (Index
= 0; Index
< BbsCount
; Index
++) {
971 if (BbsTable
[Index
].BootPriority
== BBS_IGNORE_ENTRY
) {
975 switch (BbsTable
[Index
].DeviceType
) {
988 case BBS_EMBED_NETWORK
:
1001 TotalSize
+= (HeaderSize
+ sizeof (UINT16
) * FDCount
);
1002 TotalSize
+= (HeaderSize
+ sizeof (UINT16
) * HDCount
);
1003 TotalSize
+= (HeaderSize
+ sizeof (UINT16
) * CDCount
);
1004 TotalSize
+= (HeaderSize
+ sizeof (UINT16
) * NETCount
);
1005 TotalSize
+= (HeaderSize
+ sizeof (UINT16
) * BEVCount
);
1008 // Create buffer to hold all boot device order
1010 DevOrder
= AllocateZeroPool (TotalSize
);
1011 if (NULL
== DevOrder
) {
1012 return EFI_OUT_OF_RESOURCES
;
1014 DevOrderPtr
= DevOrder
;
1016 DevOrderPtr
->BbsType
= BBS_FLOPPY
;
1017 DevOrderPtr
->Length
= (UINT16
) (sizeof (DevOrderPtr
->Length
) + FDCount
* sizeof (UINT16
));
1018 DevOrderPtr
= (LEGACY_DEV_ORDER_ENTRY
*) BdsFillDevOrderBuf (BbsTable
, BBS_FLOPPY
, BbsCount
, DevOrderPtr
->Data
);
1020 DevOrderPtr
->BbsType
= BBS_HARDDISK
;
1021 DevOrderPtr
->Length
= (UINT16
) (sizeof (UINT16
) + HDCount
* sizeof (UINT16
));
1022 DevOrderPtr
= (LEGACY_DEV_ORDER_ENTRY
*) BdsFillDevOrderBuf (BbsTable
, BBS_HARDDISK
, BbsCount
, DevOrderPtr
->Data
);
1024 DevOrderPtr
->BbsType
= BBS_CDROM
;
1025 DevOrderPtr
->Length
= (UINT16
) (sizeof (UINT16
) + CDCount
* sizeof (UINT16
));
1026 DevOrderPtr
= (LEGACY_DEV_ORDER_ENTRY
*) BdsFillDevOrderBuf (BbsTable
, BBS_CDROM
, BbsCount
, DevOrderPtr
->Data
);
1028 DevOrderPtr
->BbsType
= BBS_EMBED_NETWORK
;
1029 DevOrderPtr
->Length
= (UINT16
) (sizeof (UINT16
) + NETCount
* sizeof (UINT16
));
1030 DevOrderPtr
= (LEGACY_DEV_ORDER_ENTRY
*) BdsFillDevOrderBuf (BbsTable
, BBS_EMBED_NETWORK
, BbsCount
, DevOrderPtr
->Data
);
1032 DevOrderPtr
->BbsType
= BBS_BEV_DEVICE
;
1033 DevOrderPtr
->Length
= (UINT16
) (sizeof (UINT16
) + BEVCount
* sizeof (UINT16
));
1034 DevOrderPtr
= (LEGACY_DEV_ORDER_ENTRY
*) BdsFillDevOrderBuf (BbsTable
, BBS_BEV_DEVICE
, BbsCount
, DevOrderPtr
->Data
);
1036 ASSERT (TotalSize
== (UINTN
) ((UINT8
*) DevOrderPtr
- (UINT8
*) DevOrder
));
1039 // Save device order for legacy boot device to variable.
1041 Status
= gRT
->SetVariable (
1042 VAR_LEGACY_DEV_ORDER
,
1043 &gEfiLegacyDevOrderVariableGuid
,
1044 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
1048 FreePool (DevOrder
);
1054 Add the legacy boot devices from BBS table into
1055 the legacy device boot order.
1057 @retval EFI_SUCCESS The boot devices are added successfully.
1058 @retval EFI_NOT_FOUND The legacy boot devices are not found.
1059 @retval EFI_OUT_OF_RESOURCES Memmory or storage is not enough.
1060 @retval EFI_DEVICE_ERROR Fail to add the legacy device boot order into EFI variable
1061 because of hardware error.
1065 BdsUpdateLegacyDevOrder (
1069 LEGACY_DEV_ORDER_ENTRY
*DevOrder
;
1070 LEGACY_DEV_ORDER_ENTRY
*NewDevOrder
;
1071 LEGACY_DEV_ORDER_ENTRY
*Ptr
;
1072 LEGACY_DEV_ORDER_ENTRY
*NewPtr
;
1074 EFI_LEGACY_BIOS_PROTOCOL
*LegacyBios
;
1078 HDD_INFO
*LocalHddInfo
;
1079 BBS_TABLE
*LocalBbsTable
;
1109 HeaderSize
= sizeof (BBS_TYPE
) + sizeof (UINT16
);
1117 Status
= gBS
->LocateProtocol (&gEfiLegacyBiosProtocolGuid
, NULL
, (VOID
**) &LegacyBios
);
1118 if (EFI_ERROR (Status
)) {
1122 Status
= LegacyBios
->GetBbsInfo (
1129 if (EFI_ERROR (Status
)) {
1133 DevOrder
= BdsLibGetVariableAndSize (
1134 VAR_LEGACY_DEV_ORDER
,
1135 &gEfiLegacyDevOrderVariableGuid
,
1138 if (NULL
== DevOrder
) {
1139 return BdsCreateDevOrder (LocalBbsTable
, BbsCount
);
1142 // First we figure out how many boot devices with same device type respectively
1144 for (Index
= 0; Index
< BbsCount
; Index
++) {
1145 if ((LocalBbsTable
[Index
].BootPriority
== BBS_IGNORE_ENTRY
) ||
1146 (LocalBbsTable
[Index
].BootPriority
== BBS_DO_NOT_BOOT_FROM
)
1151 switch (LocalBbsTable
[Index
].DeviceType
) {
1164 case BBS_EMBED_NETWORK
:
1168 case BBS_BEV_DEVICE
:
1177 TotalSize
+= (HeaderSize
+ FDCount
* sizeof (UINT16
));
1178 TotalSize
+= (HeaderSize
+ HDCount
* sizeof (UINT16
));
1179 TotalSize
+= (HeaderSize
+ CDCount
* sizeof (UINT16
));
1180 TotalSize
+= (HeaderSize
+ NETCount
* sizeof (UINT16
));
1181 TotalSize
+= (HeaderSize
+ BEVCount
* sizeof (UINT16
));
1183 NewDevOrder
= AllocateZeroPool (TotalSize
);
1184 if (NULL
== NewDevOrder
) {
1185 return EFI_OUT_OF_RESOURCES
;
1194 NewPtr
= NewDevOrder
;
1195 NewPtr
->BbsType
= Ptr
->BbsType
;
1196 NewPtr
->Length
= (UINT16
) (sizeof (UINT16
) + FDCount
* sizeof (UINT16
));
1197 for (Index
= 0; Index
< Ptr
->Length
/ sizeof (UINT16
) - 1; Index
++) {
1198 if (LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].BootPriority
== BBS_IGNORE_ENTRY
||
1199 LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].BootPriority
== BBS_DO_NOT_BOOT_FROM
||
1200 LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].DeviceType
!= BBS_FLOPPY
1205 NewPtr
->Data
[FDIndex
] = Ptr
->Data
[Index
];
1208 NewFDPtr
= NewPtr
->Data
;
1213 Ptr
= (LEGACY_DEV_ORDER_ENTRY
*) (&Ptr
->Data
[Ptr
->Length
/ sizeof (UINT16
) - 1]);
1214 NewPtr
= (LEGACY_DEV_ORDER_ENTRY
*) (&NewPtr
->Data
[NewPtr
->Length
/ sizeof (UINT16
) -1]);
1215 NewPtr
->BbsType
= Ptr
->BbsType
;
1216 NewPtr
->Length
= (UINT16
) (sizeof (UINT16
) + HDCount
* sizeof (UINT16
));
1217 for (Index
= 0; Index
< Ptr
->Length
/ sizeof (UINT16
) - 1; Index
++) {
1218 if (LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].BootPriority
== BBS_IGNORE_ENTRY
||
1219 LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].BootPriority
== BBS_DO_NOT_BOOT_FROM
||
1220 LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].BootPriority
== BBS_LOWEST_PRIORITY
||
1221 LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].DeviceType
!= BBS_HARDDISK
1226 NewPtr
->Data
[HDIndex
] = Ptr
->Data
[Index
];
1229 NewHDPtr
= NewPtr
->Data
;
1234 Ptr
= (LEGACY_DEV_ORDER_ENTRY
*) (&Ptr
->Data
[Ptr
->Length
/ sizeof (UINT16
) - 1]);
1235 NewPtr
= (LEGACY_DEV_ORDER_ENTRY
*) (&NewPtr
->Data
[NewPtr
->Length
/ sizeof (UINT16
) -1]);
1236 NewPtr
->BbsType
= Ptr
->BbsType
;
1237 NewPtr
->Length
= (UINT16
) (sizeof (UINT16
) + CDCount
* sizeof (UINT16
));
1238 for (Index
= 0; Index
< Ptr
->Length
/ sizeof (UINT16
) - 1; Index
++) {
1239 if (LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].BootPriority
== BBS_IGNORE_ENTRY
||
1240 LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].BootPriority
== BBS_DO_NOT_BOOT_FROM
||
1241 LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].BootPriority
== BBS_LOWEST_PRIORITY
||
1242 LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].DeviceType
!= BBS_CDROM
1247 NewPtr
->Data
[CDIndex
] = Ptr
->Data
[Index
];
1250 NewCDPtr
= NewPtr
->Data
;
1255 Ptr
= (LEGACY_DEV_ORDER_ENTRY
*) (&Ptr
->Data
[Ptr
->Length
/ sizeof (UINT16
) - 1]);
1256 NewPtr
= (LEGACY_DEV_ORDER_ENTRY
*) (&NewPtr
->Data
[NewPtr
->Length
/ sizeof (UINT16
) -1]);
1257 NewPtr
->BbsType
= Ptr
->BbsType
;
1258 NewPtr
->Length
= (UINT16
) (sizeof (UINT16
) + NETCount
* sizeof (UINT16
));
1259 for (Index
= 0; Index
< Ptr
->Length
/ sizeof (UINT16
) - 1; Index
++) {
1260 if (LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].BootPriority
== BBS_IGNORE_ENTRY
||
1261 LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].BootPriority
== BBS_DO_NOT_BOOT_FROM
||
1262 LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].BootPriority
== BBS_LOWEST_PRIORITY
||
1263 LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].DeviceType
!= BBS_EMBED_NETWORK
1268 NewPtr
->Data
[NETIndex
] = Ptr
->Data
[Index
];
1271 NewNETPtr
= NewPtr
->Data
;
1276 Ptr
= (LEGACY_DEV_ORDER_ENTRY
*) (&Ptr
->Data
[Ptr
->Length
/ sizeof (UINT16
) - 1]);
1277 NewPtr
= (LEGACY_DEV_ORDER_ENTRY
*) (&NewPtr
->Data
[NewPtr
->Length
/ sizeof (UINT16
) -1]);
1278 NewPtr
->BbsType
= Ptr
->BbsType
;
1279 NewPtr
->Length
= (UINT16
) (sizeof (UINT16
) + BEVCount
* sizeof (UINT16
));
1280 for (Index
= 0; Index
< Ptr
->Length
/ sizeof (UINT16
) - 1; Index
++) {
1281 if (LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].BootPriority
== BBS_IGNORE_ENTRY
||
1282 LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].BootPriority
== BBS_DO_NOT_BOOT_FROM
||
1283 LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].BootPriority
== BBS_LOWEST_PRIORITY
||
1284 LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].DeviceType
!= BBS_BEV_DEVICE
1289 NewPtr
->Data
[BEVIndex
] = Ptr
->Data
[Index
];
1292 NewBEVPtr
= NewPtr
->Data
;
1294 for (Index
= 0; Index
< BbsCount
; Index
++) {
1295 if ((LocalBbsTable
[Index
].BootPriority
== BBS_IGNORE_ENTRY
) ||
1296 (LocalBbsTable
[Index
].BootPriority
== BBS_DO_NOT_BOOT_FROM
)
1301 switch (LocalBbsTable
[Index
].DeviceType
) {
1304 NewDevPtr
= NewFDPtr
;
1309 NewDevPtr
= NewHDPtr
;
1314 NewDevPtr
= NewCDPtr
;
1317 case BBS_EMBED_NETWORK
:
1319 NewDevPtr
= NewNETPtr
;
1322 case BBS_BEV_DEVICE
:
1324 NewDevPtr
= NewBEVPtr
;
1332 // at this point we have copied those valid indexes to new buffer
1333 // and we should check if there is any new appeared boot device
1336 for (Index2
= 0; Index2
< *Idx
; Index2
++) {
1337 if ((NewDevPtr
[Index2
] & 0xFF) == (UINT16
) Index
) {
1342 if (Index2
== *Idx
) {
1344 // Index2 == *Idx means we didn't find Index
1345 // so Index is a new appeared device's index in BBS table
1346 // insert it before disabled indexes.
1348 for (Index2
= 0; Index2
< *Idx
; Index2
++) {
1349 if ((NewDevPtr
[Index2
] & 0xFF00) == 0xFF00) {
1353 CopyMem (&NewDevPtr
[Index2
+ 1], &NewDevPtr
[Index2
], (*Idx
- Index2
) * sizeof (UINT16
));
1354 NewDevPtr
[Index2
] = (UINT16
) (Index
& 0xFF);
1360 FreePool (DevOrder
);
1362 Status
= gRT
->SetVariable (
1363 VAR_LEGACY_DEV_ORDER
,
1364 &gEfiLegacyDevOrderVariableGuid
,
1365 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
1369 FreePool (NewDevOrder
);
1375 Set Boot Priority for specified device type.
1377 @param DeviceType The device type.
1378 @param BbsIndex The BBS index to set the highest priority. Ignore when -1.
1379 @param LocalBbsTable The BBS table.
1380 @param Priority The prority table.
1382 @retval EFI_SUCCESS The function completes successfully.
1383 @retval EFI_NOT_FOUND Failed to find device.
1384 @retval EFI_OUT_OF_RESOURCES Failed to get the efi variable of device order.
1388 BdsSetBootPriority4SameTypeDev (
1389 IN UINT16 DeviceType
,
1391 IN OUT BBS_TABLE
*LocalBbsTable
,
1392 IN OUT UINT16
*Priority
1395 LEGACY_DEV_ORDER_ENTRY
*DevOrder
;
1396 LEGACY_DEV_ORDER_ENTRY
*DevOrderPtr
;
1400 DevOrder
= BdsLibGetVariableAndSize (
1401 VAR_LEGACY_DEV_ORDER
,
1402 &gEfiLegacyDevOrderVariableGuid
,
1405 if (NULL
== DevOrder
) {
1406 return EFI_OUT_OF_RESOURCES
;
1409 DevOrderPtr
= DevOrder
;
1410 while ((UINT8
*) DevOrderPtr
< (UINT8
*) DevOrder
+ DevOrderSize
) {
1411 if (DevOrderPtr
->BbsType
== DeviceType
) {
1415 DevOrderPtr
= (LEGACY_DEV_ORDER_ENTRY
*) ((UINT8
*) DevOrderPtr
+ sizeof (BBS_TYPE
) + DevOrderPtr
->Length
);
1418 if ((UINT8
*) DevOrderPtr
>= (UINT8
*) DevOrder
+ DevOrderSize
) {
1419 FreePool (DevOrder
);
1420 return EFI_NOT_FOUND
;
1423 if (BbsIndex
!= (UINTN
) -1) {
1424 LocalBbsTable
[BbsIndex
].BootPriority
= *Priority
;
1428 // If the high byte of the DevIndex is 0xFF, it indicates that this device has been disabled.
1430 for (Index
= 0; Index
< DevOrderPtr
->Length
/ sizeof (UINT16
) - 1; Index
++) {
1431 if ((DevOrderPtr
->Data
[Index
] & 0xFF00) == 0xFF00) {
1433 // LocalBbsTable[DevIndex[Index] & 0xFF].BootPriority = BBS_DISABLED_ENTRY;
1435 } else if (DevOrderPtr
->Data
[Index
] != BbsIndex
) {
1436 LocalBbsTable
[DevOrderPtr
->Data
[Index
]].BootPriority
= *Priority
;
1441 FreePool (DevOrder
);
1446 Print the BBS Table.
1448 @param LocalBbsTable The BBS table.
1449 @param BbsCount The count of entry in BBS table.
1453 IN BBS_TABLE
*LocalBbsTable
,
1459 DEBUG ((DEBUG_ERROR
, "\n"));
1460 DEBUG ((DEBUG_ERROR
, " NO Prio bb/dd/ff cl/sc Type Stat segm:offs\n"));
1461 DEBUG ((DEBUG_ERROR
, "=============================================\n"));
1462 for (Idx
= 0; Idx
< BbsCount
; Idx
++) {
1463 if ((LocalBbsTable
[Idx
].BootPriority
== BBS_IGNORE_ENTRY
) ||
1464 (LocalBbsTable
[Idx
].BootPriority
== BBS_DO_NOT_BOOT_FROM
) ||
1465 (LocalBbsTable
[Idx
].BootPriority
== BBS_LOWEST_PRIORITY
)
1472 " %02x: %04x %02x/%02x/%02x %02x/%02x %04x %04x %04x:%04x\n",
1474 (UINTN
) LocalBbsTable
[Idx
].BootPriority
,
1475 (UINTN
) LocalBbsTable
[Idx
].Bus
,
1476 (UINTN
) LocalBbsTable
[Idx
].Device
,
1477 (UINTN
) LocalBbsTable
[Idx
].Function
,
1478 (UINTN
) LocalBbsTable
[Idx
].Class
,
1479 (UINTN
) LocalBbsTable
[Idx
].SubClass
,
1480 (UINTN
) LocalBbsTable
[Idx
].DeviceType
,
1481 (UINTN
) * (UINT16
*) &LocalBbsTable
[Idx
].StatusFlags
,
1482 (UINTN
) LocalBbsTable
[Idx
].BootHandlerSegment
,
1483 (UINTN
) LocalBbsTable
[Idx
].BootHandlerOffset
,
1484 (UINTN
) ((LocalBbsTable
[Idx
].MfgStringSegment
<< 4) + LocalBbsTable
[Idx
].MfgStringOffset
),
1485 (UINTN
) ((LocalBbsTable
[Idx
].DescStringSegment
<< 4) + LocalBbsTable
[Idx
].DescStringOffset
))
1489 DEBUG ((DEBUG_ERROR
, "\n"));
1493 Set the boot priority for BBS entries based on boot option entry and boot order.
1495 @param Entry The boot option is to be checked for refresh BBS table.
1497 @retval EFI_SUCCESS The boot priority for BBS entries is refreshed successfully.
1498 @retval EFI_NOT_FOUND BBS entries can't be found.
1499 @retval EFI_OUT_OF_RESOURCES Failed to get the legacy device boot order.
1503 BdsRefreshBbsTableForBoot (
1504 IN BDS_COMMON_OPTION
*Entry
1511 HDD_INFO
*LocalHddInfo
;
1512 BBS_TABLE
*LocalBbsTable
;
1514 EFI_LEGACY_BIOS_PROTOCOL
*LegacyBios
;
1518 UINTN BootOrderSize
;
1519 UINT8
*BootOptionVar
;
1520 UINTN BootOptionSize
;
1521 CHAR16 BootOption
[9];
1524 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
1526 UINTN DeviceTypeCount
;
1527 UINTN DeviceTypeIndex
;
1531 LocalHddInfo
= NULL
;
1532 LocalBbsTable
= NULL
;
1533 DevType
= BBS_UNKNOWN
;
1535 Status
= gBS
->LocateProtocol (&gEfiLegacyBiosProtocolGuid
, NULL
, (VOID
**) &LegacyBios
);
1536 if (EFI_ERROR (Status
)) {
1540 LegacyBios
->GetBbsInfo (
1548 // First, set all the present devices' boot priority to BBS_UNPRIORITIZED_ENTRY
1549 // We will set them according to the settings setup by user
1551 for (Index
= 0; Index
< BbsCount
; Index
++) {
1552 if (!((BBS_IGNORE_ENTRY
== LocalBbsTable
[Index
].BootPriority
) ||
1553 (BBS_DO_NOT_BOOT_FROM
== LocalBbsTable
[Index
].BootPriority
) ||
1554 (BBS_LOWEST_PRIORITY
== LocalBbsTable
[Index
].BootPriority
))) {
1555 LocalBbsTable
[Index
].BootPriority
= BBS_UNPRIORITIZED_ENTRY
;
1559 // boot priority always starts at 0
1562 if (Entry
->LoadOptionsSize
== sizeof (BBS_TABLE
) + sizeof (UINT16
)) {
1564 // If Entry stands for a legacy boot option, we prioritize the devices with the same type first.
1566 DevType
= ((BBS_TABLE
*) Entry
->LoadOptions
)->DeviceType
;
1567 BbsIndex
= *(UINT16
*) ((BBS_TABLE
*) Entry
->LoadOptions
+ 1);
1568 Status
= BdsSetBootPriority4SameTypeDev (
1574 if (EFI_ERROR (Status
)) {
1579 // we have to set the boot priority for other BBS entries with different device types
1581 BootOrder
= BdsLibGetVariableAndSize (
1583 &gEfiGlobalVariableGuid
,
1586 DeviceType
= AllocatePool (BootOrderSize
+ sizeof (UINT16
));
1587 ASSERT (DeviceType
!= NULL
);
1589 DeviceType
[0] = DevType
;
1590 DeviceTypeCount
= 1;
1591 for (Index
= 0; ((BootOrder
!= NULL
) && (Index
< BootOrderSize
/ sizeof (UINT16
))); Index
++) {
1592 UnicodeSPrint (BootOption
, sizeof (BootOption
), L
"Boot%04x", BootOrder
[Index
]);
1593 BootOptionVar
= BdsLibGetVariableAndSize (
1595 &gEfiGlobalVariableGuid
,
1598 if (NULL
== BootOptionVar
) {
1602 Ptr
= BootOptionVar
;
1604 Ptr
+= sizeof (UINT32
);
1605 DevPathLen
= *(UINT16
*) Ptr
;
1606 Ptr
+= sizeof (UINT16
);
1607 Ptr
+= StrSize ((UINT16
*) Ptr
);
1608 DevPath
= (EFI_DEVICE_PATH_PROTOCOL
*) Ptr
;
1609 if (BBS_DEVICE_PATH
!= DevPath
->Type
|| BBS_BBS_DP
!= DevPath
->SubType
) {
1610 FreePool (BootOptionVar
);
1615 DevType
= ((BBS_TABLE
*) Ptr
)->DeviceType
;
1616 for (DeviceTypeIndex
= 0; DeviceTypeIndex
< DeviceTypeCount
; DeviceTypeIndex
++) {
1617 if (DeviceType
[DeviceTypeIndex
] == DevType
) {
1621 if (DeviceTypeIndex
< DeviceTypeCount
) {
1623 // We don't want to process twice for a device type
1625 FreePool (BootOptionVar
);
1629 DeviceType
[DeviceTypeCount
] = DevType
;
1632 Status
= BdsSetBootPriority4SameTypeDev (
1638 FreePool (BootOptionVar
);
1639 if (EFI_ERROR (Status
)) {
1644 if (BootOrder
!= NULL
) {
1645 FreePool (BootOrder
);
1649 PrintBbsTable (LocalBbsTable
, BbsCount
);
1656 Boot the legacy system with the boot option
1658 @param Option The legacy boot option which have BBS device path
1660 @retval EFI_UNSUPPORTED There is no legacybios protocol, do not support
1662 @retval EFI_STATUS Return the status of LegacyBios->LegacyBoot ().
1666 BdsLibDoLegacyBoot (
1667 IN BDS_COMMON_OPTION
*Option
1671 EFI_LEGACY_BIOS_PROTOCOL
*LegacyBios
;
1672 EFI_EVENT LegacyBootEvent
;
1674 Status
= gBS
->LocateProtocol (&gEfiLegacyBiosProtocolGuid
, NULL
, (VOID
**) &LegacyBios
);
1675 if (EFI_ERROR (Status
)) {
1677 // If no LegacyBios protocol we do not support legacy boot
1679 return EFI_UNSUPPORTED
;
1682 // Notes: if we separate the int 19, then we don't need to refresh BBS
1684 BdsRefreshBbsTableForBoot (Option
);
1687 // Write boot to OS performance data for legacy boot.
1691 // Create an event to be signalled when Legacy Boot occurs to write performance data.
1693 Status
= EfiCreateEventLegacyBootEx(
1695 WriteBootToOsPerformanceData
,
1699 ASSERT_EFI_ERROR (Status
);
1702 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Legacy Boot: %S\n", Option
->Description
));
1703 return LegacyBios
->LegacyBoot (
1705 (BBS_BBS_DEVICE_PATH
*) Option
->DevicePath
,
1706 Option
->LoadOptionsSize
,
1712 Internal function to check if the input boot option is a valid EFI NV Boot####.
1714 @param OptionToCheck Boot option to be checked.
1716 @retval TRUE This boot option matches a valid EFI NV Boot####.
1717 @retval FALSE If not.
1721 IsBootOptionValidNVVarialbe (
1722 IN BDS_COMMON_OPTION
*OptionToCheck
1725 LIST_ENTRY TempList
;
1726 BDS_COMMON_OPTION
*BootOption
;
1728 CHAR16 OptionName
[20];
1732 InitializeListHead (&TempList
);
1733 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Boot%04x", OptionToCheck
->BootCurrent
);
1735 BootOption
= BdsLibVariableToOption (&TempList
, OptionName
);
1736 if (BootOption
== NULL
) {
1741 // If the Boot Option Number and Device Path matches, OptionToCheck matches a
1742 // valid EFI NV Boot####.
1744 if ((OptionToCheck
->BootCurrent
== BootOption
->BootCurrent
) &&
1745 (CompareMem (OptionToCheck
->DevicePath
, BootOption
->DevicePath
, GetDevicePathSize (OptionToCheck
->DevicePath
)) == 0))
1750 FreePool (BootOption
);
1756 Check whether a USB device match the specified USB Class device path. This
1757 function follows "Load Option Processing" behavior in UEFI specification.
1759 @param UsbIo USB I/O protocol associated with the USB device.
1760 @param UsbClass The USB Class device path to match.
1762 @retval TRUE The USB device match the USB Class device path.
1763 @retval FALSE The USB device does not match the USB Class device path.
1768 IN EFI_USB_IO_PROTOCOL
*UsbIo
,
1769 IN USB_CLASS_DEVICE_PATH
*UsbClass
1773 EFI_USB_DEVICE_DESCRIPTOR DevDesc
;
1774 EFI_USB_INTERFACE_DESCRIPTOR IfDesc
;
1776 UINT8 DeviceSubClass
;
1777 UINT8 DeviceProtocol
;
1779 if ((DevicePathType (UsbClass
) != MESSAGING_DEVICE_PATH
) ||
1780 (DevicePathSubType (UsbClass
) != MSG_USB_CLASS_DP
)){
1785 // Check Vendor Id and Product Id.
1787 Status
= UsbIo
->UsbGetDeviceDescriptor (UsbIo
, &DevDesc
);
1788 if (EFI_ERROR (Status
)) {
1792 if ((UsbClass
->VendorId
!= 0xffff) &&
1793 (UsbClass
->VendorId
!= DevDesc
.IdVendor
)) {
1797 if ((UsbClass
->ProductId
!= 0xffff) &&
1798 (UsbClass
->ProductId
!= DevDesc
.IdProduct
)) {
1802 DeviceClass
= DevDesc
.DeviceClass
;
1803 DeviceSubClass
= DevDesc
.DeviceSubClass
;
1804 DeviceProtocol
= DevDesc
.DeviceProtocol
;
1805 if (DeviceClass
== 0) {
1807 // If Class in Device Descriptor is set to 0, use the Class, SubClass and
1808 // Protocol in Interface Descriptor instead.
1810 Status
= UsbIo
->UsbGetInterfaceDescriptor (UsbIo
, &IfDesc
);
1811 if (EFI_ERROR (Status
)) {
1815 DeviceClass
= IfDesc
.InterfaceClass
;
1816 DeviceSubClass
= IfDesc
.InterfaceSubClass
;
1817 DeviceProtocol
= IfDesc
.InterfaceProtocol
;
1821 // Check Class, SubClass and Protocol.
1823 if ((UsbClass
->DeviceClass
!= 0xff) &&
1824 (UsbClass
->DeviceClass
!= DeviceClass
)) {
1828 if ((UsbClass
->DeviceSubClass
!= 0xff) &&
1829 (UsbClass
->DeviceSubClass
!= DeviceSubClass
)) {
1833 if ((UsbClass
->DeviceProtocol
!= 0xff) &&
1834 (UsbClass
->DeviceProtocol
!= DeviceProtocol
)) {
1842 Check whether a USB device match the specified USB WWID device path. This
1843 function follows "Load Option Processing" behavior in UEFI specification.
1845 @param UsbIo USB I/O protocol associated with the USB device.
1846 @param UsbWwid The USB WWID device path to match.
1848 @retval TRUE The USB device match the USB WWID device path.
1849 @retval FALSE The USB device does not match the USB WWID device path.
1854 IN EFI_USB_IO_PROTOCOL
*UsbIo
,
1855 IN USB_WWID_DEVICE_PATH
*UsbWwid
1859 EFI_USB_DEVICE_DESCRIPTOR DevDesc
;
1860 EFI_USB_INTERFACE_DESCRIPTOR IfDesc
;
1861 UINT16
*LangIdTable
;
1866 CHAR16
*SerialNumberStr
;
1869 if ((DevicePathType (UsbWwid
) != MESSAGING_DEVICE_PATH
) ||
1870 (DevicePathSubType (UsbWwid
) != MSG_USB_WWID_DP
)){
1875 // Check Vendor Id and Product Id.
1877 Status
= UsbIo
->UsbGetDeviceDescriptor (UsbIo
, &DevDesc
);
1878 if (EFI_ERROR (Status
)) {
1881 if ((DevDesc
.IdVendor
!= UsbWwid
->VendorId
) ||
1882 (DevDesc
.IdProduct
!= UsbWwid
->ProductId
)) {
1887 // Check Interface Number.
1889 Status
= UsbIo
->UsbGetInterfaceDescriptor (UsbIo
, &IfDesc
);
1890 if (EFI_ERROR (Status
)) {
1893 if (IfDesc
.InterfaceNumber
!= UsbWwid
->InterfaceNumber
) {
1898 // Check Serial Number.
1900 if (DevDesc
.StrSerialNumber
== 0) {
1905 // Get all supported languages.
1909 Status
= UsbIo
->UsbGetSupportedLanguages (UsbIo
, &LangIdTable
, &TableSize
);
1910 if (EFI_ERROR (Status
) || (TableSize
== 0) || (LangIdTable
== NULL
)) {
1915 // Serial number in USB WWID device path is the last 64-or-less UTF-16 characters.
1917 CompareStr
= (CHAR16
*) (UINTN
) (UsbWwid
+ 1);
1918 CompareLen
= (DevicePathNodeLength (UsbWwid
) - sizeof (USB_WWID_DEVICE_PATH
)) / sizeof (CHAR16
);
1919 if (CompareStr
[CompareLen
- 1] == L
'\0') {
1924 // Compare serial number in each supported language.
1926 for (Index
= 0; Index
< TableSize
/ sizeof (UINT16
); Index
++) {
1927 SerialNumberStr
= NULL
;
1928 Status
= UsbIo
->UsbGetStringDescriptor (
1931 DevDesc
.StrSerialNumber
,
1934 if (EFI_ERROR (Status
) || (SerialNumberStr
== NULL
)) {
1938 Length
= StrLen (SerialNumberStr
);
1939 if ((Length
>= CompareLen
) &&
1940 (CompareMem (SerialNumberStr
+ Length
- CompareLen
, CompareStr
, CompareLen
* sizeof (CHAR16
)) == 0)) {
1941 FreePool (SerialNumberStr
);
1945 FreePool (SerialNumberStr
);
1952 Find a USB device path which match the specified short-form device path start
1953 with USB Class or USB WWID device path and load the boot file then return the
1954 image handle. If ParentDevicePath is NULL, this function will search in all USB
1955 devices of the platform. If ParentDevicePath is not NULL,this function will only
1956 search in its child devices.
1958 @param ParentDevicePath The device path of the parent.
1959 @param ShortFormDevicePath The USB Class or USB WWID device path to match.
1961 @return The image Handle if find load file from specified short-form device path
1962 or NULL if not found.
1967 IN EFI_DEVICE_PATH_PROTOCOL
*ParentDevicePath
,
1968 IN EFI_DEVICE_PATH_PROTOCOL
*ShortFormDevicePath
1972 UINTN UsbIoHandleCount
;
1973 EFI_HANDLE
*UsbIoHandleBuffer
;
1974 EFI_DEVICE_PATH_PROTOCOL
*UsbIoDevicePath
;
1975 EFI_USB_IO_PROTOCOL
*UsbIo
;
1979 EFI_HANDLE ImageHandle
;
1981 EFI_DEVICE_PATH_PROTOCOL
*FullDevicePath
;
1982 EFI_DEVICE_PATH_PROTOCOL
*NextDevicePath
;
1984 FullDevicePath
= NULL
;
1988 // Get all UsbIo Handles.
1990 UsbIoHandleCount
= 0;
1991 UsbIoHandleBuffer
= NULL
;
1992 Status
= gBS
->LocateHandleBuffer (
1994 &gEfiUsbIoProtocolGuid
,
1999 if (EFI_ERROR (Status
) || (UsbIoHandleCount
== 0) || (UsbIoHandleBuffer
== NULL
)) {
2003 ParentSize
= (ParentDevicePath
== NULL
) ? 0 : GetDevicePathSize (ParentDevicePath
);
2004 for (Index
= 0; Index
< UsbIoHandleCount
; Index
++) {
2006 // Get the Usb IO interface.
2008 Status
= gBS
->HandleProtocol(
2009 UsbIoHandleBuffer
[Index
],
2010 &gEfiUsbIoProtocolGuid
,
2013 if (EFI_ERROR (Status
)) {
2017 UsbIoDevicePath
= DevicePathFromHandle (UsbIoHandleBuffer
[Index
]);
2018 if (UsbIoDevicePath
== NULL
) {
2022 if (ParentDevicePath
!= NULL
) {
2024 // Compare starting part of UsbIoHandle's device path with ParentDevicePath.
2026 Size
= GetDevicePathSize (UsbIoDevicePath
);
2027 if ((Size
< ParentSize
) ||
2028 (CompareMem (UsbIoDevicePath
, ParentDevicePath
, ParentSize
- END_DEVICE_PATH_LENGTH
) != 0)) {
2033 if (BdsMatchUsbClass (UsbIo
, (USB_CLASS_DEVICE_PATH
*) ShortFormDevicePath
) ||
2034 BdsMatchUsbWwid (UsbIo
, (USB_WWID_DEVICE_PATH
*) ShortFormDevicePath
)) {
2036 // Try to find if there is the boot file in this DevicePath
2038 NextDevicePath
= NextDevicePathNode (ShortFormDevicePath
);
2039 if (!IsDevicePathEnd (NextDevicePath
)) {
2040 FullDevicePath
= AppendDevicePath (UsbIoDevicePath
, NextDevicePath
);
2042 // Connect the full device path, so that Simple File System protocol
2043 // could be installed for this USB device.
2045 BdsLibConnectDevicePath (FullDevicePath
);
2046 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, PcdGet32 (PcdProgressCodeOsLoaderLoad
));
2047 Status
= gBS
->LoadImage (
2055 FreePool (FullDevicePath
);
2057 FullDevicePath
= UsbIoDevicePath
;
2058 Status
= EFI_NOT_FOUND
;
2062 // If we didn't find an image directly, we need to try as if it is a removable device boot option
2063 // and load the image according to the default boot behavior for removable device.
2065 if (EFI_ERROR (Status
)) {
2067 // check if there is a bootable removable media could be found in this device path ,
2068 // and get the bootable media handle
2070 Handle
= BdsLibGetBootableHandle(UsbIoDevicePath
);
2071 if (Handle
== NULL
) {
2075 // Load the default boot file \EFI\BOOT\boot{machinename}.EFI from removable Media
2076 // machinename is ia32, ia64, x64, ...
2078 FullDevicePath
= FileDevicePath (Handle
, EFI_REMOVABLE_MEDIA_FILE_NAME
);
2079 if (FullDevicePath
!= NULL
) {
2080 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, PcdGet32 (PcdProgressCodeOsLoaderLoad
));
2081 Status
= gBS
->LoadImage (
2089 if (EFI_ERROR (Status
)) {
2091 // The DevicePath failed, and it's not a valid
2092 // removable media device.
2104 FreePool (UsbIoHandleBuffer
);
2109 Expand USB Class or USB WWID device path node to be full device path of a USB
2110 device in platform then load the boot file on this full device path and return the
2113 This function support following 4 cases:
2114 1) Boot Option device path starts with a USB Class or USB WWID device path,
2115 and there is no Media FilePath device path in the end.
2116 In this case, it will follow Removable Media Boot Behavior.
2117 2) Boot Option device path starts with a USB Class or USB WWID device path,
2118 and ended with Media FilePath device path.
2119 3) Boot Option device path starts with a full device path to a USB Host Controller,
2120 contains a USB Class or USB WWID device path node, while not ended with Media
2121 FilePath device path. In this case, it will follow Removable Media Boot Behavior.
2122 4) 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, and ended with Media
2124 FilePath device path.
2126 @param DevicePath The Boot Option device path.
2128 @return The image handle of boot file, or NULL if there is no boot file found in
2129 the specified USB Class or USB WWID device path.
2133 BdsExpandUsbShortFormDevicePath (
2134 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
2137 EFI_HANDLE
*ImageHandle
;
2138 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
2139 EFI_DEVICE_PATH_PROTOCOL
*ShortFormDevicePath
;
2142 // Search for USB Class or USB WWID device path node.
2144 ShortFormDevicePath
= NULL
;
2146 TempDevicePath
= DevicePath
;
2147 while (!IsDevicePathEnd (TempDevicePath
)) {
2148 if ((DevicePathType (TempDevicePath
) == MESSAGING_DEVICE_PATH
) &&
2149 ((DevicePathSubType (TempDevicePath
) == MSG_USB_CLASS_DP
) ||
2150 (DevicePathSubType (TempDevicePath
) == MSG_USB_WWID_DP
))) {
2151 ShortFormDevicePath
= TempDevicePath
;
2154 TempDevicePath
= NextDevicePathNode (TempDevicePath
);
2157 if (ShortFormDevicePath
== NULL
) {
2159 // No USB Class or USB WWID device path node found, do nothing.
2164 if (ShortFormDevicePath
== DevicePath
) {
2166 // Boot Option device path starts with USB Class or USB WWID device path.
2168 ImageHandle
= BdsFindUsbDevice (NULL
, ShortFormDevicePath
);
2169 if (ImageHandle
== NULL
) {
2171 // Failed to find a match in existing devices, connect the short form USB
2172 // device path and try again.
2174 BdsLibConnectUsbDevByShortFormDP (0xff, ShortFormDevicePath
);
2175 ImageHandle
= BdsFindUsbDevice (NULL
, ShortFormDevicePath
);
2179 // Boot Option device path contains USB Class or USB WWID device path node.
2183 // Prepare the parent device path for search.
2185 TempDevicePath
= DuplicateDevicePath (DevicePath
);
2186 ASSERT (TempDevicePath
!= NULL
);
2187 SetDevicePathEndNode (((UINT8
*) TempDevicePath
) + ((UINTN
) ShortFormDevicePath
- (UINTN
) DevicePath
));
2190 // The USB Host Controller device path is already in Boot Option device path
2191 // and USB Bus driver already support RemainingDevicePath starts with USB
2192 // Class or USB WWID device path, so just search in existing USB devices and
2193 // doesn't perform ConnectController here.
2195 ImageHandle
= BdsFindUsbDevice (TempDevicePath
, ShortFormDevicePath
);
2196 FreePool (TempDevicePath
);
2203 Process the boot option follow the UEFI specification and
2204 special treat the legacy boot option with BBS_DEVICE_PATH.
2206 @param Option The boot option need to be processed
2207 @param DevicePath The device path which describe where to load the
2208 boot image or the legacy BBS device path to boot
2210 @param ExitDataSize The size of exit data.
2211 @param ExitData Data returned when Boot image failed.
2213 @retval EFI_SUCCESS Boot from the input boot option successfully.
2214 @retval EFI_NOT_FOUND If the Device Path is not found in the system
2219 BdsLibBootViaBootOption (
2220 IN BDS_COMMON_OPTION
*Option
,
2221 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
2222 OUT UINTN
*ExitDataSize
,
2223 OUT CHAR16
**ExitData OPTIONAL
2227 EFI_STATUS StatusLogo
;
2229 EFI_HANDLE ImageHandle
;
2230 EFI_DEVICE_PATH_PROTOCOL
*FilePath
;
2231 EFI_LOADED_IMAGE_PROTOCOL
*ImageInfo
;
2232 EFI_DEVICE_PATH_PROTOCOL
*WorkingDevicePath
;
2233 EFI_ACPI_S3_SAVE_PROTOCOL
*AcpiS3Save
;
2234 LIST_ENTRY TempBootLists
;
2235 EFI_BOOT_LOGO_PROTOCOL
*BootLogo
;
2241 // Notes: this code can be remove after the s3 script table
2242 // hook on the event EVT_SIGNAL_READY_TO_BOOT or
2243 // EVT_SIGNAL_LEGACY_BOOT
2245 Status
= gBS
->LocateProtocol (&gEfiAcpiS3SaveProtocolGuid
, NULL
, (VOID
**) &AcpiS3Save
);
2246 if (!EFI_ERROR (Status
)) {
2247 AcpiS3Save
->S3Save (AcpiS3Save
, NULL
);
2250 // If it's Device Path that starts with a hard drive path, append it with the front part to compose a
2253 WorkingDevicePath
= NULL
;
2254 if ((DevicePathType (DevicePath
) == MEDIA_DEVICE_PATH
) &&
2255 (DevicePathSubType (DevicePath
) == MEDIA_HARDDRIVE_DP
)) {
2256 WorkingDevicePath
= BdsExpandPartitionPartialDevicePathToFull (
2257 (HARDDRIVE_DEVICE_PATH
*)DevicePath
2259 if (WorkingDevicePath
!= NULL
) {
2260 DevicePath
= WorkingDevicePath
;
2267 if (IsBootOptionValidNVVarialbe (Option
)) {
2269 // For a temporary boot (i.e. a boot by selected a EFI Shell using "Boot From File"), Boot Current is actually not valid.
2270 // In this case, "BootCurrent" is not created.
2271 // Only create the BootCurrent variable when it points to a valid Boot#### variable.
2273 SetVariableAndReportStatusCodeOnError (
2275 &gEfiGlobalVariableGuid
,
2276 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
2278 &Option
->BootCurrent
2283 // Report Status Code to indicate ReadyToBoot event will be signalled
2285 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_SW_DXE_BS_PC_READY_TO_BOOT_EVENT
));
2288 // Signal the EVT_SIGNAL_READY_TO_BOOT event
2290 EfiSignalEventReadyToBoot();
2293 // Expand USB Class or USB WWID device path node to be full device path of a USB
2294 // device in platform then load the boot file on this full device path and get the
2297 ImageHandle
= BdsExpandUsbShortFormDevicePath (DevicePath
);
2300 // Adjust the different type memory page number just before booting
2301 // and save the updated info into the variable for next boot to use
2303 BdsSetMemoryTypeInformationVariable ();
2306 // By expanding the USB Class or WWID device path, the ImageHandle has returnned.
2307 // Here get the ImageHandle for the non USB class or WWID device path.
2309 if (ImageHandle
== NULL
) {
2310 ASSERT (Option
->DevicePath
!= NULL
);
2311 if ((DevicePathType (Option
->DevicePath
) == BBS_DEVICE_PATH
) &&
2312 (DevicePathSubType (Option
->DevicePath
) == BBS_BBS_DP
)
2315 // Check to see if we should legacy BOOT. If yes then do the legacy boot
2317 return BdsLibDoLegacyBoot (Option
);
2321 // If the boot option point to Internal FV shell, make sure it is valid
2323 Status
= BdsLibUpdateFvFileDevicePath (&DevicePath
, PcdGetPtr(PcdShellFile
));
2324 if (!EFI_ERROR(Status
)) {
2325 if (Option
->DevicePath
!= NULL
) {
2326 FreePool(Option
->DevicePath
);
2328 Option
->DevicePath
= AllocateZeroPool (GetDevicePathSize (DevicePath
));
2329 ASSERT(Option
->DevicePath
!= NULL
);
2330 CopyMem (Option
->DevicePath
, DevicePath
, GetDevicePathSize (DevicePath
));
2332 // Update the shell boot option
2334 InitializeListHead (&TempBootLists
);
2335 BdsLibRegisterNewOption (&TempBootLists
, DevicePath
, L
"EFI Internal Shell", L
"BootOrder");
2338 // free the temporary device path created by BdsLibUpdateFvFileDevicePath()
2340 FreePool (DevicePath
);
2341 DevicePath
= Option
->DevicePath
;
2346 if (Option
->Description
== NULL
) {
2347 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Booting from unknown device path\n"));
2349 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Booting %S\n", Option
->Description
));
2355 // Report status code for OS Loader LoadImage.
2357 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, PcdGet32 (PcdProgressCodeOsLoaderLoad
));
2358 Status
= gBS
->LoadImage (
2368 // If we didn't find an image directly, we need to try as if it is a removable device boot option
2369 // and load the image according to the default boot behavior for removable device.
2371 if (EFI_ERROR (Status
)) {
2373 // check if there is a bootable removable media could be found in this device path ,
2374 // and get the bootable media handle
2376 Handle
= BdsLibGetBootableHandle(DevicePath
);
2377 if (Handle
!= NULL
) {
2379 // Load the default boot file \EFI\BOOT\boot{machinename}.EFI from removable Media
2380 // machinename is ia32, ia64, x64, ...
2382 FilePath
= FileDevicePath (Handle
, EFI_REMOVABLE_MEDIA_FILE_NAME
);
2383 if (FilePath
!= NULL
) {
2384 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, PcdGet32 (PcdProgressCodeOsLoaderLoad
));
2385 Status
= gBS
->LoadImage (
2398 // Provide the image with it's load options
2400 if ((ImageHandle
== NULL
) || (EFI_ERROR(Status
))) {
2402 // Report Status Code to indicate that the failure to load boot option
2404 REPORT_STATUS_CODE (
2405 EFI_ERROR_CODE
| EFI_ERROR_MINOR
,
2406 (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_SW_DXE_BS_EC_BOOT_OPTION_LOAD_ERROR
)
2411 Status
= gBS
->HandleProtocol (ImageHandle
, &gEfiLoadedImageProtocolGuid
, (VOID
**) &ImageInfo
);
2412 ASSERT_EFI_ERROR (Status
);
2414 if (Option
->LoadOptionsSize
!= 0) {
2415 ImageInfo
->LoadOptionsSize
= Option
->LoadOptionsSize
;
2416 ImageInfo
->LoadOptions
= Option
->LoadOptions
;
2420 // Clean to NULL because the image is loaded directly from the firmwares boot manager.
2422 ImageInfo
->ParentHandle
= NULL
;
2425 // Before calling the image, enable the Watchdog Timer for
2426 // the 5 Minute period
2428 gBS
->SetWatchdogTimer (5 * 60, 0x0000, 0x00, NULL
);
2431 // Write boot to OS performance data for UEFI boot
2434 WriteBootToOsPerformanceData (NULL
, NULL
);
2438 // Report status code for OS Loader StartImage.
2440 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, PcdGet32 (PcdProgressCodeOsLoaderStart
));
2442 Status
= gBS
->StartImage (ImageHandle
, ExitDataSize
, ExitData
);
2443 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Image Return Status = %r\n", Status
));
2444 if (EFI_ERROR (Status
)) {
2446 // Report Status Code to indicate that boot failure
2448 REPORT_STATUS_CODE (
2449 EFI_ERROR_CODE
| EFI_ERROR_MINOR
,
2450 (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_SW_DXE_BS_EC_BOOT_OPTION_FAILED
)
2455 // Clear the Watchdog Timer after the image returns
2457 gBS
->SetWatchdogTimer (0x0000, 0x0000, 0x0000, NULL
);
2461 // Set Logo status invalid after trying one boot option
2464 StatusLogo
= gBS
->LocateProtocol (&gEfiBootLogoProtocolGuid
, NULL
, (VOID
**) &BootLogo
);
2465 if (!EFI_ERROR (StatusLogo
) && (BootLogo
!= NULL
)) {
2466 BootLogo
->SetBootLogo (BootLogo
, NULL
, 0, 0, 0, 0);
2470 // Clear Boot Current
2471 // Deleting variable with current implementation shouldn't fail.
2475 &gEfiGlobalVariableGuid
,
2476 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
2486 Expand a device path that starts with a hard drive media device path node to be a
2487 full device path that includes the full hardware path to the device. We need
2488 to do this so it can be booted. As an optimization the front match (the part point
2489 to the partition node. E.g. ACPI() /PCI()/ATA()/Partition() ) is saved in a variable
2490 so a connect all is not required on every boot. All successful history device path
2491 which point to partition node (the front part) will be saved.
2493 @param HardDriveDevicePath EFI Device Path to boot, if it starts with a hard
2494 drive media device path.
2495 @return A Pointer to the full device path or NULL if a valid Hard Drive devic path
2499 EFI_DEVICE_PATH_PROTOCOL
*
2501 BdsExpandPartitionPartialDevicePathToFull (
2502 IN HARDDRIVE_DEVICE_PATH
*HardDriveDevicePath
2506 UINTN BlockIoHandleCount
;
2507 EFI_HANDLE
*BlockIoBuffer
;
2508 EFI_DEVICE_PATH_PROTOCOL
*FullDevicePath
;
2509 EFI_DEVICE_PATH_PROTOCOL
*BlockIoDevicePath
;
2510 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
2513 EFI_DEVICE_PATH_PROTOCOL
*CachedDevicePath
;
2514 EFI_DEVICE_PATH_PROTOCOL
*TempNewDevicePath
;
2515 UINTN CachedDevicePathSize
;
2516 BOOLEAN DeviceExist
;
2518 EFI_DEVICE_PATH_PROTOCOL
*Instance
;
2521 FullDevicePath
= NULL
;
2523 // Check if there is prestore HD_BOOT_DEVICE_PATH_VARIABLE_NAME variable.
2524 // If exist, search the front path which point to partition node in the variable instants.
2525 // If fail to find or HD_BOOT_DEVICE_PATH_VARIABLE_NAME not exist, reconnect all and search in all system
2528 HD_BOOT_DEVICE_PATH_VARIABLE_NAME
,
2529 &gHdBootDevicePathVariablGuid
,
2530 (VOID
**) &CachedDevicePath
,
2531 &CachedDevicePathSize
2535 // Delete the invalid HD_BOOT_DEVICE_PATH_VARIABLE_NAME variable.
2537 if ((CachedDevicePath
!= NULL
) && !IsDevicePathValid (CachedDevicePath
, CachedDevicePathSize
)) {
2538 FreePool (CachedDevicePath
);
2539 CachedDevicePath
= NULL
;
2540 Status
= gRT
->SetVariable (
2541 HD_BOOT_DEVICE_PATH_VARIABLE_NAME
,
2542 &gHdBootDevicePathVariablGuid
,
2547 ASSERT_EFI_ERROR (Status
);
2550 if (CachedDevicePath
!= NULL
) {
2551 TempNewDevicePath
= CachedDevicePath
;
2552 DeviceExist
= FALSE
;
2556 // Check every instance of the variable
2557 // First, check whether the instance contain the partition node, which is needed for distinguishing multi
2558 // partial partition boot option. Second, check whether the instance could be connected.
2560 Instance
= GetNextDevicePathInstance (&TempNewDevicePath
, &Size
);
2561 if (MatchPartitionDevicePathNode (Instance
, HardDriveDevicePath
)) {
2563 // Connect the device path instance, the device path point to hard drive media device path node
2564 // e.g. ACPI() /PCI()/ATA()/Partition()
2566 Status
= BdsLibConnectDevicePath (Instance
);
2567 if (!EFI_ERROR (Status
)) {
2573 // Come here means the first instance is not matched
2577 } while (TempNewDevicePath
!= NULL
);
2581 // Find the matched device path.
2582 // Append the file path information from the boot option and return the fully expanded device path.
2584 DevicePath
= NextDevicePathNode ((EFI_DEVICE_PATH_PROTOCOL
*) HardDriveDevicePath
);
2585 FullDevicePath
= AppendDevicePath (Instance
, DevicePath
);
2588 // Adjust the HD_BOOT_DEVICE_PATH_VARIABLE_NAME instances sequence if the matched one is not first one.
2592 // First delete the matched instance.
2594 TempNewDevicePath
= CachedDevicePath
;
2595 CachedDevicePath
= BdsLibDelPartMatchInstance (CachedDevicePath
, Instance
);
2596 FreePool (TempNewDevicePath
);
2599 // Second, append the remaining path after the matched instance
2601 TempNewDevicePath
= CachedDevicePath
;
2602 CachedDevicePath
= AppendDevicePathInstance (Instance
, CachedDevicePath
);
2603 FreePool (TempNewDevicePath
);
2605 // Save the matching Device Path so we don't need to do a connect all next time
2606 // Failure to set the variable only impacts the performance when next time expanding the short-form device path.
2608 Status
= gRT
->SetVariable (
2609 HD_BOOT_DEVICE_PATH_VARIABLE_NAME
,
2610 &gHdBootDevicePathVariablGuid
,
2611 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
2612 GetDevicePathSize (CachedDevicePath
),
2617 FreePool (Instance
);
2618 FreePool (CachedDevicePath
);
2619 return FullDevicePath
;
2624 // If we get here we fail to find or HD_BOOT_DEVICE_PATH_VARIABLE_NAME not exist, and now we need
2625 // to search all devices in the system for a matched partition
2627 BdsLibConnectAllDriversToAllControllers ();
2628 Status
= gBS
->LocateHandleBuffer (ByProtocol
, &gEfiBlockIoProtocolGuid
, NULL
, &BlockIoHandleCount
, &BlockIoBuffer
);
2629 if (EFI_ERROR (Status
) || BlockIoHandleCount
== 0 || BlockIoBuffer
== NULL
) {
2631 // If there was an error or there are no device handles that support
2632 // the BLOCK_IO Protocol, then return.
2637 // Loop through all the device handles that support the BLOCK_IO Protocol
2639 for (Index
= 0; Index
< BlockIoHandleCount
; Index
++) {
2641 Status
= gBS
->HandleProtocol (BlockIoBuffer
[Index
], &gEfiDevicePathProtocolGuid
, (VOID
*) &BlockIoDevicePath
);
2642 if (EFI_ERROR (Status
) || BlockIoDevicePath
== NULL
) {
2646 if (MatchPartitionDevicePathNode (BlockIoDevicePath
, HardDriveDevicePath
)) {
2648 // Find the matched partition device path
2650 DevicePath
= NextDevicePathNode ((EFI_DEVICE_PATH_PROTOCOL
*) HardDriveDevicePath
);
2651 FullDevicePath
= AppendDevicePath (BlockIoDevicePath
, DevicePath
);
2654 // Save the matched partition device path in HD_BOOT_DEVICE_PATH_VARIABLE_NAME variable
2656 if (CachedDevicePath
!= NULL
) {
2658 // Save the matched partition device path as first instance of HD_BOOT_DEVICE_PATH_VARIABLE_NAME variable
2660 if (BdsLibMatchDevicePaths (CachedDevicePath
, BlockIoDevicePath
)) {
2661 TempNewDevicePath
= CachedDevicePath
;
2662 CachedDevicePath
= BdsLibDelPartMatchInstance (CachedDevicePath
, BlockIoDevicePath
);
2663 FreePool(TempNewDevicePath
);
2666 if (CachedDevicePath
!= NULL
) {
2667 TempNewDevicePath
= CachedDevicePath
;
2668 CachedDevicePath
= AppendDevicePathInstance (BlockIoDevicePath
, CachedDevicePath
);
2669 FreePool(TempNewDevicePath
);
2671 CachedDevicePath
= DuplicateDevicePath (BlockIoDevicePath
);
2675 // Here limit the device path instance number to 12, which is max number for a system support 3 IDE controller
2676 // If the user try to boot many OS in different HDs or partitions, in theory,
2677 // the HD_BOOT_DEVICE_PATH_VARIABLE_NAME variable maybe become larger and larger.
2680 ASSERT (CachedDevicePath
!= NULL
);
2681 TempNewDevicePath
= CachedDevicePath
;
2682 while (!IsDevicePathEnd (TempNewDevicePath
)) {
2683 TempNewDevicePath
= NextDevicePathNode (TempNewDevicePath
);
2685 // Parse one instance
2687 while (!IsDevicePathEndType (TempNewDevicePath
)) {
2688 TempNewDevicePath
= NextDevicePathNode (TempNewDevicePath
);
2692 // If the CachedDevicePath variable contain too much instance, only remain 12 instances.
2694 if (InstanceNum
>= 12) {
2695 SetDevicePathEndNode (TempNewDevicePath
);
2700 CachedDevicePath
= DuplicateDevicePath (BlockIoDevicePath
);
2704 // Save the matching Device Path so we don't need to do a connect all next time
2705 // Failure to set the variable only impacts the performance when next time expanding the short-form device path.
2707 Status
= gRT
->SetVariable (
2708 HD_BOOT_DEVICE_PATH_VARIABLE_NAME
,
2709 &gHdBootDevicePathVariablGuid
,
2710 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
2711 GetDevicePathSize (CachedDevicePath
),
2719 if (CachedDevicePath
!= NULL
) {
2720 FreePool (CachedDevicePath
);
2722 if (BlockIoBuffer
!= NULL
) {
2723 FreePool (BlockIoBuffer
);
2725 return FullDevicePath
;
2729 Check whether there is a instance in BlockIoDevicePath, which contain multi device path
2730 instances, has the same partition node with HardDriveDevicePath device path
2732 @param BlockIoDevicePath Multi device path instances which need to check
2733 @param HardDriveDevicePath A device path which starts with a hard drive media
2736 @retval TRUE There is a matched device path instance.
2737 @retval FALSE There is no matched device path instance.
2742 MatchPartitionDevicePathNode (
2743 IN EFI_DEVICE_PATH_PROTOCOL
*BlockIoDevicePath
,
2744 IN HARDDRIVE_DEVICE_PATH
*HardDriveDevicePath
2747 HARDDRIVE_DEVICE_PATH
*TmpHdPath
;
2748 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
2750 EFI_DEVICE_PATH_PROTOCOL
*BlockIoHdDevicePathNode
;
2752 if ((BlockIoDevicePath
== NULL
) || (HardDriveDevicePath
== NULL
)) {
2757 // Make PreviousDevicePath == the device path node before the end node
2759 DevicePath
= BlockIoDevicePath
;
2760 BlockIoHdDevicePathNode
= NULL
;
2763 // find the partition device path node
2765 while (!IsDevicePathEnd (DevicePath
)) {
2766 if ((DevicePathType (DevicePath
) == MEDIA_DEVICE_PATH
) &&
2767 (DevicePathSubType (DevicePath
) == MEDIA_HARDDRIVE_DP
)
2769 BlockIoHdDevicePathNode
= DevicePath
;
2773 DevicePath
= NextDevicePathNode (DevicePath
);
2776 if (BlockIoHdDevicePathNode
== NULL
) {
2780 // See if the harddrive device path in blockio matches the orig Hard Drive Node
2782 TmpHdPath
= (HARDDRIVE_DEVICE_PATH
*) BlockIoHdDevicePathNode
;
2786 // Check for the match
2788 if ((TmpHdPath
->MBRType
== HardDriveDevicePath
->MBRType
) &&
2789 (TmpHdPath
->SignatureType
== HardDriveDevicePath
->SignatureType
)) {
2790 switch (TmpHdPath
->SignatureType
) {
2791 case SIGNATURE_TYPE_GUID
:
2792 Match
= CompareGuid ((EFI_GUID
*)TmpHdPath
->Signature
, (EFI_GUID
*)HardDriveDevicePath
->Signature
);
2794 case SIGNATURE_TYPE_MBR
:
2795 Match
= (BOOLEAN
)(*((UINT32
*)(&(TmpHdPath
->Signature
[0]))) == ReadUnaligned32((UINT32
*)(&(HardDriveDevicePath
->Signature
[0]))));
2807 Delete the boot option associated with the handle passed in.
2809 @param Handle The handle which present the device path to create
2812 @retval EFI_SUCCESS Delete the boot option success
2813 @retval EFI_NOT_FOUND If the Device Path is not found in the system
2814 @retval EFI_OUT_OF_RESOURCES Lack of memory resource
2815 @retval Other Error return value from SetVariable()
2819 BdsLibDeleteOptionFromHandle (
2820 IN EFI_HANDLE Handle
2824 UINT8
*BootOptionVar
;
2825 UINTN BootOrderSize
;
2826 UINTN BootOptionSize
;
2829 UINT16 BootOption
[BOOT_OPTION_MAX_CHAR
];
2830 UINTN DevicePathSize
;
2831 UINTN OptionDevicePathSize
;
2832 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
2833 EFI_DEVICE_PATH_PROTOCOL
*OptionDevicePath
;
2836 Status
= EFI_SUCCESS
;
2841 // Check "BootOrder" variable, if no, means there is no any boot order.
2843 BootOrder
= BdsLibGetVariableAndSize (
2845 &gEfiGlobalVariableGuid
,
2848 if (BootOrder
== NULL
) {
2849 return EFI_NOT_FOUND
;
2853 // Convert device handle to device path protocol instance
2855 DevicePath
= DevicePathFromHandle (Handle
);
2856 if (DevicePath
== NULL
) {
2857 return EFI_NOT_FOUND
;
2859 DevicePathSize
= GetDevicePathSize (DevicePath
);
2862 // Loop all boot order variable and find the matching device path
2865 while (Index
< BootOrderSize
/ sizeof (UINT16
)) {
2866 UnicodeSPrint (BootOption
, sizeof (BootOption
), L
"Boot%04x", BootOrder
[Index
]);
2867 BootOptionVar
= BdsLibGetVariableAndSize (
2869 &gEfiGlobalVariableGuid
,
2873 if (BootOptionVar
== NULL
) {
2874 FreePool (BootOrder
);
2875 return EFI_OUT_OF_RESOURCES
;
2878 if (!ValidateOption(BootOptionVar
, BootOptionSize
)) {
2879 BdsDeleteBootOption (BootOrder
[Index
], BootOrder
, &BootOrderSize
);
2880 FreePool (BootOptionVar
);
2885 TempPtr
= BootOptionVar
;
2886 TempPtr
+= sizeof (UINT32
) + sizeof (UINT16
);
2887 TempPtr
+= StrSize ((CHAR16
*) TempPtr
);
2888 OptionDevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) TempPtr
;
2889 OptionDevicePathSize
= GetDevicePathSize (OptionDevicePath
);
2892 // Check whether the device path match
2894 if ((OptionDevicePathSize
== DevicePathSize
) &&
2895 (CompareMem (DevicePath
, OptionDevicePath
, DevicePathSize
) == 0)) {
2896 BdsDeleteBootOption (BootOrder
[Index
], BootOrder
, &BootOrderSize
);
2897 FreePool (BootOptionVar
);
2901 FreePool (BootOptionVar
);
2906 // Adjust number of boot option for "BootOrder" variable.
2908 Status
= gRT
->SetVariable (
2910 &gEfiGlobalVariableGuid
,
2911 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
2916 // Shrinking variable with existing variable implementation shouldn't fail.
2918 ASSERT_EFI_ERROR (Status
);
2920 FreePool (BootOrder
);
2927 Delete all invalid EFI boot options.
2929 @retval EFI_SUCCESS Delete all invalid boot option success
2930 @retval EFI_NOT_FOUND Variable "BootOrder" is not found
2931 @retval EFI_OUT_OF_RESOURCES Lack of memory resource
2932 @retval Other Error return value from SetVariable()
2936 BdsDeleteAllInvalidEfiBootOption (
2941 UINT8
*BootOptionVar
;
2942 UINTN BootOrderSize
;
2943 UINTN BootOptionSize
;
2947 UINT16 BootOption
[BOOT_OPTION_MAX_CHAR
];
2948 EFI_DEVICE_PATH_PROTOCOL
*OptionDevicePath
;
2950 CHAR16
*Description
;
2953 Status
= EFI_SUCCESS
;
2956 OptionDevicePath
= NULL
;
2961 // Check "BootOrder" variable firstly, this variable hold the number of boot options
2963 BootOrder
= BdsLibGetVariableAndSize (
2965 &gEfiGlobalVariableGuid
,
2968 if (NULL
== BootOrder
) {
2969 return EFI_NOT_FOUND
;
2973 while (Index
< BootOrderSize
/ sizeof (UINT16
)) {
2974 UnicodeSPrint (BootOption
, sizeof (BootOption
), L
"Boot%04x", BootOrder
[Index
]);
2975 BootOptionVar
= BdsLibGetVariableAndSize (
2977 &gEfiGlobalVariableGuid
,
2980 if (NULL
== BootOptionVar
) {
2981 FreePool (BootOrder
);
2982 return EFI_OUT_OF_RESOURCES
;
2985 if (!ValidateOption(BootOptionVar
, BootOptionSize
)) {
2988 TempPtr
= BootOptionVar
;
2989 TempPtr
+= sizeof (UINT32
) + sizeof (UINT16
);
2990 Description
= (CHAR16
*) TempPtr
;
2991 TempPtr
+= StrSize ((CHAR16
*) TempPtr
);
2992 OptionDevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) TempPtr
;
2995 // Skip legacy boot option (BBS boot device)
2997 if ((DevicePathType (OptionDevicePath
) == BBS_DEVICE_PATH
) &&
2998 (DevicePathSubType (OptionDevicePath
) == BBS_BBS_DP
)) {
2999 FreePool (BootOptionVar
);
3005 if (Corrupted
|| !BdsLibIsValidEFIBootOptDevicePathExt (OptionDevicePath
, FALSE
, Description
)) {
3007 // Delete this invalid boot option "Boot####"
3009 Status
= gRT
->SetVariable (
3011 &gEfiGlobalVariableGuid
,
3012 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
3017 // Deleting variable with current variable implementation shouldn't fail.
3019 ASSERT_EFI_ERROR (Status
);
3021 // Mark this boot option in boot order as deleted
3023 BootOrder
[Index
] = 0xffff;
3027 FreePool (BootOptionVar
);
3032 // Adjust boot order array
3035 for (Index
= 0; Index
< BootOrderSize
/ sizeof (UINT16
); Index
++) {
3036 if (BootOrder
[Index
] != 0xffff) {
3037 BootOrder
[Index2
] = BootOrder
[Index
];
3041 Status
= gRT
->SetVariable (
3043 &gEfiGlobalVariableGuid
,
3044 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
3045 Index2
* sizeof (UINT16
),
3049 // Shrinking variable with current variable implementation shouldn't fail.
3051 ASSERT_EFI_ERROR (Status
);
3053 FreePool (BootOrder
);
3060 For EFI boot option, BDS separate them as six types:
3061 1. Network - The boot option points to the SimpleNetworkProtocol device.
3062 Bds will try to automatically create this type boot option when enumerate.
3063 2. Shell - The boot option points to internal flash shell.
3064 Bds will try to automatically create this type boot option when enumerate.
3065 3. Removable BlockIo - The boot option only points to the removable media
3066 device, like USB flash disk, DVD, Floppy etc.
3067 These device should contain a *removable* blockIo
3068 protocol in their device handle.
3069 Bds will try to automatically create this type boot option
3071 4. Fixed BlockIo - The boot option only points to a Fixed blockIo device,
3073 These device should contain a *fixed* blockIo
3074 protocol in their device handle.
3075 BDS will skip fixed blockIo devices, and NOT
3076 automatically create boot option for them. But BDS
3077 will help to delete those fixed blockIo boot option,
3078 whose description rule conflict with other auto-created
3080 5. Non-BlockIo Simplefile - The boot option points to a device whose handle
3081 has SimpleFileSystem Protocol, but has no blockio
3082 protocol. These devices do not offer blockIo
3083 protocol, but BDS still can get the
3084 \EFI\BOOT\boot{machinename}.EFI by SimpleFileSystem
3086 6. File - The boot option points to a file. These boot options are usually
3087 created by user manually or OS loader. BDS will not delete or modify
3090 This function will enumerate all possible boot device in the system, and
3091 automatically create boot options for Network, Shell, Removable BlockIo,
3092 and Non-BlockIo Simplefile devices.
3093 It will only execute once of every boot.
3095 @param BdsBootOptionList The header of the link list which indexed all
3096 current boot options
3098 @retval EFI_SUCCESS Finished all the boot device enumerate and create
3099 the boot option base on that boot device
3101 @retval EFI_OUT_OF_RESOURCES Failed to enumerate the boot device and create the boot option list
3105 BdsLibEnumerateAllBootOption (
3106 IN OUT LIST_ENTRY
*BdsBootOptionList
3110 UINT16 FloppyNumber
;
3111 UINT16 HarddriveNumber
;
3116 UINT16 NonBlockNumber
;
3117 UINTN NumberBlockIoHandles
;
3118 EFI_HANDLE
*BlockIoHandles
;
3119 EFI_BLOCK_IO_PROTOCOL
*BlkIo
;
3120 BOOLEAN Removable
[2];
3121 UINTN RemovableIndex
;
3123 UINTN NumOfLoadFileHandles
;
3124 EFI_HANDLE
*LoadFileHandles
;
3125 UINTN FvHandleCount
;
3126 EFI_HANDLE
*FvHandleBuffer
;
3127 EFI_FV_FILETYPE Type
;
3129 EFI_FV_FILE_ATTRIBUTES Attributes
;
3130 UINT32 AuthenticationStatus
;
3131 EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
;
3132 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
3133 UINTN DevicePathType
;
3135 EFI_HANDLE
*FileSystemHandles
;
3136 UINTN NumberFileSystemHandles
;
3138 EFI_IMAGE_DOS_HEADER DosHeader
;
3141 EFI_IMAGE_OPTIONAL_HEADER_UNION HdrData
;
3142 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
;
3145 HarddriveNumber
= 0;
3152 ZeroMem (Buffer
, sizeof (Buffer
));
3155 // If the boot device enumerate happened, just get the boot
3156 // device from the boot order variable
3158 if (mEnumBootDevice
) {
3159 GetVariable2 (LAST_ENUM_LANGUAGE_VARIABLE_NAME
, &gLastEnumLangGuid
, (VOID
**)&LastLang
, NULL
);
3160 GetEfiGlobalVariable2 (L
"PlatformLang", (VOID
**)&PlatLang
, NULL
);
3161 ASSERT (PlatLang
!= NULL
);
3162 if ((LastLang
!= NULL
) && (AsciiStrCmp (LastLang
, PlatLang
) == 0)) {
3163 Status
= BdsLibBuildOptionFromVar (BdsBootOptionList
, L
"BootOrder");
3164 FreePool (LastLang
);
3165 FreePool (PlatLang
);
3168 Status
= gRT
->SetVariable (
3169 LAST_ENUM_LANGUAGE_VARIABLE_NAME
,
3171 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
3172 AsciiStrSize (PlatLang
),
3176 // Failure to set the variable only impacts the performance next time enumerating the boot options.
3179 if (LastLang
!= NULL
) {
3180 FreePool (LastLang
);
3182 FreePool (PlatLang
);
3187 // Notes: this dirty code is to get the legacy boot option from the
3188 // BBS table and create to variable as the EFI boot option, it should
3189 // be removed after the CSM can provide legacy boot option directly
3191 REFRESH_LEGACY_BOOT_OPTIONS
;
3194 // Delete invalid boot option
3196 BdsDeleteAllInvalidEfiBootOption ();
3199 // Parse removable media followed by fixed media.
3200 // The Removable[] array is used by the for-loop below to create removable media boot options
3201 // at first, and then to create fixed media boot options.
3203 Removable
[0] = FALSE
;
3204 Removable
[1] = TRUE
;
3206 gBS
->LocateHandleBuffer (
3208 &gEfiBlockIoProtocolGuid
,
3210 &NumberBlockIoHandles
,
3214 for (RemovableIndex
= 0; RemovableIndex
< 2; RemovableIndex
++) {
3215 for (Index
= 0; Index
< NumberBlockIoHandles
; Index
++) {
3216 Status
= gBS
->HandleProtocol (
3217 BlockIoHandles
[Index
],
3218 &gEfiBlockIoProtocolGuid
,
3222 // skip the fixed block io then the removable block io
3224 if (EFI_ERROR (Status
) || (BlkIo
->Media
->RemovableMedia
== Removable
[RemovableIndex
])) {
3227 DevicePath
= DevicePathFromHandle (BlockIoHandles
[Index
]);
3228 DevicePathType
= BdsGetBootTypeFromDevicePath (DevicePath
);
3230 switch (DevicePathType
) {
3231 case BDS_EFI_ACPI_FLOPPY_BOOT
:
3232 if (FloppyNumber
!= 0) {
3233 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_FLOPPY
)), FloppyNumber
);
3235 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_FLOPPY
)));
3237 BdsLibBuildOptionFromHandle (BlockIoHandles
[Index
], BdsBootOptionList
, Buffer
);
3242 // Assume a removable SATA device should be the DVD/CD device, a fixed SATA device should be the Hard Drive device.
3244 case BDS_EFI_MESSAGE_ATAPI_BOOT
:
3245 case BDS_EFI_MESSAGE_SATA_BOOT
:
3246 if (BlkIo
->Media
->RemovableMedia
) {
3247 if (CdromNumber
!= 0) {
3248 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_CD_DVD
)), CdromNumber
);
3250 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_CD_DVD
)));
3254 if (HarddriveNumber
!= 0) {
3255 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_HARDDRIVE
)), HarddriveNumber
);
3257 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_HARDDRIVE
)));
3261 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Buffer: %S\n", Buffer
));
3262 BdsLibBuildOptionFromHandle (BlockIoHandles
[Index
], BdsBootOptionList
, Buffer
);
3265 case BDS_EFI_MESSAGE_USB_DEVICE_BOOT
:
3266 if (UsbNumber
!= 0) {
3267 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_USB
)), UsbNumber
);
3269 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_USB
)));
3271 BdsLibBuildOptionFromHandle (BlockIoHandles
[Index
], BdsBootOptionList
, Buffer
);
3275 case BDS_EFI_MESSAGE_SCSI_BOOT
:
3276 if (ScsiNumber
!= 0) {
3277 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_SCSI
)), ScsiNumber
);
3279 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_SCSI
)));
3281 BdsLibBuildOptionFromHandle (BlockIoHandles
[Index
], BdsBootOptionList
, Buffer
);
3285 case BDS_EFI_MESSAGE_MISC_BOOT
:
3286 if (MiscNumber
!= 0) {
3287 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_MISC
)), MiscNumber
);
3289 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_MISC
)));
3291 BdsLibBuildOptionFromHandle (BlockIoHandles
[Index
], BdsBootOptionList
, Buffer
);
3301 if (NumberBlockIoHandles
!= 0) {
3302 FreePool (BlockIoHandles
);
3306 // If there is simple file protocol which does not consume block Io protocol, create a boot option for it here.
3309 gBS
->LocateHandleBuffer (
3311 &gEfiSimpleFileSystemProtocolGuid
,
3313 &NumberFileSystemHandles
,
3316 for (Index
= 0; Index
< NumberFileSystemHandles
; Index
++) {
3317 Status
= gBS
->HandleProtocol (
3318 FileSystemHandles
[Index
],
3319 &gEfiBlockIoProtocolGuid
,
3322 if (!EFI_ERROR (Status
)) {
3324 // Skip if the file system handle supports a BlkIo protocol,
3330 // Do the removable Media thing. \EFI\BOOT\boot{machinename}.EFI
3331 // machinename is ia32, ia64, x64, ...
3333 Hdr
.Union
= &HdrData
;
3335 Status
= BdsLibGetImageHeader (
3336 FileSystemHandles
[Index
],
3337 EFI_REMOVABLE_MEDIA_FILE_NAME
,
3341 if (!EFI_ERROR (Status
) &&
3342 EFI_IMAGE_MACHINE_TYPE_SUPPORTED (Hdr
.Pe32
->FileHeader
.Machine
) &&
3343 Hdr
.Pe32
->OptionalHeader
.Subsystem
== EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION
) {
3349 // No such file or the file is not a EFI application, delete this boot option
3351 BdsLibDeleteOptionFromHandle (FileSystemHandles
[Index
]);
3353 if (NonBlockNumber
!= 0) {
3354 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NON_BLOCK
)), NonBlockNumber
);
3356 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NON_BLOCK
)));
3358 BdsLibBuildOptionFromHandle (FileSystemHandles
[Index
], BdsBootOptionList
, Buffer
);
3363 if (NumberFileSystemHandles
!= 0) {
3364 FreePool (FileSystemHandles
);
3368 // Parse Network Boot Device
3370 NumOfLoadFileHandles
= 0;
3372 // Search Load File protocol for PXE boot option.
3374 gBS
->LocateHandleBuffer (
3376 &gEfiLoadFileProtocolGuid
,
3378 &NumOfLoadFileHandles
,
3382 for (Index
= 0; Index
< NumOfLoadFileHandles
; Index
++) {
3384 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NETWORK
)), Index
);
3386 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NETWORK
)));
3388 BdsLibBuildOptionFromHandle (LoadFileHandles
[Index
], BdsBootOptionList
, Buffer
);
3391 if (NumOfLoadFileHandles
!= 0) {
3392 FreePool (LoadFileHandles
);
3396 // Check if we have on flash shell
3398 gBS
->LocateHandleBuffer (
3400 &gEfiFirmwareVolume2ProtocolGuid
,
3405 for (Index
= 0; Index
< FvHandleCount
; Index
++) {
3406 gBS
->HandleProtocol (
3407 FvHandleBuffer
[Index
],
3408 &gEfiFirmwareVolume2ProtocolGuid
,
3412 Status
= Fv
->ReadFile (
3414 PcdGetPtr(PcdShellFile
),
3419 &AuthenticationStatus
3421 if (EFI_ERROR (Status
)) {
3423 // Skip if no shell file in the FV
3428 // Build the shell boot option
3430 BdsLibBuildOptionFromShell (FvHandleBuffer
[Index
], BdsBootOptionList
);
3433 if (FvHandleCount
!= 0) {
3434 FreePool (FvHandleBuffer
);
3437 // Make sure every boot only have one time
3438 // boot device enumerate
3440 Status
= BdsLibBuildOptionFromVar (BdsBootOptionList
, L
"BootOrder");
3441 mEnumBootDevice
= TRUE
;
3447 Build the boot option with the handle parsed in
3449 @param Handle The handle which present the device path to create
3451 @param BdsBootOptionList The header of the link list which indexed all
3452 current boot options
3453 @param String The description of the boot option.
3458 BdsLibBuildOptionFromHandle (
3459 IN EFI_HANDLE Handle
,
3460 IN LIST_ENTRY
*BdsBootOptionList
,
3464 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
3466 DevicePath
= DevicePathFromHandle (Handle
);
3469 // Create and register new boot option
3471 BdsLibRegisterNewOption (BdsBootOptionList
, DevicePath
, String
, L
"BootOrder");
3476 Build the on flash shell boot option with the handle parsed in.
3478 @param Handle The handle which present the device path to create
3479 on flash shell boot option
3480 @param BdsBootOptionList The header of the link list which indexed all
3481 current boot options
3486 BdsLibBuildOptionFromShell (
3487 IN EFI_HANDLE Handle
,
3488 IN OUT LIST_ENTRY
*BdsBootOptionList
3491 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
3492 MEDIA_FW_VOL_FILEPATH_DEVICE_PATH ShellNode
;
3494 DevicePath
= DevicePathFromHandle (Handle
);
3497 // Build the shell device path
3499 EfiInitializeFwVolDevicepathNode (&ShellNode
, PcdGetPtr(PcdShellFile
));
3501 DevicePath
= AppendDevicePathNode (DevicePath
, (EFI_DEVICE_PATH_PROTOCOL
*) &ShellNode
);
3504 // Create and register the shell boot option
3506 BdsLibRegisterNewOption (BdsBootOptionList
, DevicePath
, L
"EFI Internal Shell", L
"BootOrder");
3511 Boot from the UEFI spec defined "BootNext" variable.
3524 BDS_COMMON_OPTION
*BootOption
;
3525 LIST_ENTRY TempList
;
3530 // Init the boot option name buffer and temp link list
3532 InitializeListHead (&TempList
);
3533 ZeroMem (Buffer
, sizeof (Buffer
));
3535 BootNext
= BdsLibGetVariableAndSize (
3537 &gEfiGlobalVariableGuid
,
3542 // Clear the boot next variable first
3544 if (BootNext
!= NULL
) {
3545 Status
= gRT
->SetVariable (
3547 &gEfiGlobalVariableGuid
,
3548 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
3553 // Deleting variable with current variable implementation shouldn't fail.
3555 ASSERT_EFI_ERROR (Status
);
3558 // Start to build the boot option and try to boot
3560 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"Boot%04x", *BootNext
);
3561 BootOption
= BdsLibVariableToOption (&TempList
, Buffer
);
3562 ASSERT (BootOption
!= NULL
);
3563 BdsLibConnectDevicePath (BootOption
->DevicePath
);
3564 BdsLibBootViaBootOption (BootOption
, BootOption
->DevicePath
, &ExitDataSize
, &ExitData
);
3570 Return the bootable media handle.
3571 First, check the device is connected
3572 Second, check whether the device path point to a device which support SimpleFileSystemProtocol,
3573 Third, detect the the default boot file in the Media, and return the removable Media handle.
3575 @param DevicePath Device Path to a bootable device
3577 @return The bootable media handle. If the media on the DevicePath is not bootable, NULL will return.
3582 BdsLibGetBootableHandle (
3583 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
3588 EFI_DEVICE_PATH_PROTOCOL
*UpdatedDevicePath
;
3589 EFI_DEVICE_PATH_PROTOCOL
*DupDevicePath
;
3591 EFI_BLOCK_IO_PROTOCOL
*BlockIo
;
3593 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
3596 EFI_HANDLE ReturnHandle
;
3597 EFI_HANDLE
*SimpleFileSystemHandles
;
3599 UINTN NumberSimpleFileSystemHandles
;
3601 EFI_IMAGE_DOS_HEADER DosHeader
;
3602 EFI_IMAGE_OPTIONAL_HEADER_UNION HdrData
;
3603 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
;
3605 UpdatedDevicePath
= DevicePath
;
3608 // Enter to critical section to protect the acquired BlockIo instance
3609 // from getting released due to the USB mass storage hotplug event
3611 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
3614 // Check whether the device is connected
3616 Status
= gBS
->LocateDevicePath (&gEfiBlockIoProtocolGuid
, &UpdatedDevicePath
, &Handle
);
3617 if (EFI_ERROR (Status
)) {
3619 // Skip the case that the boot option point to a simple file protocol which does not consume block Io protocol,
3621 Status
= gBS
->LocateDevicePath (&gEfiSimpleFileSystemProtocolGuid
, &UpdatedDevicePath
, &Handle
);
3622 if (EFI_ERROR (Status
)) {
3624 // Fail to find the proper BlockIo and simple file protocol, maybe because device not present, we need to connect it firstly
3626 UpdatedDevicePath
= DevicePath
;
3627 Status
= gBS
->LocateDevicePath (&gEfiDevicePathProtocolGuid
, &UpdatedDevicePath
, &Handle
);
3628 gBS
->ConnectController (Handle
, NULL
, NULL
, TRUE
);
3632 // For removable device boot option, its contained device path only point to the removable device handle,
3633 // should make sure all its children handles (its child partion or media handles) are created and connected.
3635 gBS
->ConnectController (Handle
, NULL
, NULL
, TRUE
);
3637 // Get BlockIo protocol and check removable attribute
3639 Status
= gBS
->HandleProtocol (Handle
, &gEfiBlockIoProtocolGuid
, (VOID
**)&BlockIo
);
3640 ASSERT_EFI_ERROR (Status
);
3643 // Issue a dummy read to the device to check for media change.
3644 // When the removable media is changed, any Block IO read/write will
3645 // cause the BlockIo protocol be reinstalled and EFI_MEDIA_CHANGED is
3646 // returned. After the Block IO protocol is reinstalled, subsequent
3647 // Block IO read/write will success.
3649 Buffer
= AllocatePool (BlockIo
->Media
->BlockSize
);
3650 if (Buffer
!= NULL
) {
3651 BlockIo
->ReadBlocks (
3653 BlockIo
->Media
->MediaId
,
3655 BlockIo
->Media
->BlockSize
,
3663 // Detect the the default boot file from removable Media
3667 // 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
3668 // Try to locate the USB node device path first, if fail then use its previous PCI node to search
3670 DupDevicePath
= DuplicateDevicePath (DevicePath
);
3671 ASSERT (DupDevicePath
!= NULL
);
3673 UpdatedDevicePath
= DupDevicePath
;
3674 Status
= gBS
->LocateDevicePath (&gEfiDevicePathProtocolGuid
, &UpdatedDevicePath
, &Handle
);
3676 // 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
3677 // Acpi()/Pci()/Usb() --> Acpi()/Pci()
3679 if ((DevicePathType (UpdatedDevicePath
) == MESSAGING_DEVICE_PATH
) &&
3680 (DevicePathSubType (UpdatedDevicePath
) == MSG_USB_DP
)) {
3682 // Remove the usb node, let the device path only point to PCI node
3684 SetDevicePathEndNode (UpdatedDevicePath
);
3685 UpdatedDevicePath
= DupDevicePath
;
3687 UpdatedDevicePath
= DevicePath
;
3691 // Get the device path size of boot option
3693 Size
= GetDevicePathSize(UpdatedDevicePath
) - sizeof (EFI_DEVICE_PATH_PROTOCOL
); // minus the end node
3694 ReturnHandle
= NULL
;
3695 gBS
->LocateHandleBuffer (
3697 &gEfiSimpleFileSystemProtocolGuid
,
3699 &NumberSimpleFileSystemHandles
,
3700 &SimpleFileSystemHandles
3702 for (Index
= 0; Index
< NumberSimpleFileSystemHandles
; Index
++) {
3704 // Get the device path size of SimpleFileSystem handle
3706 TempDevicePath
= DevicePathFromHandle (SimpleFileSystemHandles
[Index
]);
3707 TempSize
= GetDevicePathSize (TempDevicePath
)- sizeof (EFI_DEVICE_PATH_PROTOCOL
); // minus the end node
3709 // Check whether the device path of boot option is part of the SimpleFileSystem handle's device path
3711 if (Size
<= TempSize
&& CompareMem (TempDevicePath
, UpdatedDevicePath
, Size
)==0) {
3713 // Load the default boot file \EFI\BOOT\boot{machinename}.EFI from removable Media
3714 // machinename is ia32, ia64, x64, ...
3716 Hdr
.Union
= &HdrData
;
3717 Status
= BdsLibGetImageHeader (
3718 SimpleFileSystemHandles
[Index
],
3719 EFI_REMOVABLE_MEDIA_FILE_NAME
,
3723 if (!EFI_ERROR (Status
) &&
3724 EFI_IMAGE_MACHINE_TYPE_SUPPORTED (Hdr
.Pe32
->FileHeader
.Machine
) &&
3725 Hdr
.Pe32
->OptionalHeader
.Subsystem
== EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION
) {
3726 ReturnHandle
= SimpleFileSystemHandles
[Index
];
3732 FreePool(DupDevicePath
);
3734 if (SimpleFileSystemHandles
!= NULL
) {
3735 FreePool(SimpleFileSystemHandles
);
3738 gBS
->RestoreTPL (OldTpl
);
3740 return ReturnHandle
;
3744 Check to see if the network cable is plugged in. If the DevicePath is not
3745 connected it will be connected.
3747 @param DevicePath Device Path to check
3749 @retval TRUE DevicePath points to an Network that is connected
3750 @retval FALSE DevicePath does not point to a bootable network
3754 BdsLibNetworkBootWithMediaPresent (
3755 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
3759 EFI_DEVICE_PATH_PROTOCOL
*UpdatedDevicePath
;
3761 EFI_SIMPLE_NETWORK_PROTOCOL
*Snp
;
3762 BOOLEAN MediaPresent
;
3763 UINT32 InterruptStatus
;
3765 MediaPresent
= FALSE
;
3767 UpdatedDevicePath
= DevicePath
;
3769 // Locate Load File Protocol for PXE boot option first
3771 Status
= gBS
->LocateDevicePath (&gEfiLoadFileProtocolGuid
, &UpdatedDevicePath
, &Handle
);
3772 if (EFI_ERROR (Status
)) {
3774 // Device not present so see if we need to connect it
3776 Status
= BdsLibConnectDevicePath (DevicePath
);
3777 if (!EFI_ERROR (Status
)) {
3779 // This one should work after we did the connect
3781 Status
= gBS
->LocateDevicePath (&gEfiLoadFileProtocolGuid
, &UpdatedDevicePath
, &Handle
);
3785 if (!EFI_ERROR (Status
)) {
3786 Status
= gBS
->HandleProtocol (Handle
, &gEfiSimpleNetworkProtocolGuid
, (VOID
**)&Snp
);
3787 if (EFI_ERROR (Status
)) {
3789 // Failed to open SNP from this handle, try to get SNP from parent handle
3791 UpdatedDevicePath
= DevicePathFromHandle (Handle
);
3792 if (UpdatedDevicePath
!= NULL
) {
3793 Status
= gBS
->LocateDevicePath (&gEfiSimpleNetworkProtocolGuid
, &UpdatedDevicePath
, &Handle
);
3794 if (!EFI_ERROR (Status
)) {
3796 // SNP handle found, get SNP from it
3798 Status
= gBS
->HandleProtocol (Handle
, &gEfiSimpleNetworkProtocolGuid
, (VOID
**) &Snp
);
3803 if (!EFI_ERROR (Status
)) {
3804 if (Snp
->Mode
->MediaPresentSupported
) {
3805 if (Snp
->Mode
->State
== EfiSimpleNetworkInitialized
) {
3807 // Invoke Snp->GetStatus() to refresh the media status
3809 Snp
->GetStatus (Snp
, &InterruptStatus
, NULL
);
3812 // In case some one else is using the SNP check to see if it's connected
3814 MediaPresent
= Snp
->Mode
->MediaPresent
;
3817 // No one is using SNP so we need to Start and Initialize so
3818 // MediaPresent will be valid.
3820 Status
= Snp
->Start (Snp
);
3821 if (!EFI_ERROR (Status
)) {
3822 Status
= Snp
->Initialize (Snp
, 0, 0);
3823 if (!EFI_ERROR (Status
)) {
3824 MediaPresent
= Snp
->Mode
->MediaPresent
;
3825 Snp
->Shutdown (Snp
);
3831 MediaPresent
= TRUE
;
3836 return MediaPresent
;
3840 For a bootable Device path, return its boot type.
3842 @param DevicePath The bootable device Path to check
3844 @retval BDS_EFI_MEDIA_HD_BOOT If given device path contains MEDIA_DEVICE_PATH type device path node
3845 which subtype is MEDIA_HARDDRIVE_DP
3846 @retval BDS_EFI_MEDIA_CDROM_BOOT If given device path contains MEDIA_DEVICE_PATH type device path node
3847 which subtype is MEDIA_CDROM_DP
3848 @retval BDS_EFI_ACPI_FLOPPY_BOOT If given device path contains ACPI_DEVICE_PATH type device path node
3849 which HID is floppy device.
3850 @retval BDS_EFI_MESSAGE_ATAPI_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node
3851 and its last device path node's subtype is MSG_ATAPI_DP.
3852 @retval BDS_EFI_MESSAGE_SCSI_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node
3853 and its last device path node's subtype is MSG_SCSI_DP.
3854 @retval BDS_EFI_MESSAGE_USB_DEVICE_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node
3855 and its last device path node's subtype is MSG_USB_DP.
3856 @retval BDS_EFI_MESSAGE_MISC_BOOT If the device path not contains any media device path node, and
3857 its last device path node point to a message device path node.
3858 @retval BDS_LEGACY_BBS_BOOT If given device path contains BBS_DEVICE_PATH type device path node.
3859 @retval BDS_EFI_UNSUPPORT An EFI Removable BlockIO device path not point to a media and message device,
3864 BdsGetBootTypeFromDevicePath (
3865 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
3868 ACPI_HID_DEVICE_PATH
*Acpi
;
3869 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
3870 EFI_DEVICE_PATH_PROTOCOL
*LastDeviceNode
;
3873 if (NULL
== DevicePath
) {
3874 return BDS_EFI_UNSUPPORT
;
3877 TempDevicePath
= DevicePath
;
3879 while (!IsDevicePathEndType (TempDevicePath
)) {
3880 switch (DevicePathType (TempDevicePath
)) {
3881 case BBS_DEVICE_PATH
:
3882 return BDS_LEGACY_BBS_BOOT
;
3883 case MEDIA_DEVICE_PATH
:
3884 if (DevicePathSubType (TempDevicePath
) == MEDIA_HARDDRIVE_DP
) {
3885 return BDS_EFI_MEDIA_HD_BOOT
;
3886 } else if (DevicePathSubType (TempDevicePath
) == MEDIA_CDROM_DP
) {
3887 return BDS_EFI_MEDIA_CDROM_BOOT
;
3890 case ACPI_DEVICE_PATH
:
3891 Acpi
= (ACPI_HID_DEVICE_PATH
*) TempDevicePath
;
3892 if (EISA_ID_TO_NUM (Acpi
->HID
) == 0x0604) {
3893 return BDS_EFI_ACPI_FLOPPY_BOOT
;
3896 case MESSAGING_DEVICE_PATH
:
3898 // Get the last device path node
3900 LastDeviceNode
= NextDevicePathNode (TempDevicePath
);
3901 if (DevicePathSubType(LastDeviceNode
) == MSG_DEVICE_LOGICAL_UNIT_DP
) {
3903 // if the next node type is Device Logical Unit, which specify the Logical Unit Number (LUN),
3906 LastDeviceNode
= NextDevicePathNode (LastDeviceNode
);
3909 // if the device path not only point to driver device, it is not a messaging device path,
3911 if (!IsDevicePathEndType (LastDeviceNode
)) {
3915 switch (DevicePathSubType (TempDevicePath
)) {
3917 BootType
= BDS_EFI_MESSAGE_ATAPI_BOOT
;
3921 BootType
= BDS_EFI_MESSAGE_USB_DEVICE_BOOT
;
3925 BootType
= BDS_EFI_MESSAGE_SCSI_BOOT
;
3929 BootType
= BDS_EFI_MESSAGE_SATA_BOOT
;
3932 case MSG_MAC_ADDR_DP
:
3936 BootType
= BDS_EFI_MESSAGE_MAC_BOOT
;
3940 BootType
= BDS_EFI_MESSAGE_MISC_BOOT
;
3948 TempDevicePath
= NextDevicePathNode (TempDevicePath
);
3951 return BDS_EFI_UNSUPPORT
;
3955 Check whether the Device path in a boot option point to a valid bootable device,
3956 And if CheckMedia is true, check the device is ready to boot now.
3958 @param DevPath the Device path in a boot option
3959 @param CheckMedia if true, check the device is ready to boot now.
3961 @retval TRUE the Device path is valid
3962 @retval FALSE the Device path is invalid .
3967 BdsLibIsValidEFIBootOptDevicePath (
3968 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
,
3969 IN BOOLEAN CheckMedia
3972 return BdsLibIsValidEFIBootOptDevicePathExt (DevPath
, CheckMedia
, NULL
);
3976 Check whether the Device path in a boot option point to a valid bootable device,
3977 And if CheckMedia is true, check the device is ready to boot now.
3978 If Description is not NULL and the device path point to a fixed BlockIo
3979 device, check the description whether conflict with other auto-created
3982 @param DevPath the Device path in a boot option
3983 @param CheckMedia if true, check the device is ready to boot now.
3984 @param Description the description in a boot option
3986 @retval TRUE the Device path is valid
3987 @retval FALSE the Device path is invalid .
3992 BdsLibIsValidEFIBootOptDevicePathExt (
3993 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
,
3994 IN BOOLEAN CheckMedia
,
3995 IN CHAR16
*Description
4000 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
4001 EFI_DEVICE_PATH_PROTOCOL
*LastDeviceNode
;
4002 EFI_BLOCK_IO_PROTOCOL
*BlockIo
;
4004 TempDevicePath
= DevPath
;
4005 LastDeviceNode
= DevPath
;
4008 // Check if it's a valid boot option for network boot device.
4009 // Check if there is EfiLoadFileProtocol installed.
4010 // If yes, that means there is a boot option for network.
4012 Status
= gBS
->LocateDevicePath (
4013 &gEfiLoadFileProtocolGuid
,
4017 if (EFI_ERROR (Status
)) {
4019 // Device not present so see if we need to connect it
4021 TempDevicePath
= DevPath
;
4022 BdsLibConnectDevicePath (TempDevicePath
);
4023 Status
= gBS
->LocateDevicePath (
4024 &gEfiLoadFileProtocolGuid
,
4030 if (!EFI_ERROR (Status
)) {
4031 if (!IsDevicePathEnd (TempDevicePath
)) {
4033 // LoadFile protocol is not installed on handle with exactly the same DevPath
4040 // Test if it is ready to boot now
4042 if (BdsLibNetworkBootWithMediaPresent(DevPath
)) {
4051 // If the boot option point to a file, it is a valid EFI boot option,
4052 // and assume it is ready to boot now
4054 while (!IsDevicePathEnd (TempDevicePath
)) {
4056 // If there is USB Class or USB WWID device path node, treat it as valid EFI
4057 // Boot Option. BdsExpandUsbShortFormDevicePath () will be used to expand it
4058 // to full device path.
4060 if ((DevicePathType (TempDevicePath
) == MESSAGING_DEVICE_PATH
) &&
4061 ((DevicePathSubType (TempDevicePath
) == MSG_USB_CLASS_DP
) ||
4062 (DevicePathSubType (TempDevicePath
) == MSG_USB_WWID_DP
))) {
4066 LastDeviceNode
= TempDevicePath
;
4067 TempDevicePath
= NextDevicePathNode (TempDevicePath
);
4069 if ((DevicePathType (LastDeviceNode
) == MEDIA_DEVICE_PATH
) &&
4070 (DevicePathSubType (LastDeviceNode
) == MEDIA_FILEPATH_DP
)) {
4075 // Check if it's a valid boot option for internal FV application
4077 if (EfiGetNameGuidFromFwVolDevicePathNode ((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
*) LastDeviceNode
) != NULL
) {
4079 // If the boot option point to internal FV application, make sure it is valid
4081 TempDevicePath
= DevPath
;
4082 Status
= BdsLibUpdateFvFileDevicePath (
4084 EfiGetNameGuidFromFwVolDevicePathNode ((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
*) LastDeviceNode
)
4086 if (Status
== EFI_ALREADY_STARTED
) {
4089 if (Status
== EFI_SUCCESS
) {
4090 FreePool (TempDevicePath
);
4097 // If the boot option point to a blockIO device:
4098 // if it is a removable blockIo device, it is valid.
4099 // if it is a fixed blockIo device, check its description confliction.
4101 TempDevicePath
= DevPath
;
4102 Status
= gBS
->LocateDevicePath (&gEfiBlockIoProtocolGuid
, &TempDevicePath
, &Handle
);
4103 if (EFI_ERROR (Status
)) {
4105 // Device not present so see if we need to connect it
4107 Status
= BdsLibConnectDevicePath (DevPath
);
4108 if (!EFI_ERROR (Status
)) {
4110 // Try again to get the Block Io protocol after we did the connect
4112 TempDevicePath
= DevPath
;
4113 Status
= gBS
->LocateDevicePath (&gEfiBlockIoProtocolGuid
, &TempDevicePath
, &Handle
);
4117 if (!EFI_ERROR (Status
)) {
4118 Status
= gBS
->HandleProtocol (Handle
, &gEfiBlockIoProtocolGuid
, (VOID
**)&BlockIo
);
4119 if (!EFI_ERROR (Status
)) {
4122 // Test if it is ready to boot now
4124 if (BdsLibGetBootableHandle (DevPath
) != NULL
) {
4133 // 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,
4135 Status
= gBS
->LocateDevicePath (&gEfiSimpleFileSystemProtocolGuid
, &TempDevicePath
, &Handle
);
4136 if (!EFI_ERROR (Status
)) {
4139 // Test if it is ready to boot now
4141 if (BdsLibGetBootableHandle (DevPath
) != NULL
) {
4155 According to a file guild, check a Fv file device path is valid. If it is invalid,
4156 try to return the valid device path.
4157 FV address maybe changes for memory layout adjust from time to time, use this function
4158 could promise the Fv file device path is right.
4160 @param DevicePath on input, the Fv file device path need to check on
4161 output, the updated valid Fv file device path
4162 @param FileGuid the Fv file guild
4164 @retval EFI_INVALID_PARAMETER the input DevicePath or FileGuid is invalid
4166 @retval EFI_UNSUPPORTED the input DevicePath does not contain Fv file
4168 @retval EFI_ALREADY_STARTED the input DevicePath has pointed to Fv file, it is
4170 @retval EFI_SUCCESS has successfully updated the invalid DevicePath,
4171 and return the updated device path in DevicePath
4176 BdsLibUpdateFvFileDevicePath (
4177 IN OUT EFI_DEVICE_PATH_PROTOCOL
** DevicePath
,
4178 IN EFI_GUID
*FileGuid
4181 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
4182 EFI_DEVICE_PATH_PROTOCOL
*LastDeviceNode
;
4184 EFI_GUID
*GuidPoint
;
4186 UINTN FvHandleCount
;
4187 EFI_HANDLE
*FvHandleBuffer
;
4188 EFI_FV_FILETYPE Type
;
4190 EFI_FV_FILE_ATTRIBUTES Attributes
;
4191 UINT32 AuthenticationStatus
;
4193 EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
;
4194 EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
;
4195 MEDIA_FW_VOL_FILEPATH_DEVICE_PATH FvFileNode
;
4196 EFI_HANDLE FoundFvHandle
;
4197 EFI_DEVICE_PATH_PROTOCOL
*NewDevicePath
;
4199 if ((DevicePath
== NULL
) || (*DevicePath
== NULL
)) {
4200 return EFI_INVALID_PARAMETER
;
4202 if (FileGuid
== NULL
) {
4203 return EFI_INVALID_PARAMETER
;
4207 // Check whether the device path point to the default the input Fv file
4209 TempDevicePath
= *DevicePath
;
4210 LastDeviceNode
= TempDevicePath
;
4211 while (!IsDevicePathEnd (TempDevicePath
)) {
4212 LastDeviceNode
= TempDevicePath
;
4213 TempDevicePath
= NextDevicePathNode (TempDevicePath
);
4215 GuidPoint
= EfiGetNameGuidFromFwVolDevicePathNode (
4216 (MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
*) LastDeviceNode
4218 if (GuidPoint
== NULL
) {
4220 // if this option does not points to a Fv file, just return EFI_UNSUPPORTED
4222 return EFI_UNSUPPORTED
;
4224 if (!CompareGuid (GuidPoint
, FileGuid
)) {
4226 // If the Fv file is not the input file guid, just return EFI_UNSUPPORTED
4228 return EFI_UNSUPPORTED
;
4232 // Check whether the input Fv file device path is valid
4234 TempDevicePath
= *DevicePath
;
4235 FoundFvHandle
= NULL
;
4236 Status
= gBS
->LocateDevicePath (
4237 &gEfiFirmwareVolume2ProtocolGuid
,
4241 if (!EFI_ERROR (Status
)) {
4242 Status
= gBS
->HandleProtocol (
4244 &gEfiFirmwareVolume2ProtocolGuid
,
4247 if (!EFI_ERROR (Status
)) {
4249 // Set FV ReadFile Buffer as NULL, only need to check whether input Fv file exist there
4251 Status
= Fv
->ReadFile (
4258 &AuthenticationStatus
4260 if (!EFI_ERROR (Status
)) {
4261 return EFI_ALREADY_STARTED
;
4267 // Look for the input wanted FV file in current FV
4268 // First, try to look for in Bds own FV. Bds and input wanted FV file usually are in the same FV
4271 FoundFvHandle
= NULL
;
4272 Status
= gBS
->HandleProtocol (
4274 &gEfiLoadedImageProtocolGuid
,
4275 (VOID
**) &LoadedImage
4277 if (!EFI_ERROR (Status
)) {
4278 Status
= gBS
->HandleProtocol (
4279 LoadedImage
->DeviceHandle
,
4280 &gEfiFirmwareVolume2ProtocolGuid
,
4283 if (!EFI_ERROR (Status
)) {
4284 Status
= Fv
->ReadFile (
4291 &AuthenticationStatus
4293 if (!EFI_ERROR (Status
)) {
4295 FoundFvHandle
= LoadedImage
->DeviceHandle
;
4300 // Second, if fail to find, try to enumerate all FV
4303 FvHandleBuffer
= NULL
;
4304 gBS
->LocateHandleBuffer (
4306 &gEfiFirmwareVolume2ProtocolGuid
,
4311 for (Index
= 0; Index
< FvHandleCount
; Index
++) {
4312 gBS
->HandleProtocol (
4313 FvHandleBuffer
[Index
],
4314 &gEfiFirmwareVolume2ProtocolGuid
,
4318 Status
= Fv
->ReadFile (
4325 &AuthenticationStatus
4327 if (EFI_ERROR (Status
)) {
4329 // Skip if input Fv file not in the FV
4334 FoundFvHandle
= FvHandleBuffer
[Index
];
4338 if (FvHandleBuffer
!= NULL
) {
4339 FreePool (FvHandleBuffer
);
4345 // Build the shell device path
4347 NewDevicePath
= DevicePathFromHandle (FoundFvHandle
);
4348 EfiInitializeFwVolDevicepathNode (&FvFileNode
, FileGuid
);
4349 NewDevicePath
= AppendDevicePathNode (NewDevicePath
, (EFI_DEVICE_PATH_PROTOCOL
*) &FvFileNode
);
4350 *DevicePath
= NewDevicePath
;
4353 return EFI_NOT_FOUND
;