2 BDS Lib functions which relate with create or process the boot option.
4 Copyright (c) 2004 - 2013, 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
,
87 // adjust boot order array
89 for (Index
= 0; Index
< *BootOrderSize
/ sizeof (UINT16
); Index
++) {
90 if (BootOrder
[Index
] == OptionNumber
) {
91 CopyMem (&BootOrder
[Index
], &BootOrder
[Index
+1], *BootOrderSize
- (Index
+1) * sizeof (UINT16
));
92 *BootOrderSize
-= sizeof (UINT16
);
101 Translate the first n characters of an Ascii string to
102 Unicode characters. The count n is indicated by parameter
103 Size. If Size is greater than the length of string, then
104 the entire string is translated.
107 @param AStr Pointer to input Ascii string.
108 @param Size The number of characters to translate.
109 @param UStr Pointer to output Unicode string buffer.
122 while (AStr
[Idx
] != 0) {
123 UStr
[Idx
] = (CHAR16
) AStr
[Idx
];
134 Build Legacy Device Name String according.
136 @param CurBBSEntry BBS Table.
138 @param BufSize The buffer size.
139 @param BootString The output string.
143 BdsBuildLegacyDevNameString (
144 IN BBS_TABLE
*CurBBSEntry
,
147 OUT CHAR16
*BootString
160 Fmt
= L
"Primary Master %s";
167 Fmt
= L
"Primary Slave %s";
174 Fmt
= L
"Secondary Master %s";
181 Fmt
= L
"Secondary Slave %s";
189 switch (CurBBSEntry
->DeviceType
) {
210 case BBS_EMBED_NETWORK
:
224 // If current BBS entry has its description then use it.
226 StringDesc
= (UINT8
*) (UINTN
) ((CurBBSEntry
->DescStringSegment
<< 4) + CurBBSEntry
->DescStringOffset
);
227 if (NULL
!= StringDesc
) {
229 // Only get fisrt 32 characters, this is suggested by BBS spec
231 AsciiToUnicodeSize (StringDesc
, 32, Temp
);
237 // BbsTable 16 entries are for onboard IDE.
238 // Set description string for SATA harddisks, Harddisk 0 ~ Harddisk 11
240 if (Index
>= 5 && Index
<= 16 && (CurBBSEntry
->DeviceType
== BBS_HARDDISK
|| CurBBSEntry
->DeviceType
== BBS_CDROM
)) {
242 UnicodeSPrint (BootString
, BufSize
, Fmt
, Type
, Index
- 5);
244 UnicodeSPrint (BootString
, BufSize
, Fmt
, Type
);
250 Create a legacy boot option for the specified entry of
251 BBS table, save it as variable, and append it to the boot
255 @param CurrentBbsEntry Pointer to current BBS table.
256 @param CurrentBbsDevPath Pointer to the Device Path Protocol instance of BBS
257 @param Index Index of the specified entry in BBS table.
258 @param BootOrderList On input, the original boot order list.
259 On output, the new boot order list attached with the
261 @param BootOrderListSize On input, the original size of boot order list.
262 On output, the size of new boot order list.
264 @retval EFI_SUCCESS Boot Option successfully created.
265 @retval EFI_OUT_OF_RESOURCES Fail to allocate necessary memory.
266 @retval Other Error occurs while setting variable.
270 BdsCreateLegacyBootOption (
271 IN BBS_TABLE
*CurrentBbsEntry
,
272 IN EFI_DEVICE_PATH_PROTOCOL
*CurrentBbsDevPath
,
274 IN OUT UINT16
**BootOrderList
,
275 IN OUT UINTN
*BootOrderListSize
279 UINT16 CurrentBootOptionNo
;
280 UINT16 BootString
[10];
281 CHAR16 BootDesc
[100];
282 CHAR8 HelpString
[100];
283 UINT16
*NewBootOrderList
;
288 UINT16 CurrentBbsDevPathSize
;
289 UINTN BootOrderIndex
;
290 UINTN BootOrderLastIndex
;
292 BOOLEAN IndexNotFound
;
293 BBS_BBS_DEVICE_PATH
*NewBbsDevPathNode
;
295 if ((*BootOrderList
) == NULL
) {
296 CurrentBootOptionNo
= 0;
298 for (ArrayIndex
= 0; ArrayIndex
< (UINTN
) (*BootOrderListSize
/ sizeof (UINT16
)); ArrayIndex
++) {
299 IndexNotFound
= TRUE
;
300 for (BootOrderIndex
= 0; BootOrderIndex
< (UINTN
) (*BootOrderListSize
/ sizeof (UINT16
)); BootOrderIndex
++) {
301 if ((*BootOrderList
)[BootOrderIndex
] == ArrayIndex
) {
302 IndexNotFound
= FALSE
;
307 if (!IndexNotFound
) {
314 CurrentBootOptionNo
= (UINT16
) ArrayIndex
;
324 BdsBuildLegacyDevNameString (CurrentBbsEntry
, Index
, sizeof (BootDesc
), BootDesc
);
327 // Create new BBS device path node with description string
329 UnicodeStrToAsciiStr (BootDesc
, HelpString
);
331 StringLen
= AsciiStrLen (HelpString
);
332 NewBbsDevPathNode
= AllocateZeroPool (sizeof (BBS_BBS_DEVICE_PATH
) + StringLen
);
333 if (NewBbsDevPathNode
== NULL
) {
334 return EFI_OUT_OF_RESOURCES
;
336 CopyMem (NewBbsDevPathNode
, CurrentBbsDevPath
, sizeof (BBS_BBS_DEVICE_PATH
));
337 CopyMem (NewBbsDevPathNode
->String
, HelpString
, StringLen
+ 1);
338 SetDevicePathNodeLength (&(NewBbsDevPathNode
->Header
), sizeof (BBS_BBS_DEVICE_PATH
) + StringLen
);
341 // Create entire new CurrentBbsDevPath with end node
343 CurrentBbsDevPath
= AppendDevicePathNode (
345 (EFI_DEVICE_PATH_PROTOCOL
*) NewBbsDevPathNode
347 if (CurrentBbsDevPath
== NULL
) {
348 FreePool (NewBbsDevPathNode
);
349 return EFI_OUT_OF_RESOURCES
;
352 CurrentBbsDevPathSize
= (UINT16
) (GetDevicePathSize (CurrentBbsDevPath
));
354 BufferSize
= sizeof (UINT32
) +
357 CurrentBbsDevPathSize
+
361 Buffer
= AllocateZeroPool (BufferSize
);
362 if (Buffer
== NULL
) {
363 FreePool (NewBbsDevPathNode
);
364 FreePool (CurrentBbsDevPath
);
365 return EFI_OUT_OF_RESOURCES
;
368 Ptr
= (UINT8
*) Buffer
;
370 *((UINT32
*) Ptr
) = LOAD_OPTION_ACTIVE
;
371 Ptr
+= sizeof (UINT32
);
373 *((UINT16
*) Ptr
) = CurrentBbsDevPathSize
;
374 Ptr
+= sizeof (UINT16
);
381 Ptr
+= StrSize (BootDesc
);
386 CurrentBbsDevPathSize
388 Ptr
+= CurrentBbsDevPathSize
;
396 Ptr
+= sizeof (BBS_TABLE
);
397 *((UINT16
*) Ptr
) = (UINT16
) Index
;
399 Status
= gRT
->SetVariable (
401 &gEfiGlobalVariableGuid
,
402 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
411 NewBootOrderList
= AllocateZeroPool (*BootOrderListSize
+ sizeof (UINT16
));
412 if (NULL
== NewBootOrderList
) {
413 FreePool (NewBbsDevPathNode
);
414 FreePool (CurrentBbsDevPath
);
415 return EFI_OUT_OF_RESOURCES
;
418 if (*BootOrderList
!= NULL
) {
419 CopyMem (NewBootOrderList
, *BootOrderList
, *BootOrderListSize
);
420 FreePool (*BootOrderList
);
423 BootOrderLastIndex
= (UINTN
) (*BootOrderListSize
/ sizeof (UINT16
));
424 NewBootOrderList
[BootOrderLastIndex
] = CurrentBootOptionNo
;
425 *BootOrderListSize
+= sizeof (UINT16
);
426 *BootOrderList
= NewBootOrderList
;
428 FreePool (NewBbsDevPathNode
);
429 FreePool (CurrentBbsDevPath
);
434 Check if the boot option is a legacy one.
436 @param BootOptionVar The boot option data payload.
437 @param BbsEntry The BBS Table.
438 @param BbsIndex The table index.
440 @retval TRUE It is a legacy boot option.
441 @retval FALSE It is not a legacy boot option.
445 BdsIsLegacyBootOption (
446 IN UINT8
*BootOptionVar
,
447 OUT BBS_TABLE
**BbsEntry
,
452 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
457 Ptr
+= sizeof (UINT32
);
458 DevPathLen
= *(UINT16
*) Ptr
;
459 Ptr
+= sizeof (UINT16
);
460 Ptr
+= StrSize ((UINT16
*) Ptr
);
461 DevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) Ptr
;
462 if ((BBS_DEVICE_PATH
== DevicePath
->Type
) && (BBS_BBS_DP
== DevicePath
->SubType
)) {
464 *BbsEntry
= (BBS_TABLE
*) Ptr
;
465 Ptr
+= sizeof (BBS_TABLE
);
466 *BbsIndex
= *(UINT16
*) Ptr
;
477 Delete all the invalid legacy boot options.
479 @retval EFI_SUCCESS All invalide legacy boot options are deleted.
480 @retval EFI_OUT_OF_RESOURCES Fail to allocate necessary memory.
481 @retval EFI_NOT_FOUND Fail to retrive variable of boot order.
485 BdsDeleteAllInvalidLegacyBootOptions (
490 UINT8
*BootOptionVar
;
492 UINTN BootOptionSize
;
496 HDD_INFO
*LocalHddInfo
;
497 BBS_TABLE
*LocalBbsTable
;
500 EFI_LEGACY_BIOS_PROTOCOL
*LegacyBios
;
502 UINT16 BootOption
[10];
503 UINT16 BootDesc
[100];
504 BOOLEAN DescStringMatch
;
506 Status
= EFI_SUCCESS
;
512 LocalBbsTable
= NULL
;
515 Status
= gBS
->LocateProtocol (&gEfiLegacyBiosProtocolGuid
, NULL
, (VOID
**) &LegacyBios
);
516 if (EFI_ERROR (Status
)) {
520 LegacyBios
->GetBbsInfo (
528 BootOrder
= BdsLibGetVariableAndSize (
530 &gEfiGlobalVariableGuid
,
533 if (BootOrder
== NULL
) {
538 while (Index
< BootOrderSize
/ sizeof (UINT16
)) {
539 UnicodeSPrint (BootOption
, sizeof (BootOption
), L
"Boot%04x", BootOrder
[Index
]);
540 BootOptionVar
= BdsLibGetVariableAndSize (
542 &gEfiGlobalVariableGuid
,
545 if (NULL
== BootOptionVar
) {
547 Status
= gRT
->GetVariable (
549 &gEfiGlobalVariableGuid
,
554 if (Status
== EFI_NOT_FOUND
) {
558 BdsDeleteBootOption (
565 FreePool (BootOrder
);
566 return EFI_OUT_OF_RESOURCES
;
571 // Skip Non-Legacy boot option
573 if (!BdsIsLegacyBootOption (BootOptionVar
, &BbsEntry
, &BbsIndex
)) {
574 if (BootOptionVar
!= NULL
) {
575 FreePool (BootOptionVar
);
581 if (BbsIndex
< BbsCount
) {
583 // Check if BBS Description String is changed
585 DescStringMatch
= FALSE
;
586 BdsBuildLegacyDevNameString (
587 &LocalBbsTable
[BbsIndex
],
593 if (StrCmp (BootDesc
, (UINT16
*)(BootOptionVar
+ sizeof (UINT32
) + sizeof (UINT16
))) == 0) {
594 DescStringMatch
= TRUE
;
597 if (!((LocalBbsTable
[BbsIndex
].BootPriority
== BBS_IGNORE_ENTRY
) ||
598 (LocalBbsTable
[BbsIndex
].BootPriority
== BBS_DO_NOT_BOOT_FROM
)) &&
599 (LocalBbsTable
[BbsIndex
].DeviceType
== BbsEntry
->DeviceType
) &&
606 if (BootOptionVar
!= NULL
) {
607 FreePool (BootOptionVar
);
612 BdsDeleteBootOption (
620 // Adjust the number of boot options.
622 Status
= gRT
->SetVariable (
624 &gEfiGlobalVariableGuid
,
625 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
629 if (BootOrder
!= NULL
) {
630 FreePool (BootOrder
);
637 Find all legacy boot option by device type.
639 @param BootOrder The boot order array.
640 @param BootOptionNum The number of boot option.
641 @param DevType Device type.
642 @param DevName Device name.
643 @param Attribute The boot option attribute.
644 @param BbsIndex The BBS table index.
645 @param OptionNumber The boot option index.
647 @retval TRUE The Legacy boot option is found.
648 @retval FALSE The legacy boot option is not found.
652 BdsFindLegacyBootOptionByDevTypeAndName (
653 IN UINT16
*BootOrder
,
654 IN UINTN BootOptionNum
,
657 OUT UINT32
*Attribute
,
658 OUT UINT16
*BbsIndex
,
659 OUT UINT16
*OptionNumber
663 CHAR16 BootOption
[9];
664 UINTN BootOptionSize
;
665 UINT8
*BootOptionVar
;
672 if (NULL
== BootOrder
) {
677 // Loop all boot option from variable
679 for (Index
= 0; Index
< BootOptionNum
; Index
++) {
680 UnicodeSPrint (BootOption
, sizeof (BootOption
), L
"Boot%04x", (UINTN
) BootOrder
[Index
]);
681 BootOptionVar
= BdsLibGetVariableAndSize (
683 &gEfiGlobalVariableGuid
,
686 if (NULL
== BootOptionVar
) {
691 // Skip Non-legacy boot option
693 if (!BdsIsLegacyBootOption (BootOptionVar
, &BbsEntry
, BbsIndex
)) {
694 FreePool (BootOptionVar
);
699 (BbsEntry
->DeviceType
!= DevType
) ||
700 (StrCmp (DevName
, (CHAR16
*)(BootOptionVar
+ sizeof (UINT32
) + sizeof (UINT16
))) != 0)
702 FreePool (BootOptionVar
);
706 *Attribute
= *(UINT32
*) BootOptionVar
;
707 *OptionNumber
= BootOrder
[Index
];
709 FreePool (BootOptionVar
);
717 Create a legacy boot option.
719 @param BbsItem The BBS Table entry.
720 @param Index Index of the specified entry in BBS table.
721 @param BootOrderList The boot order list.
722 @param BootOrderListSize The size of boot order list.
724 @retval EFI_OUT_OF_RESOURCE No enough memory.
725 @retval EFI_SUCCESS The function complete successfully.
726 @return Other value if the legacy boot option is not created.
730 BdsCreateOneLegacyBootOption (
731 IN BBS_TABLE
*BbsItem
,
733 IN OUT UINT16
**BootOrderList
,
734 IN OUT UINTN
*BootOrderListSize
737 BBS_BBS_DEVICE_PATH BbsDevPathNode
;
739 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
744 // Create device path node.
746 BbsDevPathNode
.Header
.Type
= BBS_DEVICE_PATH
;
747 BbsDevPathNode
.Header
.SubType
= BBS_BBS_DP
;
748 SetDevicePathNodeLength (&BbsDevPathNode
.Header
, sizeof (BBS_BBS_DEVICE_PATH
));
749 BbsDevPathNode
.DeviceType
= BbsItem
->DeviceType
;
750 CopyMem (&BbsDevPathNode
.StatusFlag
, &BbsItem
->StatusFlags
, sizeof (UINT16
));
752 DevPath
= AppendDevicePathNode (
754 (EFI_DEVICE_PATH_PROTOCOL
*) &BbsDevPathNode
756 if (NULL
== DevPath
) {
757 return EFI_OUT_OF_RESOURCES
;
760 Status
= BdsCreateLegacyBootOption (
767 BbsItem
->BootPriority
= 0x00;
775 Add the legacy boot options from BBS table if they do not exist.
777 @retval EFI_SUCCESS The boot options are added successfully
778 or they are already in boot options.
779 @retval EFI_NOT_FOUND No legacy boot options is found.
780 @retval EFI_OUT_OF_RESOURCE No enough memory.
781 @return Other value LegacyBoot options are not added.
785 BdsAddNonExistingLegacyBootOptions (
795 HDD_INFO
*LocalHddInfo
;
796 BBS_TABLE
*LocalBbsTable
;
798 EFI_LEGACY_BIOS_PROTOCOL
*LegacyBios
;
807 LocalBbsTable
= NULL
;
809 Status
= gBS
->LocateProtocol (&gEfiLegacyBiosProtocolGuid
, NULL
, (VOID
**) &LegacyBios
);
810 if (EFI_ERROR (Status
)) {
814 LegacyBios
->GetBbsInfo (
822 BootOrder
= BdsLibGetVariableAndSize (
824 &gEfiGlobalVariableGuid
,
827 if (BootOrder
== NULL
) {
831 for (Index
= 0; Index
< BbsCount
; Index
++) {
832 if ((LocalBbsTable
[Index
].BootPriority
== BBS_IGNORE_ENTRY
) ||
833 (LocalBbsTable
[Index
].BootPriority
== BBS_DO_NOT_BOOT_FROM
)
838 BdsBuildLegacyDevNameString (&LocalBbsTable
[Index
], Index
, sizeof (Desc
), Desc
);
840 Exist
= BdsFindLegacyBootOptionByDevTypeAndName (
842 BootOrderSize
/ sizeof (UINT16
),
843 LocalBbsTable
[Index
].DeviceType
,
851 // Not found such type of legacy device in boot options or we found but it's disabled
852 // so we have to create one and put it to the tail of boot order list
854 Status
= BdsCreateOneLegacyBootOption (
855 &LocalBbsTable
[Index
],
860 if (EFI_ERROR (Status
)) {
864 OptionNumber
= BootOrder
[BootOrderSize
/ sizeof (UINT16
) - 1];
867 ASSERT (BbsIndex
== Index
);
870 Status
= gRT
->SetVariable (
872 &gEfiGlobalVariableGuid
,
873 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
877 if (BootOrder
!= NULL
) {
878 FreePool (BootOrder
);
885 Fill the device order buffer.
887 @param BbsTable The BBS table.
888 @param BbsType The BBS Type.
889 @param BbsCount The BBS Count.
890 @param Buf device order buffer.
892 @return The device order buffer.
897 IN BBS_TABLE
*BbsTable
,
905 for (Index
= 0; Index
< BbsCount
; Index
++) {
906 if (BbsTable
[Index
].BootPriority
== BBS_IGNORE_ENTRY
) {
910 if (BbsTable
[Index
].DeviceType
!= BbsType
) {
914 *Buf
= (UINT16
) (Index
& 0xFF);
922 Create the device order buffer.
924 @param BbsTable The BBS table.
925 @param BbsCount The BBS Count.
927 @retval EFI_SUCCES The buffer is created and the EFI variable named
928 VAR_LEGACY_DEV_ORDER and gEfiLegacyDevOrderVariableGuid is
930 @retval EFI_OUT_OF_RESOURCES Memmory or storage is not enough.
931 @retval EFI_DEVICE_ERROR Fail to add the device order into EFI variable fail
932 because of hardware error.
936 IN BBS_TABLE
*BbsTable
,
948 LEGACY_DEV_ORDER_ENTRY
*DevOrder
;
949 LEGACY_DEV_ORDER_ENTRY
*DevOrderPtr
;
958 HeaderSize
= sizeof (BBS_TYPE
) + sizeof (UINT16
);
960 Status
= EFI_SUCCESS
;
963 // Count all boot devices
965 for (Index
= 0; Index
< BbsCount
; Index
++) {
966 if (BbsTable
[Index
].BootPriority
== BBS_IGNORE_ENTRY
) {
970 switch (BbsTable
[Index
].DeviceType
) {
983 case BBS_EMBED_NETWORK
:
996 TotalSize
+= (HeaderSize
+ sizeof (UINT16
) * FDCount
);
997 TotalSize
+= (HeaderSize
+ sizeof (UINT16
) * HDCount
);
998 TotalSize
+= (HeaderSize
+ sizeof (UINT16
) * CDCount
);
999 TotalSize
+= (HeaderSize
+ sizeof (UINT16
) * NETCount
);
1000 TotalSize
+= (HeaderSize
+ sizeof (UINT16
) * BEVCount
);
1003 // Create buffer to hold all boot device order
1005 DevOrder
= AllocateZeroPool (TotalSize
);
1006 if (NULL
== DevOrder
) {
1007 return EFI_OUT_OF_RESOURCES
;
1009 DevOrderPtr
= DevOrder
;
1011 DevOrderPtr
->BbsType
= BBS_FLOPPY
;
1012 DevOrderPtr
->Length
= (UINT16
) (sizeof (DevOrderPtr
->Length
) + FDCount
* sizeof (UINT16
));
1013 DevOrderPtr
= (LEGACY_DEV_ORDER_ENTRY
*) BdsFillDevOrderBuf (BbsTable
, BBS_FLOPPY
, BbsCount
, DevOrderPtr
->Data
);
1015 DevOrderPtr
->BbsType
= BBS_HARDDISK
;
1016 DevOrderPtr
->Length
= (UINT16
) (sizeof (UINT16
) + HDCount
* sizeof (UINT16
));
1017 DevOrderPtr
= (LEGACY_DEV_ORDER_ENTRY
*) BdsFillDevOrderBuf (BbsTable
, BBS_HARDDISK
, BbsCount
, DevOrderPtr
->Data
);
1019 DevOrderPtr
->BbsType
= BBS_CDROM
;
1020 DevOrderPtr
->Length
= (UINT16
) (sizeof (UINT16
) + CDCount
* sizeof (UINT16
));
1021 DevOrderPtr
= (LEGACY_DEV_ORDER_ENTRY
*) BdsFillDevOrderBuf (BbsTable
, BBS_CDROM
, BbsCount
, DevOrderPtr
->Data
);
1023 DevOrderPtr
->BbsType
= BBS_EMBED_NETWORK
;
1024 DevOrderPtr
->Length
= (UINT16
) (sizeof (UINT16
) + NETCount
* sizeof (UINT16
));
1025 DevOrderPtr
= (LEGACY_DEV_ORDER_ENTRY
*) BdsFillDevOrderBuf (BbsTable
, BBS_EMBED_NETWORK
, BbsCount
, DevOrderPtr
->Data
);
1027 DevOrderPtr
->BbsType
= BBS_BEV_DEVICE
;
1028 DevOrderPtr
->Length
= (UINT16
) (sizeof (UINT16
) + BEVCount
* sizeof (UINT16
));
1029 DevOrderPtr
= (LEGACY_DEV_ORDER_ENTRY
*) BdsFillDevOrderBuf (BbsTable
, BBS_BEV_DEVICE
, BbsCount
, DevOrderPtr
->Data
);
1031 ASSERT (TotalSize
== (UINTN
) ((UINT8
*) DevOrderPtr
- (UINT8
*) DevOrder
));
1034 // Save device order for legacy boot device to variable.
1036 Status
= gRT
->SetVariable (
1037 VAR_LEGACY_DEV_ORDER
,
1038 &gEfiLegacyDevOrderVariableGuid
,
1039 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
1043 FreePool (DevOrder
);
1049 Add the legacy boot devices from BBS table into
1050 the legacy device boot order.
1052 @retval EFI_SUCCESS The boot devices are added successfully.
1053 @retval EFI_NOT_FOUND The legacy boot devices are not found.
1054 @retval EFI_OUT_OF_RESOURCES Memmory or storage is not enough.
1055 @retval EFI_DEVICE_ERROR Fail to add the legacy device boot order into EFI variable
1056 because of hardware error.
1060 BdsUpdateLegacyDevOrder (
1064 LEGACY_DEV_ORDER_ENTRY
*DevOrder
;
1065 LEGACY_DEV_ORDER_ENTRY
*NewDevOrder
;
1066 LEGACY_DEV_ORDER_ENTRY
*Ptr
;
1067 LEGACY_DEV_ORDER_ENTRY
*NewPtr
;
1069 EFI_LEGACY_BIOS_PROTOCOL
*LegacyBios
;
1073 HDD_INFO
*LocalHddInfo
;
1074 BBS_TABLE
*LocalBbsTable
;
1104 HeaderSize
= sizeof (BBS_TYPE
) + sizeof (UINT16
);
1112 Status
= gBS
->LocateProtocol (&gEfiLegacyBiosProtocolGuid
, NULL
, (VOID
**) &LegacyBios
);
1113 if (EFI_ERROR (Status
)) {
1117 Status
= LegacyBios
->GetBbsInfo (
1124 if (EFI_ERROR (Status
)) {
1128 DevOrder
= BdsLibGetVariableAndSize (
1129 VAR_LEGACY_DEV_ORDER
,
1130 &gEfiLegacyDevOrderVariableGuid
,
1133 if (NULL
== DevOrder
) {
1134 return BdsCreateDevOrder (LocalBbsTable
, BbsCount
);
1137 // First we figure out how many boot devices with same device type respectively
1139 for (Index
= 0; Index
< BbsCount
; Index
++) {
1140 if ((LocalBbsTable
[Index
].BootPriority
== BBS_IGNORE_ENTRY
) ||
1141 (LocalBbsTable
[Index
].BootPriority
== BBS_DO_NOT_BOOT_FROM
)
1146 switch (LocalBbsTable
[Index
].DeviceType
) {
1159 case BBS_EMBED_NETWORK
:
1163 case BBS_BEV_DEVICE
:
1172 TotalSize
+= (HeaderSize
+ FDCount
* sizeof (UINT16
));
1173 TotalSize
+= (HeaderSize
+ HDCount
* sizeof (UINT16
));
1174 TotalSize
+= (HeaderSize
+ CDCount
* sizeof (UINT16
));
1175 TotalSize
+= (HeaderSize
+ NETCount
* sizeof (UINT16
));
1176 TotalSize
+= (HeaderSize
+ BEVCount
* sizeof (UINT16
));
1178 NewDevOrder
= AllocateZeroPool (TotalSize
);
1179 if (NULL
== NewDevOrder
) {
1180 return EFI_OUT_OF_RESOURCES
;
1189 NewPtr
= NewDevOrder
;
1190 NewPtr
->BbsType
= Ptr
->BbsType
;
1191 NewPtr
->Length
= (UINT16
) (sizeof (UINT16
) + FDCount
* sizeof (UINT16
));
1192 for (Index
= 0; Index
< Ptr
->Length
/ sizeof (UINT16
) - 1; Index
++) {
1193 if (LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].BootPriority
== BBS_IGNORE_ENTRY
||
1194 LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].BootPriority
== BBS_DO_NOT_BOOT_FROM
||
1195 LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].DeviceType
!= BBS_FLOPPY
1200 NewPtr
->Data
[FDIndex
] = Ptr
->Data
[Index
];
1203 NewFDPtr
= NewPtr
->Data
;
1208 Ptr
= (LEGACY_DEV_ORDER_ENTRY
*) (&Ptr
->Data
[Ptr
->Length
/ sizeof (UINT16
) - 1]);
1209 NewPtr
= (LEGACY_DEV_ORDER_ENTRY
*) (&NewPtr
->Data
[NewPtr
->Length
/ sizeof (UINT16
) -1]);
1210 NewPtr
->BbsType
= Ptr
->BbsType
;
1211 NewPtr
->Length
= (UINT16
) (sizeof (UINT16
) + HDCount
* sizeof (UINT16
));
1212 for (Index
= 0; Index
< Ptr
->Length
/ sizeof (UINT16
) - 1; Index
++) {
1213 if (LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].BootPriority
== BBS_IGNORE_ENTRY
||
1214 LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].BootPriority
== BBS_DO_NOT_BOOT_FROM
||
1215 LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].BootPriority
== BBS_LOWEST_PRIORITY
||
1216 LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].DeviceType
!= BBS_HARDDISK
1221 NewPtr
->Data
[HDIndex
] = Ptr
->Data
[Index
];
1224 NewHDPtr
= NewPtr
->Data
;
1229 Ptr
= (LEGACY_DEV_ORDER_ENTRY
*) (&Ptr
->Data
[Ptr
->Length
/ sizeof (UINT16
) - 1]);
1230 NewPtr
= (LEGACY_DEV_ORDER_ENTRY
*) (&NewPtr
->Data
[NewPtr
->Length
/ sizeof (UINT16
) -1]);
1231 NewPtr
->BbsType
= Ptr
->BbsType
;
1232 NewPtr
->Length
= (UINT16
) (sizeof (UINT16
) + CDCount
* sizeof (UINT16
));
1233 for (Index
= 0; Index
< Ptr
->Length
/ sizeof (UINT16
) - 1; Index
++) {
1234 if (LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].BootPriority
== BBS_IGNORE_ENTRY
||
1235 LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].BootPriority
== BBS_DO_NOT_BOOT_FROM
||
1236 LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].BootPriority
== BBS_LOWEST_PRIORITY
||
1237 LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].DeviceType
!= BBS_CDROM
1242 NewPtr
->Data
[CDIndex
] = Ptr
->Data
[Index
];
1245 NewCDPtr
= NewPtr
->Data
;
1250 Ptr
= (LEGACY_DEV_ORDER_ENTRY
*) (&Ptr
->Data
[Ptr
->Length
/ sizeof (UINT16
) - 1]);
1251 NewPtr
= (LEGACY_DEV_ORDER_ENTRY
*) (&NewPtr
->Data
[NewPtr
->Length
/ sizeof (UINT16
) -1]);
1252 NewPtr
->BbsType
= Ptr
->BbsType
;
1253 NewPtr
->Length
= (UINT16
) (sizeof (UINT16
) + NETCount
* sizeof (UINT16
));
1254 for (Index
= 0; Index
< Ptr
->Length
/ sizeof (UINT16
) - 1; Index
++) {
1255 if (LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].BootPriority
== BBS_IGNORE_ENTRY
||
1256 LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].BootPriority
== BBS_DO_NOT_BOOT_FROM
||
1257 LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].BootPriority
== BBS_LOWEST_PRIORITY
||
1258 LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].DeviceType
!= BBS_EMBED_NETWORK
1263 NewPtr
->Data
[NETIndex
] = Ptr
->Data
[Index
];
1266 NewNETPtr
= NewPtr
->Data
;
1271 Ptr
= (LEGACY_DEV_ORDER_ENTRY
*) (&Ptr
->Data
[Ptr
->Length
/ sizeof (UINT16
) - 1]);
1272 NewPtr
= (LEGACY_DEV_ORDER_ENTRY
*) (&NewPtr
->Data
[NewPtr
->Length
/ sizeof (UINT16
) -1]);
1273 NewPtr
->BbsType
= Ptr
->BbsType
;
1274 NewPtr
->Length
= (UINT16
) (sizeof (UINT16
) + BEVCount
* sizeof (UINT16
));
1275 for (Index
= 0; Index
< Ptr
->Length
/ sizeof (UINT16
) - 1; Index
++) {
1276 if (LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].BootPriority
== BBS_IGNORE_ENTRY
||
1277 LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].BootPriority
== BBS_DO_NOT_BOOT_FROM
||
1278 LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].BootPriority
== BBS_LOWEST_PRIORITY
||
1279 LocalBbsTable
[Ptr
->Data
[Index
] & 0xFF].DeviceType
!= BBS_BEV_DEVICE
1284 NewPtr
->Data
[BEVIndex
] = Ptr
->Data
[Index
];
1287 NewBEVPtr
= NewPtr
->Data
;
1289 for (Index
= 0; Index
< BbsCount
; Index
++) {
1290 if ((LocalBbsTable
[Index
].BootPriority
== BBS_IGNORE_ENTRY
) ||
1291 (LocalBbsTable
[Index
].BootPriority
== BBS_DO_NOT_BOOT_FROM
)
1296 switch (LocalBbsTable
[Index
].DeviceType
) {
1299 NewDevPtr
= NewFDPtr
;
1304 NewDevPtr
= NewHDPtr
;
1309 NewDevPtr
= NewCDPtr
;
1312 case BBS_EMBED_NETWORK
:
1314 NewDevPtr
= NewNETPtr
;
1317 case BBS_BEV_DEVICE
:
1319 NewDevPtr
= NewBEVPtr
;
1327 // at this point we have copied those valid indexes to new buffer
1328 // and we should check if there is any new appeared boot device
1331 for (Index2
= 0; Index2
< *Idx
; Index2
++) {
1332 if ((NewDevPtr
[Index2
] & 0xFF) == (UINT16
) Index
) {
1337 if (Index2
== *Idx
) {
1339 // Index2 == *Idx means we didn't find Index
1340 // so Index is a new appeared device's index in BBS table
1341 // insert it before disabled indexes.
1343 for (Index2
= 0; Index2
< *Idx
; Index2
++) {
1344 if ((NewDevPtr
[Index2
] & 0xFF00) == 0xFF00) {
1348 CopyMem (&NewDevPtr
[Index2
+ 1], &NewDevPtr
[Index2
], (*Idx
- Index2
) * sizeof (UINT16
));
1349 NewDevPtr
[Index2
] = (UINT16
) (Index
& 0xFF);
1355 FreePool (DevOrder
);
1357 Status
= gRT
->SetVariable (
1358 VAR_LEGACY_DEV_ORDER
,
1359 &gEfiLegacyDevOrderVariableGuid
,
1360 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
1364 FreePool (NewDevOrder
);
1370 Set Boot Priority for specified device type.
1372 @param DeviceType The device type.
1373 @param BbsIndex The BBS index to set the highest priority. Ignore when -1.
1374 @param LocalBbsTable The BBS table.
1375 @param Priority The prority table.
1377 @retval EFI_SUCCESS The function completes successfully.
1378 @retval EFI_NOT_FOUND Failed to find device.
1379 @retval EFI_OUT_OF_RESOURCES Failed to get the efi variable of device order.
1383 BdsSetBootPriority4SameTypeDev (
1384 IN UINT16 DeviceType
,
1386 IN OUT BBS_TABLE
*LocalBbsTable
,
1387 IN OUT UINT16
*Priority
1390 LEGACY_DEV_ORDER_ENTRY
*DevOrder
;
1391 LEGACY_DEV_ORDER_ENTRY
*DevOrderPtr
;
1395 DevOrder
= BdsLibGetVariableAndSize (
1396 VAR_LEGACY_DEV_ORDER
,
1397 &gEfiLegacyDevOrderVariableGuid
,
1400 if (NULL
== DevOrder
) {
1401 return EFI_OUT_OF_RESOURCES
;
1404 DevOrderPtr
= DevOrder
;
1405 while ((UINT8
*) DevOrderPtr
< (UINT8
*) DevOrder
+ DevOrderSize
) {
1406 if (DevOrderPtr
->BbsType
== DeviceType
) {
1410 DevOrderPtr
= (LEGACY_DEV_ORDER_ENTRY
*) ((UINT8
*) DevOrderPtr
+ sizeof (BBS_TYPE
) + DevOrderPtr
->Length
);
1413 if ((UINT8
*) DevOrderPtr
>= (UINT8
*) DevOrder
+ DevOrderSize
) {
1414 FreePool (DevOrder
);
1415 return EFI_NOT_FOUND
;
1418 if (BbsIndex
!= (UINTN
) -1) {
1419 LocalBbsTable
[BbsIndex
].BootPriority
= *Priority
;
1423 // If the high byte of the DevIndex is 0xFF, it indicates that this device has been disabled.
1425 for (Index
= 0; Index
< DevOrderPtr
->Length
/ sizeof (UINT16
) - 1; Index
++) {
1426 if ((DevOrderPtr
->Data
[Index
] & 0xFF00) == 0xFF00) {
1428 // LocalBbsTable[DevIndex[Index] & 0xFF].BootPriority = BBS_DISABLED_ENTRY;
1430 } else if (DevOrderPtr
->Data
[Index
] != BbsIndex
) {
1431 LocalBbsTable
[DevOrderPtr
->Data
[Index
]].BootPriority
= *Priority
;
1436 FreePool (DevOrder
);
1441 Print the BBS Table.
1443 @param LocalBbsTable The BBS table.
1444 @param BbsCount The count of entry in BBS table.
1448 IN BBS_TABLE
*LocalBbsTable
,
1454 DEBUG ((DEBUG_ERROR
, "\n"));
1455 DEBUG ((DEBUG_ERROR
, " NO Prio bb/dd/ff cl/sc Type Stat segm:offs\n"));
1456 DEBUG ((DEBUG_ERROR
, "=============================================\n"));
1457 for (Idx
= 0; Idx
< BbsCount
; Idx
++) {
1458 if ((LocalBbsTable
[Idx
].BootPriority
== BBS_IGNORE_ENTRY
) ||
1459 (LocalBbsTable
[Idx
].BootPriority
== BBS_DO_NOT_BOOT_FROM
) ||
1460 (LocalBbsTable
[Idx
].BootPriority
== BBS_LOWEST_PRIORITY
)
1467 " %02x: %04x %02x/%02x/%02x %02x/%02x %04x %04x %04x:%04x\n",
1469 (UINTN
) LocalBbsTable
[Idx
].BootPriority
,
1470 (UINTN
) LocalBbsTable
[Idx
].Bus
,
1471 (UINTN
) LocalBbsTable
[Idx
].Device
,
1472 (UINTN
) LocalBbsTable
[Idx
].Function
,
1473 (UINTN
) LocalBbsTable
[Idx
].Class
,
1474 (UINTN
) LocalBbsTable
[Idx
].SubClass
,
1475 (UINTN
) LocalBbsTable
[Idx
].DeviceType
,
1476 (UINTN
) * (UINT16
*) &LocalBbsTable
[Idx
].StatusFlags
,
1477 (UINTN
) LocalBbsTable
[Idx
].BootHandlerSegment
,
1478 (UINTN
) LocalBbsTable
[Idx
].BootHandlerOffset
,
1479 (UINTN
) ((LocalBbsTable
[Idx
].MfgStringSegment
<< 4) + LocalBbsTable
[Idx
].MfgStringOffset
),
1480 (UINTN
) ((LocalBbsTable
[Idx
].DescStringSegment
<< 4) + LocalBbsTable
[Idx
].DescStringOffset
))
1484 DEBUG ((DEBUG_ERROR
, "\n"));
1488 Set the boot priority for BBS entries based on boot option entry and boot order.
1490 @param Entry The boot option is to be checked for refresh BBS table.
1492 @retval EFI_SUCCESS The boot priority for BBS entries is refreshed successfully.
1493 @retval EFI_NOT_FOUND BBS entries can't be found.
1494 @retval EFI_OUT_OF_RESOURCES Failed to get the legacy device boot order.
1498 BdsRefreshBbsTableForBoot (
1499 IN BDS_COMMON_OPTION
*Entry
1506 HDD_INFO
*LocalHddInfo
;
1507 BBS_TABLE
*LocalBbsTable
;
1509 EFI_LEGACY_BIOS_PROTOCOL
*LegacyBios
;
1513 UINTN BootOrderSize
;
1514 UINT8
*BootOptionVar
;
1515 UINTN BootOptionSize
;
1516 CHAR16 BootOption
[9];
1519 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
1521 UINTN DeviceTypeCount
;
1522 UINTN DeviceTypeIndex
;
1526 LocalHddInfo
= NULL
;
1527 LocalBbsTable
= NULL
;
1528 DevType
= BBS_UNKNOWN
;
1530 Status
= gBS
->LocateProtocol (&gEfiLegacyBiosProtocolGuid
, NULL
, (VOID
**) &LegacyBios
);
1531 if (EFI_ERROR (Status
)) {
1535 LegacyBios
->GetBbsInfo (
1543 // First, set all the present devices' boot priority to BBS_UNPRIORITIZED_ENTRY
1544 // We will set them according to the settings setup by user
1546 for (Index
= 0; Index
< BbsCount
; Index
++) {
1547 if (!((BBS_IGNORE_ENTRY
== LocalBbsTable
[Index
].BootPriority
) ||
1548 (BBS_DO_NOT_BOOT_FROM
== LocalBbsTable
[Index
].BootPriority
) ||
1549 (BBS_LOWEST_PRIORITY
== LocalBbsTable
[Index
].BootPriority
))) {
1550 LocalBbsTable
[Index
].BootPriority
= BBS_UNPRIORITIZED_ENTRY
;
1554 // boot priority always starts at 0
1557 if (Entry
->LoadOptionsSize
== sizeof (BBS_TABLE
) + sizeof (UINT16
)) {
1559 // If Entry stands for a legacy boot option, we prioritize the devices with the same type first.
1561 DevType
= ((BBS_TABLE
*) Entry
->LoadOptions
)->DeviceType
;
1562 BbsIndex
= *(UINT16
*) ((BBS_TABLE
*) Entry
->LoadOptions
+ 1);
1563 Status
= BdsSetBootPriority4SameTypeDev (
1569 if (EFI_ERROR (Status
)) {
1574 // we have to set the boot priority for other BBS entries with different device types
1576 BootOrder
= BdsLibGetVariableAndSize (
1578 &gEfiGlobalVariableGuid
,
1581 DeviceType
= AllocatePool (BootOrderSize
+ sizeof (UINT16
));
1582 ASSERT (DeviceType
!= NULL
);
1584 DeviceType
[0] = DevType
;
1585 DeviceTypeCount
= 1;
1586 for (Index
= 0; ((BootOrder
!= NULL
) && (Index
< BootOrderSize
/ sizeof (UINT16
))); Index
++) {
1587 UnicodeSPrint (BootOption
, sizeof (BootOption
), L
"Boot%04x", BootOrder
[Index
]);
1588 BootOptionVar
= BdsLibGetVariableAndSize (
1590 &gEfiGlobalVariableGuid
,
1593 if (NULL
== BootOptionVar
) {
1597 Ptr
= BootOptionVar
;
1599 Ptr
+= sizeof (UINT32
);
1600 DevPathLen
= *(UINT16
*) Ptr
;
1601 Ptr
+= sizeof (UINT16
);
1602 Ptr
+= StrSize ((UINT16
*) Ptr
);
1603 DevPath
= (EFI_DEVICE_PATH_PROTOCOL
*) Ptr
;
1604 if (BBS_DEVICE_PATH
!= DevPath
->Type
|| BBS_BBS_DP
!= DevPath
->SubType
) {
1605 FreePool (BootOptionVar
);
1610 DevType
= ((BBS_TABLE
*) Ptr
)->DeviceType
;
1611 for (DeviceTypeIndex
= 0; DeviceTypeIndex
< DeviceTypeCount
; DeviceTypeIndex
++) {
1612 if (DeviceType
[DeviceTypeIndex
] == DevType
) {
1616 if (DeviceTypeIndex
< DeviceTypeCount
) {
1618 // We don't want to process twice for a device type
1620 FreePool (BootOptionVar
);
1624 DeviceType
[DeviceTypeCount
] = DevType
;
1627 Status
= BdsSetBootPriority4SameTypeDev (
1633 FreePool (BootOptionVar
);
1634 if (EFI_ERROR (Status
)) {
1639 if (BootOrder
!= NULL
) {
1640 FreePool (BootOrder
);
1644 PrintBbsTable (LocalBbsTable
, BbsCount
);
1651 Boot the legacy system with the boot option
1653 @param Option The legacy boot option which have BBS device path
1655 @retval EFI_UNSUPPORTED There is no legacybios protocol, do not support
1657 @retval EFI_STATUS Return the status of LegacyBios->LegacyBoot ().
1661 BdsLibDoLegacyBoot (
1662 IN BDS_COMMON_OPTION
*Option
1666 EFI_LEGACY_BIOS_PROTOCOL
*LegacyBios
;
1667 EFI_EVENT LegacyBootEvent
;
1669 Status
= gBS
->LocateProtocol (&gEfiLegacyBiosProtocolGuid
, NULL
, (VOID
**) &LegacyBios
);
1670 if (EFI_ERROR (Status
)) {
1672 // If no LegacyBios protocol we do not support legacy boot
1674 return EFI_UNSUPPORTED
;
1677 // Notes: if we separate the int 19, then we don't need to refresh BBS
1679 BdsRefreshBbsTableForBoot (Option
);
1682 // Write boot to OS performance data for legacy boot.
1686 // Create an event to be signalled when Legacy Boot occurs to write performance data.
1688 Status
= EfiCreateEventLegacyBootEx(
1690 WriteBootToOsPerformanceData
,
1694 ASSERT_EFI_ERROR (Status
);
1697 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Legacy Boot: %S\n", Option
->Description
));
1698 return LegacyBios
->LegacyBoot (
1700 (BBS_BBS_DEVICE_PATH
*) Option
->DevicePath
,
1701 Option
->LoadOptionsSize
,
1707 Internal function to check if the input boot option is a valid EFI NV Boot####.
1709 @param OptionToCheck Boot option to be checked.
1711 @retval TRUE This boot option matches a valid EFI NV Boot####.
1712 @retval FALSE If not.
1716 IsBootOptionValidNVVarialbe (
1717 IN BDS_COMMON_OPTION
*OptionToCheck
1720 LIST_ENTRY TempList
;
1721 BDS_COMMON_OPTION
*BootOption
;
1723 CHAR16 OptionName
[20];
1727 InitializeListHead (&TempList
);
1728 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Boot%04x", OptionToCheck
->BootCurrent
);
1730 BootOption
= BdsLibVariableToOption (&TempList
, OptionName
);
1731 if (BootOption
== NULL
) {
1736 // If the Boot Option Number and Device Path matches, OptionToCheck matches a
1737 // valid EFI NV Boot####.
1739 if ((OptionToCheck
->BootCurrent
== BootOption
->BootCurrent
) &&
1740 (CompareMem (OptionToCheck
->DevicePath
, BootOption
->DevicePath
, GetDevicePathSize (OptionToCheck
->DevicePath
)) == 0))
1745 FreePool (BootOption
);
1751 Check whether a USB device match the specified USB Class device path. This
1752 function follows "Load Option Processing" behavior in UEFI specification.
1754 @param UsbIo USB I/O protocol associated with the USB device.
1755 @param UsbClass The USB Class device path to match.
1757 @retval TRUE The USB device match the USB Class device path.
1758 @retval FALSE The USB device does not match the USB Class device path.
1763 IN EFI_USB_IO_PROTOCOL
*UsbIo
,
1764 IN USB_CLASS_DEVICE_PATH
*UsbClass
1768 EFI_USB_DEVICE_DESCRIPTOR DevDesc
;
1769 EFI_USB_INTERFACE_DESCRIPTOR IfDesc
;
1771 UINT8 DeviceSubClass
;
1772 UINT8 DeviceProtocol
;
1774 if ((DevicePathType (UsbClass
) != MESSAGING_DEVICE_PATH
) ||
1775 (DevicePathSubType (UsbClass
) != MSG_USB_CLASS_DP
)){
1780 // Check Vendor Id and Product Id.
1782 Status
= UsbIo
->UsbGetDeviceDescriptor (UsbIo
, &DevDesc
);
1783 if (EFI_ERROR (Status
)) {
1787 if ((UsbClass
->VendorId
!= 0xffff) &&
1788 (UsbClass
->VendorId
!= DevDesc
.IdVendor
)) {
1792 if ((UsbClass
->ProductId
!= 0xffff) &&
1793 (UsbClass
->ProductId
!= DevDesc
.IdProduct
)) {
1797 DeviceClass
= DevDesc
.DeviceClass
;
1798 DeviceSubClass
= DevDesc
.DeviceSubClass
;
1799 DeviceProtocol
= DevDesc
.DeviceProtocol
;
1800 if (DeviceClass
== 0) {
1802 // If Class in Device Descriptor is set to 0, use the Class, SubClass and
1803 // Protocol in Interface Descriptor instead.
1805 Status
= UsbIo
->UsbGetInterfaceDescriptor (UsbIo
, &IfDesc
);
1806 if (EFI_ERROR (Status
)) {
1810 DeviceClass
= IfDesc
.InterfaceClass
;
1811 DeviceSubClass
= IfDesc
.InterfaceSubClass
;
1812 DeviceProtocol
= IfDesc
.InterfaceProtocol
;
1816 // Check Class, SubClass and Protocol.
1818 if ((UsbClass
->DeviceClass
!= 0xff) &&
1819 (UsbClass
->DeviceClass
!= DeviceClass
)) {
1823 if ((UsbClass
->DeviceSubClass
!= 0xff) &&
1824 (UsbClass
->DeviceSubClass
!= DeviceSubClass
)) {
1828 if ((UsbClass
->DeviceProtocol
!= 0xff) &&
1829 (UsbClass
->DeviceProtocol
!= DeviceProtocol
)) {
1837 Check whether a USB device match the specified USB WWID device path. This
1838 function follows "Load Option Processing" behavior in UEFI specification.
1840 @param UsbIo USB I/O protocol associated with the USB device.
1841 @param UsbWwid The USB WWID device path to match.
1843 @retval TRUE The USB device match the USB WWID device path.
1844 @retval FALSE The USB device does not match the USB WWID device path.
1849 IN EFI_USB_IO_PROTOCOL
*UsbIo
,
1850 IN USB_WWID_DEVICE_PATH
*UsbWwid
1854 EFI_USB_DEVICE_DESCRIPTOR DevDesc
;
1855 EFI_USB_INTERFACE_DESCRIPTOR IfDesc
;
1856 UINT16
*LangIdTable
;
1861 CHAR16
*SerialNumberStr
;
1864 if ((DevicePathType (UsbWwid
) != MESSAGING_DEVICE_PATH
) ||
1865 (DevicePathSubType (UsbWwid
) != MSG_USB_WWID_DP
)){
1870 // Check Vendor Id and Product Id.
1872 Status
= UsbIo
->UsbGetDeviceDescriptor (UsbIo
, &DevDesc
);
1873 if (EFI_ERROR (Status
)) {
1876 if ((DevDesc
.IdVendor
!= UsbWwid
->VendorId
) ||
1877 (DevDesc
.IdProduct
!= UsbWwid
->ProductId
)) {
1882 // Check Interface Number.
1884 Status
= UsbIo
->UsbGetInterfaceDescriptor (UsbIo
, &IfDesc
);
1885 if (EFI_ERROR (Status
)) {
1888 if (IfDesc
.InterfaceNumber
!= UsbWwid
->InterfaceNumber
) {
1893 // Check Serial Number.
1895 if (DevDesc
.StrSerialNumber
== 0) {
1900 // Get all supported languages.
1904 Status
= UsbIo
->UsbGetSupportedLanguages (UsbIo
, &LangIdTable
, &TableSize
);
1905 if (EFI_ERROR (Status
) || (TableSize
== 0) || (LangIdTable
== NULL
)) {
1910 // Serial number in USB WWID device path is the last 64-or-less UTF-16 characters.
1912 CompareStr
= (CHAR16
*) (UINTN
) (UsbWwid
+ 1);
1913 CompareLen
= (DevicePathNodeLength (UsbWwid
) - sizeof (USB_WWID_DEVICE_PATH
)) / sizeof (CHAR16
);
1914 if (CompareStr
[CompareLen
- 1] == L
'\0') {
1919 // Compare serial number in each supported language.
1921 for (Index
= 0; Index
< TableSize
/ sizeof (UINT16
); Index
++) {
1922 SerialNumberStr
= NULL
;
1923 Status
= UsbIo
->UsbGetStringDescriptor (
1926 DevDesc
.StrSerialNumber
,
1929 if (EFI_ERROR (Status
) || (SerialNumberStr
== NULL
)) {
1933 Length
= StrLen (SerialNumberStr
);
1934 if ((Length
>= CompareLen
) &&
1935 (CompareMem (SerialNumberStr
+ Length
- CompareLen
, CompareStr
, CompareLen
* sizeof (CHAR16
)) == 0)) {
1936 FreePool (SerialNumberStr
);
1940 FreePool (SerialNumberStr
);
1947 Find a USB device path which match the specified short-form device path start
1948 with USB Class or USB WWID device path and load the boot file then return the
1949 image handle. If ParentDevicePath is NULL, this function will search in all USB
1950 devices of the platform. If ParentDevicePath is not NULL,this function will only
1951 search in its child devices.
1953 @param ParentDevicePath The device path of the parent.
1954 @param ShortFormDevicePath The USB Class or USB WWID device path to match.
1956 @return The image Handle if find load file from specified short-form device path
1957 or NULL if not found.
1962 IN EFI_DEVICE_PATH_PROTOCOL
*ParentDevicePath
,
1963 IN EFI_DEVICE_PATH_PROTOCOL
*ShortFormDevicePath
1967 UINTN UsbIoHandleCount
;
1968 EFI_HANDLE
*UsbIoHandleBuffer
;
1969 EFI_DEVICE_PATH_PROTOCOL
*UsbIoDevicePath
;
1970 EFI_USB_IO_PROTOCOL
*UsbIo
;
1974 EFI_HANDLE ImageHandle
;
1976 EFI_DEVICE_PATH_PROTOCOL
*FullDevicePath
;
1977 EFI_DEVICE_PATH_PROTOCOL
*NextDevicePath
;
1979 FullDevicePath
= NULL
;
1983 // Get all UsbIo Handles.
1985 UsbIoHandleCount
= 0;
1986 UsbIoHandleBuffer
= NULL
;
1987 Status
= gBS
->LocateHandleBuffer (
1989 &gEfiUsbIoProtocolGuid
,
1994 if (EFI_ERROR (Status
) || (UsbIoHandleCount
== 0) || (UsbIoHandleBuffer
== NULL
)) {
1998 ParentSize
= (ParentDevicePath
== NULL
) ? 0 : GetDevicePathSize (ParentDevicePath
);
1999 for (Index
= 0; Index
< UsbIoHandleCount
; Index
++) {
2001 // Get the Usb IO interface.
2003 Status
= gBS
->HandleProtocol(
2004 UsbIoHandleBuffer
[Index
],
2005 &gEfiUsbIoProtocolGuid
,
2008 if (EFI_ERROR (Status
)) {
2012 UsbIoDevicePath
= DevicePathFromHandle (UsbIoHandleBuffer
[Index
]);
2013 if (UsbIoDevicePath
== NULL
) {
2017 if (ParentDevicePath
!= NULL
) {
2019 // Compare starting part of UsbIoHandle's device path with ParentDevicePath.
2021 Size
= GetDevicePathSize (UsbIoDevicePath
);
2022 if ((Size
< ParentSize
) ||
2023 (CompareMem (UsbIoDevicePath
, ParentDevicePath
, ParentSize
- END_DEVICE_PATH_LENGTH
) != 0)) {
2028 if (BdsMatchUsbClass (UsbIo
, (USB_CLASS_DEVICE_PATH
*) ShortFormDevicePath
) ||
2029 BdsMatchUsbWwid (UsbIo
, (USB_WWID_DEVICE_PATH
*) ShortFormDevicePath
)) {
2031 // Try to find if there is the boot file in this DevicePath
2033 NextDevicePath
= NextDevicePathNode (ShortFormDevicePath
);
2034 if (!IsDevicePathEnd (NextDevicePath
)) {
2035 FullDevicePath
= AppendDevicePath (UsbIoDevicePath
, NextDevicePath
);
2037 // Connect the full device path, so that Simple File System protocol
2038 // could be installed for this USB device.
2040 BdsLibConnectDevicePath (FullDevicePath
);
2041 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, PcdGet32 (PcdProgressCodeOsLoaderLoad
));
2042 Status
= gBS
->LoadImage (
2050 FreePool (FullDevicePath
);
2052 FullDevicePath
= UsbIoDevicePath
;
2053 Status
= EFI_NOT_FOUND
;
2057 // If we didn't find an image directly, we need to try as if it is a removable device boot option
2058 // and load the image according to the default boot behavior for removable device.
2060 if (EFI_ERROR (Status
)) {
2062 // check if there is a bootable removable media could be found in this device path ,
2063 // and get the bootable media handle
2065 Handle
= BdsLibGetBootableHandle(UsbIoDevicePath
);
2066 if (Handle
== NULL
) {
2070 // Load the default boot file \EFI\BOOT\boot{machinename}.EFI from removable Media
2071 // machinename is ia32, ia64, x64, ...
2073 FullDevicePath
= FileDevicePath (Handle
, EFI_REMOVABLE_MEDIA_FILE_NAME
);
2074 if (FullDevicePath
!= NULL
) {
2075 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, PcdGet32 (PcdProgressCodeOsLoaderLoad
));
2076 Status
= gBS
->LoadImage (
2084 if (EFI_ERROR (Status
)) {
2086 // The DevicePath failed, and it's not a valid
2087 // removable media device.
2099 FreePool (UsbIoHandleBuffer
);
2104 Expand USB Class or USB WWID device path node to be full device path of a USB
2105 device in platform then load the boot file on this full device path and return the
2108 This function support following 4 cases:
2109 1) Boot Option device path starts with a USB Class or USB WWID device path,
2110 and there is no Media FilePath device path in the end.
2111 In this case, it will follow Removable Media Boot Behavior.
2112 2) Boot Option device path starts with a USB Class or USB WWID device path,
2113 and ended with Media FilePath device path.
2114 3) Boot Option device path starts with a full device path to a USB Host Controller,
2115 contains a USB Class or USB WWID device path node, while not ended with Media
2116 FilePath device path. In this case, it will follow Removable Media Boot Behavior.
2117 4) Boot Option device path starts with a full device path to a USB Host Controller,
2118 contains a USB Class or USB WWID device path node, and ended with Media
2119 FilePath device path.
2121 @param DevicePath The Boot Option device path.
2123 @return The image handle of boot file, or NULL if there is no boot file found in
2124 the specified USB Class or USB WWID device path.
2128 BdsExpandUsbShortFormDevicePath (
2129 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
2132 EFI_HANDLE
*ImageHandle
;
2133 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
2134 EFI_DEVICE_PATH_PROTOCOL
*ShortFormDevicePath
;
2137 // Search for USB Class or USB WWID device path node.
2139 ShortFormDevicePath
= NULL
;
2141 TempDevicePath
= DevicePath
;
2142 while (!IsDevicePathEnd (TempDevicePath
)) {
2143 if ((DevicePathType (TempDevicePath
) == MESSAGING_DEVICE_PATH
) &&
2144 ((DevicePathSubType (TempDevicePath
) == MSG_USB_CLASS_DP
) ||
2145 (DevicePathSubType (TempDevicePath
) == MSG_USB_WWID_DP
))) {
2146 ShortFormDevicePath
= TempDevicePath
;
2149 TempDevicePath
= NextDevicePathNode (TempDevicePath
);
2152 if (ShortFormDevicePath
== NULL
) {
2154 // No USB Class or USB WWID device path node found, do nothing.
2159 if (ShortFormDevicePath
== DevicePath
) {
2161 // Boot Option device path starts with USB Class or USB WWID device path.
2163 ImageHandle
= BdsFindUsbDevice (NULL
, ShortFormDevicePath
);
2164 if (ImageHandle
== NULL
) {
2166 // Failed to find a match in existing devices, connect the short form USB
2167 // device path and try again.
2169 BdsLibConnectUsbDevByShortFormDP (0xff, ShortFormDevicePath
);
2170 ImageHandle
= BdsFindUsbDevice (NULL
, ShortFormDevicePath
);
2174 // Boot Option device path contains USB Class or USB WWID device path node.
2178 // Prepare the parent device path for search.
2180 TempDevicePath
= DuplicateDevicePath (DevicePath
);
2181 ASSERT (TempDevicePath
!= NULL
);
2182 SetDevicePathEndNode (((UINT8
*) TempDevicePath
) + ((UINTN
) ShortFormDevicePath
- (UINTN
) DevicePath
));
2185 // The USB Host Controller device path is already in Boot Option device path
2186 // and USB Bus driver already support RemainingDevicePath starts with USB
2187 // Class or USB WWID device path, so just search in existing USB devices and
2188 // doesn't perform ConnectController here.
2190 ImageHandle
= BdsFindUsbDevice (TempDevicePath
, ShortFormDevicePath
);
2191 FreePool (TempDevicePath
);
2198 Process the boot option follow the UEFI specification and
2199 special treat the legacy boot option with BBS_DEVICE_PATH.
2201 @param Option The boot option need to be processed
2202 @param DevicePath The device path which describe where to load the
2203 boot image or the legacy BBS device path to boot
2205 @param ExitDataSize The size of exit data.
2206 @param ExitData Data returned when Boot image failed.
2208 @retval EFI_SUCCESS Boot from the input boot option successfully.
2209 @retval EFI_NOT_FOUND If the Device Path is not found in the system
2214 BdsLibBootViaBootOption (
2215 IN BDS_COMMON_OPTION
*Option
,
2216 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
2217 OUT UINTN
*ExitDataSize
,
2218 OUT CHAR16
**ExitData OPTIONAL
2222 EFI_STATUS StatusLogo
;
2224 EFI_HANDLE ImageHandle
;
2225 EFI_DEVICE_PATH_PROTOCOL
*FilePath
;
2226 EFI_LOADED_IMAGE_PROTOCOL
*ImageInfo
;
2227 EFI_DEVICE_PATH_PROTOCOL
*WorkingDevicePath
;
2228 EFI_ACPI_S3_SAVE_PROTOCOL
*AcpiS3Save
;
2229 LIST_ENTRY TempBootLists
;
2230 EFI_BOOT_LOGO_PROTOCOL
*BootLogo
;
2236 // Notes: this code can be remove after the s3 script table
2237 // hook on the event EVT_SIGNAL_READY_TO_BOOT or
2238 // EVT_SIGNAL_LEGACY_BOOT
2240 Status
= gBS
->LocateProtocol (&gEfiAcpiS3SaveProtocolGuid
, NULL
, (VOID
**) &AcpiS3Save
);
2241 if (!EFI_ERROR (Status
)) {
2242 AcpiS3Save
->S3Save (AcpiS3Save
, NULL
);
2245 // If it's Device Path that starts with a hard drive path, append it with the front part to compose a
2248 WorkingDevicePath
= NULL
;
2249 if ((DevicePathType (DevicePath
) == MEDIA_DEVICE_PATH
) &&
2250 (DevicePathSubType (DevicePath
) == MEDIA_HARDDRIVE_DP
)) {
2251 WorkingDevicePath
= BdsExpandPartitionPartialDevicePathToFull (
2252 (HARDDRIVE_DEVICE_PATH
*)DevicePath
2254 if (WorkingDevicePath
!= NULL
) {
2255 DevicePath
= WorkingDevicePath
;
2262 if (IsBootOptionValidNVVarialbe (Option
)) {
2264 // For a temporary boot (i.e. a boot by selected a EFI Shell using "Boot From File"), Boot Current is actually not valid.
2265 // In this case, "BootCurrent" is not created.
2266 // Only create the BootCurrent variable when it points to a valid Boot#### variable.
2270 &gEfiGlobalVariableGuid
,
2271 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
2273 &Option
->BootCurrent
2278 // Report Status Code to indicate ReadyToBoot event will be signalled
2280 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_SW_DXE_BS_PC_READY_TO_BOOT_EVENT
));
2283 // Signal the EVT_SIGNAL_READY_TO_BOOT event
2285 EfiSignalEventReadyToBoot();
2288 // Expand USB Class or USB WWID device path node to be full device path of a USB
2289 // device in platform then load the boot file on this full device path and get the
2292 ImageHandle
= BdsExpandUsbShortFormDevicePath (DevicePath
);
2295 // Adjust the different type memory page number just before booting
2296 // and save the updated info into the variable for next boot to use
2298 BdsSetMemoryTypeInformationVariable ();
2301 // By expanding the USB Class or WWID device path, the ImageHandle has returnned.
2302 // Here get the ImageHandle for the non USB class or WWID device path.
2304 if (ImageHandle
== NULL
) {
2305 ASSERT (Option
->DevicePath
!= NULL
);
2306 if ((DevicePathType (Option
->DevicePath
) == BBS_DEVICE_PATH
) &&
2307 (DevicePathSubType (Option
->DevicePath
) == BBS_BBS_DP
)
2310 // Check to see if we should legacy BOOT. If yes then do the legacy boot
2312 return BdsLibDoLegacyBoot (Option
);
2316 // If the boot option point to Internal FV shell, make sure it is valid
2318 Status
= BdsLibUpdateFvFileDevicePath (&DevicePath
, PcdGetPtr(PcdShellFile
));
2319 if (!EFI_ERROR(Status
)) {
2320 if (Option
->DevicePath
!= NULL
) {
2321 FreePool(Option
->DevicePath
);
2323 Option
->DevicePath
= AllocateZeroPool (GetDevicePathSize (DevicePath
));
2324 ASSERT(Option
->DevicePath
!= NULL
);
2325 CopyMem (Option
->DevicePath
, DevicePath
, GetDevicePathSize (DevicePath
));
2327 // Update the shell boot option
2329 InitializeListHead (&TempBootLists
);
2330 BdsLibRegisterNewOption (&TempBootLists
, DevicePath
, L
"EFI Internal Shell", L
"BootOrder");
2333 // free the temporary device path created by BdsLibUpdateFvFileDevicePath()
2335 FreePool (DevicePath
);
2336 DevicePath
= Option
->DevicePath
;
2341 if (Option
->Description
== NULL
) {
2342 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Booting from unknown device path\n"));
2344 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Booting %S\n", Option
->Description
));
2350 // Report status code for OS Loader LoadImage.
2352 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, PcdGet32 (PcdProgressCodeOsLoaderLoad
));
2353 Status
= gBS
->LoadImage (
2363 // If we didn't find an image directly, we need to try as if it is a removable device boot option
2364 // and load the image according to the default boot behavior for removable device.
2366 if (EFI_ERROR (Status
)) {
2368 // check if there is a bootable removable media could be found in this device path ,
2369 // and get the bootable media handle
2371 Handle
= BdsLibGetBootableHandle(DevicePath
);
2372 if (Handle
!= NULL
) {
2374 // Load the default boot file \EFI\BOOT\boot{machinename}.EFI from removable Media
2375 // machinename is ia32, ia64, x64, ...
2377 FilePath
= FileDevicePath (Handle
, EFI_REMOVABLE_MEDIA_FILE_NAME
);
2378 if (FilePath
!= NULL
) {
2379 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, PcdGet32 (PcdProgressCodeOsLoaderLoad
));
2380 Status
= gBS
->LoadImage (
2393 // Provide the image with it's load options
2395 if ((ImageHandle
== NULL
) || (EFI_ERROR(Status
))) {
2397 // Report Status Code to indicate that the failure to load boot option
2399 REPORT_STATUS_CODE (
2400 EFI_ERROR_CODE
| EFI_ERROR_MINOR
,
2401 (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_SW_DXE_BS_EC_BOOT_OPTION_LOAD_ERROR
)
2406 Status
= gBS
->HandleProtocol (ImageHandle
, &gEfiLoadedImageProtocolGuid
, (VOID
**) &ImageInfo
);
2407 ASSERT_EFI_ERROR (Status
);
2409 if (Option
->LoadOptionsSize
!= 0) {
2410 ImageInfo
->LoadOptionsSize
= Option
->LoadOptionsSize
;
2411 ImageInfo
->LoadOptions
= Option
->LoadOptions
;
2415 // Clean to NULL because the image is loaded directly from the firmwares boot manager.
2417 ImageInfo
->ParentHandle
= NULL
;
2420 // Before calling the image, enable the Watchdog Timer for
2421 // the 5 Minute period
2423 gBS
->SetWatchdogTimer (5 * 60, 0x0000, 0x00, NULL
);
2426 // Write boot to OS performance data for UEFI boot
2429 WriteBootToOsPerformanceData (NULL
, NULL
);
2433 // Report status code for OS Loader StartImage.
2435 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, PcdGet32 (PcdProgressCodeOsLoaderStart
));
2437 Status
= gBS
->StartImage (ImageHandle
, ExitDataSize
, ExitData
);
2438 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Image Return Status = %r\n", Status
));
2439 if (EFI_ERROR (Status
)) {
2441 // Report Status Code to indicate that boot failure
2443 REPORT_STATUS_CODE (
2444 EFI_ERROR_CODE
| EFI_ERROR_MINOR
,
2445 (EFI_SOFTWARE_DXE_BS_DRIVER
| EFI_SW_DXE_BS_EC_BOOT_OPTION_FAILED
)
2450 // Clear the Watchdog Timer after the image returns
2452 gBS
->SetWatchdogTimer (0x0000, 0x0000, 0x0000, NULL
);
2456 // Set Logo status invalid after trying one boot option
2459 StatusLogo
= gBS
->LocateProtocol (&gEfiBootLogoProtocolGuid
, NULL
, (VOID
**) &BootLogo
);
2460 if (!EFI_ERROR (StatusLogo
) && (BootLogo
!= NULL
)) {
2461 BootLogo
->SetBootLogo (BootLogo
, NULL
, 0, 0, 0, 0);
2465 // Clear Boot Current
2469 &gEfiGlobalVariableGuid
,
2470 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
2472 &Option
->BootCurrent
2480 Expand a device path that starts with a hard drive media device path node to be a
2481 full device path that includes the full hardware path to the device. We need
2482 to do this so it can be booted. As an optimization the front match (the part point
2483 to the partition node. E.g. ACPI() /PCI()/ATA()/Partition() ) is saved in a variable
2484 so a connect all is not required on every boot. All successful history device path
2485 which point to partition node (the front part) will be saved.
2487 @param HardDriveDevicePath EFI Device Path to boot, if it starts with a hard
2488 drive media device path.
2489 @return A Pointer to the full device path or NULL if a valid Hard Drive devic path
2493 EFI_DEVICE_PATH_PROTOCOL
*
2495 BdsExpandPartitionPartialDevicePathToFull (
2496 IN HARDDRIVE_DEVICE_PATH
*HardDriveDevicePath
2500 UINTN BlockIoHandleCount
;
2501 EFI_HANDLE
*BlockIoBuffer
;
2502 EFI_DEVICE_PATH_PROTOCOL
*FullDevicePath
;
2503 EFI_DEVICE_PATH_PROTOCOL
*BlockIoDevicePath
;
2504 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
2507 EFI_DEVICE_PATH_PROTOCOL
*CachedDevicePath
;
2508 EFI_DEVICE_PATH_PROTOCOL
*TempNewDevicePath
;
2509 UINTN CachedDevicePathSize
;
2510 BOOLEAN DeviceExist
;
2512 EFI_DEVICE_PATH_PROTOCOL
*Instance
;
2515 FullDevicePath
= NULL
;
2517 // Check if there is prestore HD_BOOT_DEVICE_PATH_VARIABLE_NAME variable.
2518 // If exist, search the front path which point to partition node in the variable instants.
2519 // If fail to find or HD_BOOT_DEVICE_PATH_VARIABLE_NAME not exist, reconnect all and search in all system
2521 CachedDevicePath
= BdsLibGetVariableAndSize (
2522 HD_BOOT_DEVICE_PATH_VARIABLE_NAME
,
2523 &gHdBootDevicePathVariablGuid
,
2524 &CachedDevicePathSize
2527 if (CachedDevicePath
!= NULL
) {
2528 TempNewDevicePath
= CachedDevicePath
;
2529 DeviceExist
= FALSE
;
2533 // Check every instance of the variable
2534 // First, check whether the instance contain the partition node, which is needed for distinguishing multi
2535 // partial partition boot option. Second, check whether the instance could be connected.
2537 Instance
= GetNextDevicePathInstance (&TempNewDevicePath
, &Size
);
2538 if (MatchPartitionDevicePathNode (Instance
, HardDriveDevicePath
)) {
2540 // Connect the device path instance, the device path point to hard drive media device path node
2541 // e.g. ACPI() /PCI()/ATA()/Partition()
2543 Status
= BdsLibConnectDevicePath (Instance
);
2544 if (!EFI_ERROR (Status
)) {
2550 // Come here means the first instance is not matched
2554 } while (TempNewDevicePath
!= NULL
);
2558 // Find the matched device path.
2559 // Append the file path information from the boot option and return the fully expanded device path.
2561 DevicePath
= NextDevicePathNode ((EFI_DEVICE_PATH_PROTOCOL
*) HardDriveDevicePath
);
2562 FullDevicePath
= AppendDevicePath (Instance
, DevicePath
);
2565 // Adjust the HD_BOOT_DEVICE_PATH_VARIABLE_NAME instances sequence if the matched one is not first one.
2569 // First delete the matched instance.
2571 TempNewDevicePath
= CachedDevicePath
;
2572 CachedDevicePath
= BdsLibDelPartMatchInstance (CachedDevicePath
, Instance
);
2573 FreePool (TempNewDevicePath
);
2576 // Second, append the remaining path after the matched instance
2578 TempNewDevicePath
= CachedDevicePath
;
2579 CachedDevicePath
= AppendDevicePathInstance (Instance
, CachedDevicePath
);
2580 FreePool (TempNewDevicePath
);
2582 // Save the matching Device Path so we don't need to do a connect all next time
2584 Status
= gRT
->SetVariable (
2585 HD_BOOT_DEVICE_PATH_VARIABLE_NAME
,
2586 &gHdBootDevicePathVariablGuid
,
2587 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
2588 GetDevicePathSize (CachedDevicePath
),
2593 FreePool (Instance
);
2594 FreePool (CachedDevicePath
);
2595 return FullDevicePath
;
2600 // If we get here we fail to find or HD_BOOT_DEVICE_PATH_VARIABLE_NAME not exist, and now we need
2601 // to search all devices in the system for a matched partition
2603 BdsLibConnectAllDriversToAllControllers ();
2604 Status
= gBS
->LocateHandleBuffer (ByProtocol
, &gEfiBlockIoProtocolGuid
, NULL
, &BlockIoHandleCount
, &BlockIoBuffer
);
2605 if (EFI_ERROR (Status
) || BlockIoHandleCount
== 0 || BlockIoBuffer
== NULL
) {
2607 // If there was an error or there are no device handles that support
2608 // the BLOCK_IO Protocol, then return.
2613 // Loop through all the device handles that support the BLOCK_IO Protocol
2615 for (Index
= 0; Index
< BlockIoHandleCount
; Index
++) {
2617 Status
= gBS
->HandleProtocol (BlockIoBuffer
[Index
], &gEfiDevicePathProtocolGuid
, (VOID
*) &BlockIoDevicePath
);
2618 if (EFI_ERROR (Status
) || BlockIoDevicePath
== NULL
) {
2622 if (MatchPartitionDevicePathNode (BlockIoDevicePath
, HardDriveDevicePath
)) {
2624 // Find the matched partition device path
2626 DevicePath
= NextDevicePathNode ((EFI_DEVICE_PATH_PROTOCOL
*) HardDriveDevicePath
);
2627 FullDevicePath
= AppendDevicePath (BlockIoDevicePath
, DevicePath
);
2630 // Save the matched partition device path in HD_BOOT_DEVICE_PATH_VARIABLE_NAME variable
2632 if (CachedDevicePath
!= NULL
) {
2634 // Save the matched partition device path as first instance of HD_BOOT_DEVICE_PATH_VARIABLE_NAME variable
2636 if (BdsLibMatchDevicePaths (CachedDevicePath
, BlockIoDevicePath
)) {
2637 TempNewDevicePath
= CachedDevicePath
;
2638 CachedDevicePath
= BdsLibDelPartMatchInstance (CachedDevicePath
, BlockIoDevicePath
);
2639 FreePool(TempNewDevicePath
);
2642 if (CachedDevicePath
!= NULL
) {
2643 TempNewDevicePath
= CachedDevicePath
;
2644 CachedDevicePath
= AppendDevicePathInstance (BlockIoDevicePath
, CachedDevicePath
);
2645 FreePool(TempNewDevicePath
);
2647 CachedDevicePath
= DuplicateDevicePath (BlockIoDevicePath
);
2651 // Here limit the device path instance number to 12, which is max number for a system support 3 IDE controller
2652 // If the user try to boot many OS in different HDs or partitions, in theory,
2653 // the HD_BOOT_DEVICE_PATH_VARIABLE_NAME variable maybe become larger and larger.
2656 ASSERT (CachedDevicePath
!= NULL
);
2657 TempNewDevicePath
= CachedDevicePath
;
2658 while (!IsDevicePathEnd (TempNewDevicePath
)) {
2659 TempNewDevicePath
= NextDevicePathNode (TempNewDevicePath
);
2661 // Parse one instance
2663 while (!IsDevicePathEndType (TempNewDevicePath
)) {
2664 TempNewDevicePath
= NextDevicePathNode (TempNewDevicePath
);
2668 // If the CachedDevicePath variable contain too much instance, only remain 12 instances.
2670 if (InstanceNum
>= 12) {
2671 SetDevicePathEndNode (TempNewDevicePath
);
2676 CachedDevicePath
= DuplicateDevicePath (BlockIoDevicePath
);
2680 // Save the matching Device Path so we don't need to do a connect all next time
2682 Status
= gRT
->SetVariable (
2683 HD_BOOT_DEVICE_PATH_VARIABLE_NAME
,
2684 &gHdBootDevicePathVariablGuid
,
2685 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
2686 GetDevicePathSize (CachedDevicePath
),
2694 if (CachedDevicePath
!= NULL
) {
2695 FreePool (CachedDevicePath
);
2697 if (BlockIoBuffer
!= NULL
) {
2698 FreePool (BlockIoBuffer
);
2700 return FullDevicePath
;
2704 Check whether there is a instance in BlockIoDevicePath, which contain multi device path
2705 instances, has the same partition node with HardDriveDevicePath device path
2707 @param BlockIoDevicePath Multi device path instances which need to check
2708 @param HardDriveDevicePath A device path which starts with a hard drive media
2711 @retval TRUE There is a matched device path instance.
2712 @retval FALSE There is no matched device path instance.
2717 MatchPartitionDevicePathNode (
2718 IN EFI_DEVICE_PATH_PROTOCOL
*BlockIoDevicePath
,
2719 IN HARDDRIVE_DEVICE_PATH
*HardDriveDevicePath
2722 HARDDRIVE_DEVICE_PATH
*TmpHdPath
;
2723 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
2725 EFI_DEVICE_PATH_PROTOCOL
*BlockIoHdDevicePathNode
;
2727 if ((BlockIoDevicePath
== NULL
) || (HardDriveDevicePath
== NULL
)) {
2732 // Make PreviousDevicePath == the device path node before the end node
2734 DevicePath
= BlockIoDevicePath
;
2735 BlockIoHdDevicePathNode
= NULL
;
2738 // find the partition device path node
2740 while (!IsDevicePathEnd (DevicePath
)) {
2741 if ((DevicePathType (DevicePath
) == MEDIA_DEVICE_PATH
) &&
2742 (DevicePathSubType (DevicePath
) == MEDIA_HARDDRIVE_DP
)
2744 BlockIoHdDevicePathNode
= DevicePath
;
2748 DevicePath
= NextDevicePathNode (DevicePath
);
2751 if (BlockIoHdDevicePathNode
== NULL
) {
2755 // See if the harddrive device path in blockio matches the orig Hard Drive Node
2757 TmpHdPath
= (HARDDRIVE_DEVICE_PATH
*) BlockIoHdDevicePathNode
;
2761 // Check for the match
2763 if ((TmpHdPath
->MBRType
== HardDriveDevicePath
->MBRType
) &&
2764 (TmpHdPath
->SignatureType
== HardDriveDevicePath
->SignatureType
)) {
2765 switch (TmpHdPath
->SignatureType
) {
2766 case SIGNATURE_TYPE_GUID
:
2767 Match
= CompareGuid ((EFI_GUID
*)TmpHdPath
->Signature
, (EFI_GUID
*)HardDriveDevicePath
->Signature
);
2769 case SIGNATURE_TYPE_MBR
:
2770 Match
= (BOOLEAN
)(*((UINT32
*)(&(TmpHdPath
->Signature
[0]))) == ReadUnaligned32((UINT32
*)(&(HardDriveDevicePath
->Signature
[0]))));
2782 Delete the boot option associated with the handle passed in.
2784 @param Handle The handle which present the device path to create
2787 @retval EFI_SUCCESS Delete the boot option success
2788 @retval EFI_NOT_FOUND If the Device Path is not found in the system
2789 @retval EFI_OUT_OF_RESOURCES Lack of memory resource
2790 @retval Other Error return value from SetVariable()
2794 BdsLibDeleteOptionFromHandle (
2795 IN EFI_HANDLE Handle
2799 UINT8
*BootOptionVar
;
2800 UINTN BootOrderSize
;
2801 UINTN BootOptionSize
;
2804 UINT16 BootOption
[BOOT_OPTION_MAX_CHAR
];
2805 UINTN DevicePathSize
;
2806 UINTN OptionDevicePathSize
;
2807 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
2808 EFI_DEVICE_PATH_PROTOCOL
*OptionDevicePath
;
2811 Status
= EFI_SUCCESS
;
2816 // Check "BootOrder" variable, if no, means there is no any boot order.
2818 BootOrder
= BdsLibGetVariableAndSize (
2820 &gEfiGlobalVariableGuid
,
2823 if (BootOrder
== NULL
) {
2824 return EFI_NOT_FOUND
;
2828 // Convert device handle to device path protocol instance
2830 DevicePath
= DevicePathFromHandle (Handle
);
2831 if (DevicePath
== NULL
) {
2832 return EFI_NOT_FOUND
;
2834 DevicePathSize
= GetDevicePathSize (DevicePath
);
2837 // Loop all boot order variable and find the matching device path
2840 while (Index
< BootOrderSize
/ sizeof (UINT16
)) {
2841 UnicodeSPrint (BootOption
, sizeof (BootOption
), L
"Boot%04x", BootOrder
[Index
]);
2842 BootOptionVar
= BdsLibGetVariableAndSize (
2844 &gEfiGlobalVariableGuid
,
2848 if (BootOptionVar
== NULL
) {
2849 FreePool (BootOrder
);
2850 return EFI_OUT_OF_RESOURCES
;
2853 if (!ValidateOption(BootOptionVar
, BootOptionSize
)) {
2854 BdsDeleteBootOption (BootOrder
[Index
], BootOrder
, &BootOrderSize
);
2855 FreePool (BootOptionVar
);
2860 TempPtr
= BootOptionVar
;
2861 TempPtr
+= sizeof (UINT32
) + sizeof (UINT16
);
2862 TempPtr
+= StrSize ((CHAR16
*) TempPtr
);
2863 OptionDevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) TempPtr
;
2864 OptionDevicePathSize
= GetDevicePathSize (OptionDevicePath
);
2867 // Check whether the device path match
2869 if ((OptionDevicePathSize
== DevicePathSize
) &&
2870 (CompareMem (DevicePath
, OptionDevicePath
, DevicePathSize
) == 0)) {
2871 BdsDeleteBootOption (BootOrder
[Index
], BootOrder
, &BootOrderSize
);
2872 FreePool (BootOptionVar
);
2876 FreePool (BootOptionVar
);
2881 // Adjust number of boot option for "BootOrder" variable.
2883 Status
= gRT
->SetVariable (
2885 &gEfiGlobalVariableGuid
,
2886 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
2891 FreePool (BootOrder
);
2898 Delete all invalid EFI boot options.
2900 @retval EFI_SUCCESS Delete all invalid boot option success
2901 @retval EFI_NOT_FOUND Variable "BootOrder" is not found
2902 @retval EFI_OUT_OF_RESOURCES Lack of memory resource
2903 @retval Other Error return value from SetVariable()
2907 BdsDeleteAllInvalidEfiBootOption (
2912 UINT8
*BootOptionVar
;
2913 UINTN BootOrderSize
;
2914 UINTN BootOptionSize
;
2918 UINT16 BootOption
[BOOT_OPTION_MAX_CHAR
];
2919 EFI_DEVICE_PATH_PROTOCOL
*OptionDevicePath
;
2921 CHAR16
*Description
;
2924 Status
= EFI_SUCCESS
;
2927 OptionDevicePath
= NULL
;
2932 // Check "BootOrder" variable firstly, this variable hold the number of boot options
2934 BootOrder
= BdsLibGetVariableAndSize (
2936 &gEfiGlobalVariableGuid
,
2939 if (NULL
== BootOrder
) {
2940 return EFI_NOT_FOUND
;
2944 while (Index
< BootOrderSize
/ sizeof (UINT16
)) {
2945 UnicodeSPrint (BootOption
, sizeof (BootOption
), L
"Boot%04x", BootOrder
[Index
]);
2946 BootOptionVar
= BdsLibGetVariableAndSize (
2948 &gEfiGlobalVariableGuid
,
2951 if (NULL
== BootOptionVar
) {
2952 FreePool (BootOrder
);
2953 return EFI_OUT_OF_RESOURCES
;
2956 if (!ValidateOption(BootOptionVar
, BootOptionSize
)) {
2959 TempPtr
= BootOptionVar
;
2960 TempPtr
+= sizeof (UINT32
) + sizeof (UINT16
);
2961 Description
= (CHAR16
*) TempPtr
;
2962 TempPtr
+= StrSize ((CHAR16
*) TempPtr
);
2963 OptionDevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) TempPtr
;
2966 // Skip legacy boot option (BBS boot device)
2968 if ((DevicePathType (OptionDevicePath
) == BBS_DEVICE_PATH
) &&
2969 (DevicePathSubType (OptionDevicePath
) == BBS_BBS_DP
)) {
2970 FreePool (BootOptionVar
);
2976 if (Corrupted
|| !BdsLibIsValidEFIBootOptDevicePathExt (OptionDevicePath
, FALSE
, Description
)) {
2978 // Delete this invalid boot option "Boot####"
2980 Status
= gRT
->SetVariable (
2982 &gEfiGlobalVariableGuid
,
2983 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
2988 // Mark this boot option in boot order as deleted
2990 BootOrder
[Index
] = 0xffff;
2994 FreePool (BootOptionVar
);
2999 // Adjust boot order array
3002 for (Index
= 0; Index
< BootOrderSize
/ sizeof (UINT16
); Index
++) {
3003 if (BootOrder
[Index
] != 0xffff) {
3004 BootOrder
[Index2
] = BootOrder
[Index
];
3008 Status
= gRT
->SetVariable (
3010 &gEfiGlobalVariableGuid
,
3011 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
3012 Index2
* sizeof (UINT16
),
3016 FreePool (BootOrder
);
3023 For EFI boot option, BDS separate them as six types:
3024 1. Network - The boot option points to the SimpleNetworkProtocol device.
3025 Bds will try to automatically create this type boot option when enumerate.
3026 2. Shell - The boot option points to internal flash shell.
3027 Bds will try to automatically create this type boot option when enumerate.
3028 3. Removable BlockIo - The boot option only points to the removable media
3029 device, like USB flash disk, DVD, Floppy etc.
3030 These device should contain a *removable* blockIo
3031 protocol in their device handle.
3032 Bds will try to automatically create this type boot option
3034 4. Fixed BlockIo - The boot option only points to a Fixed blockIo device,
3036 These device should contain a *fixed* blockIo
3037 protocol in their device handle.
3038 BDS will skip fixed blockIo devices, and NOT
3039 automatically create boot option for them. But BDS
3040 will help to delete those fixed blockIo boot option,
3041 whose description rule conflict with other auto-created
3043 5. Non-BlockIo Simplefile - The boot option points to a device whose handle
3044 has SimpleFileSystem Protocol, but has no blockio
3045 protocol. These devices do not offer blockIo
3046 protocol, but BDS still can get the
3047 \EFI\BOOT\boot{machinename}.EFI by SimpleFileSystem
3049 6. File - The boot option points to a file. These boot options are usually
3050 created by user manually or OS loader. BDS will not delete or modify
3053 This function will enumerate all possible boot device in the system, and
3054 automatically create boot options for Network, Shell, Removable BlockIo,
3055 and Non-BlockIo Simplefile devices.
3056 It will only execute once of every boot.
3058 @param BdsBootOptionList The header of the link list which indexed all
3059 current boot options
3061 @retval EFI_SUCCESS Finished all the boot device enumerate and create
3062 the boot option base on that boot device
3064 @retval EFI_OUT_OF_RESOURCES Failed to enumerate the boot device and create the boot option list
3068 BdsLibEnumerateAllBootOption (
3069 IN OUT LIST_ENTRY
*BdsBootOptionList
3073 UINT16 FloppyNumber
;
3074 UINT16 HarddriveNumber
;
3079 UINT16 NonBlockNumber
;
3080 UINTN NumberBlockIoHandles
;
3081 EFI_HANDLE
*BlockIoHandles
;
3082 EFI_BLOCK_IO_PROTOCOL
*BlkIo
;
3083 BOOLEAN Removable
[2];
3084 UINTN RemovableIndex
;
3086 UINTN NumOfLoadFileHandles
;
3087 EFI_HANDLE
*LoadFileHandles
;
3088 UINTN FvHandleCount
;
3089 EFI_HANDLE
*FvHandleBuffer
;
3090 EFI_FV_FILETYPE Type
;
3092 EFI_FV_FILE_ATTRIBUTES Attributes
;
3093 UINT32 AuthenticationStatus
;
3094 EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
;
3095 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
3096 UINTN DevicePathType
;
3098 EFI_HANDLE
*FileSystemHandles
;
3099 UINTN NumberFileSystemHandles
;
3101 EFI_IMAGE_DOS_HEADER DosHeader
;
3104 EFI_IMAGE_OPTIONAL_HEADER_UNION HdrData
;
3105 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
;
3108 HarddriveNumber
= 0;
3115 ZeroMem (Buffer
, sizeof (Buffer
));
3118 // If the boot device enumerate happened, just get the boot
3119 // device from the boot order variable
3121 if (mEnumBootDevice
) {
3122 GetVariable2 (LAST_ENUM_LANGUAGE_VARIABLE_NAME
, &gLastEnumLangGuid
, (VOID
**)&LastLang
, NULL
);
3123 GetEfiGlobalVariable2 (L
"PlatformLang", (VOID
**)&PlatLang
, NULL
);
3124 ASSERT (PlatLang
!= NULL
);
3125 if ((LastLang
!= NULL
) && (AsciiStrCmp (LastLang
, PlatLang
) == 0)) {
3126 Status
= BdsLibBuildOptionFromVar (BdsBootOptionList
, L
"BootOrder");
3127 FreePool (LastLang
);
3128 FreePool (PlatLang
);
3131 Status
= gRT
->SetVariable (
3132 LAST_ENUM_LANGUAGE_VARIABLE_NAME
,
3134 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
3135 AsciiStrSize (PlatLang
),
3138 ASSERT_EFI_ERROR (Status
);
3140 if (LastLang
!= NULL
) {
3141 FreePool (LastLang
);
3143 FreePool (PlatLang
);
3148 // Notes: this dirty code is to get the legacy boot option from the
3149 // BBS table and create to variable as the EFI boot option, it should
3150 // be removed after the CSM can provide legacy boot option directly
3152 REFRESH_LEGACY_BOOT_OPTIONS
;
3155 // Delete invalid boot option
3157 BdsDeleteAllInvalidEfiBootOption ();
3160 // Parse removable media followed by fixed media.
3161 // The Removable[] array is used by the for-loop below to create removable media boot options
3162 // at first, and then to create fixed media boot options.
3164 Removable
[0] = FALSE
;
3165 Removable
[1] = TRUE
;
3167 gBS
->LocateHandleBuffer (
3169 &gEfiBlockIoProtocolGuid
,
3171 &NumberBlockIoHandles
,
3175 for (RemovableIndex
= 0; RemovableIndex
< 2; RemovableIndex
++) {
3176 for (Index
= 0; Index
< NumberBlockIoHandles
; Index
++) {
3177 Status
= gBS
->HandleProtocol (
3178 BlockIoHandles
[Index
],
3179 &gEfiBlockIoProtocolGuid
,
3183 // skip the fixed block io then the removable block io
3185 if (EFI_ERROR (Status
) || (BlkIo
->Media
->RemovableMedia
== Removable
[RemovableIndex
])) {
3188 DevicePath
= DevicePathFromHandle (BlockIoHandles
[Index
]);
3189 DevicePathType
= BdsGetBootTypeFromDevicePath (DevicePath
);
3191 switch (DevicePathType
) {
3192 case BDS_EFI_ACPI_FLOPPY_BOOT
:
3193 if (FloppyNumber
!= 0) {
3194 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_FLOPPY
)), FloppyNumber
);
3196 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_FLOPPY
)));
3198 BdsLibBuildOptionFromHandle (BlockIoHandles
[Index
], BdsBootOptionList
, Buffer
);
3203 // Assume a removable SATA device should be the DVD/CD device, a fixed SATA device should be the Hard Drive device.
3205 case BDS_EFI_MESSAGE_ATAPI_BOOT
:
3206 case BDS_EFI_MESSAGE_SATA_BOOT
:
3207 if (BlkIo
->Media
->RemovableMedia
) {
3208 if (CdromNumber
!= 0) {
3209 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_CD_DVD
)), CdromNumber
);
3211 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_CD_DVD
)));
3215 if (HarddriveNumber
!= 0) {
3216 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_HARDDRIVE
)), HarddriveNumber
);
3218 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_HARDDRIVE
)));
3222 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Buffer: %S\n", Buffer
));
3223 BdsLibBuildOptionFromHandle (BlockIoHandles
[Index
], BdsBootOptionList
, Buffer
);
3226 case BDS_EFI_MESSAGE_USB_DEVICE_BOOT
:
3227 if (UsbNumber
!= 0) {
3228 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_USB
)), UsbNumber
);
3230 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_USB
)));
3232 BdsLibBuildOptionFromHandle (BlockIoHandles
[Index
], BdsBootOptionList
, Buffer
);
3236 case BDS_EFI_MESSAGE_SCSI_BOOT
:
3237 if (ScsiNumber
!= 0) {
3238 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_SCSI
)), ScsiNumber
);
3240 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_SCSI
)));
3242 BdsLibBuildOptionFromHandle (BlockIoHandles
[Index
], BdsBootOptionList
, Buffer
);
3246 case BDS_EFI_MESSAGE_MISC_BOOT
:
3247 if (MiscNumber
!= 0) {
3248 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_MISC
)), MiscNumber
);
3250 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_MISC
)));
3252 BdsLibBuildOptionFromHandle (BlockIoHandles
[Index
], BdsBootOptionList
, Buffer
);
3262 if (NumberBlockIoHandles
!= 0) {
3263 FreePool (BlockIoHandles
);
3267 // If there is simple file protocol which does not consume block Io protocol, create a boot option for it here.
3270 gBS
->LocateHandleBuffer (
3272 &gEfiSimpleFileSystemProtocolGuid
,
3274 &NumberFileSystemHandles
,
3277 for (Index
= 0; Index
< NumberFileSystemHandles
; Index
++) {
3278 Status
= gBS
->HandleProtocol (
3279 FileSystemHandles
[Index
],
3280 &gEfiBlockIoProtocolGuid
,
3283 if (!EFI_ERROR (Status
)) {
3285 // Skip if the file system handle supports a BlkIo protocol,
3291 // Do the removable Media thing. \EFI\BOOT\boot{machinename}.EFI
3292 // machinename is ia32, ia64, x64, ...
3294 Hdr
.Union
= &HdrData
;
3296 Status
= BdsLibGetImageHeader (
3297 FileSystemHandles
[Index
],
3298 EFI_REMOVABLE_MEDIA_FILE_NAME
,
3302 if (!EFI_ERROR (Status
) &&
3303 EFI_IMAGE_MACHINE_TYPE_SUPPORTED (Hdr
.Pe32
->FileHeader
.Machine
) &&
3304 Hdr
.Pe32
->OptionalHeader
.Subsystem
== EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION
) {
3310 // No such file or the file is not a EFI application, delete this boot option
3312 BdsLibDeleteOptionFromHandle (FileSystemHandles
[Index
]);
3314 if (NonBlockNumber
!= 0) {
3315 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NON_BLOCK
)), NonBlockNumber
);
3317 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NON_BLOCK
)));
3319 BdsLibBuildOptionFromHandle (FileSystemHandles
[Index
], BdsBootOptionList
, Buffer
);
3324 if (NumberFileSystemHandles
!= 0) {
3325 FreePool (FileSystemHandles
);
3329 // Parse Network Boot Device
3331 NumOfLoadFileHandles
= 0;
3333 // Search Load File protocol for PXE boot option.
3335 gBS
->LocateHandleBuffer (
3337 &gEfiLoadFileProtocolGuid
,
3339 &NumOfLoadFileHandles
,
3343 for (Index
= 0; Index
< NumOfLoadFileHandles
; Index
++) {
3345 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NETWORK
)), Index
);
3347 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NETWORK
)));
3349 BdsLibBuildOptionFromHandle (LoadFileHandles
[Index
], BdsBootOptionList
, Buffer
);
3352 if (NumOfLoadFileHandles
!= 0) {
3353 FreePool (LoadFileHandles
);
3357 // Check if we have on flash shell
3359 gBS
->LocateHandleBuffer (
3361 &gEfiFirmwareVolume2ProtocolGuid
,
3366 for (Index
= 0; Index
< FvHandleCount
; Index
++) {
3367 gBS
->HandleProtocol (
3368 FvHandleBuffer
[Index
],
3369 &gEfiFirmwareVolume2ProtocolGuid
,
3373 Status
= Fv
->ReadFile (
3375 PcdGetPtr(PcdShellFile
),
3380 &AuthenticationStatus
3382 if (EFI_ERROR (Status
)) {
3384 // Skip if no shell file in the FV
3389 // Build the shell boot option
3391 BdsLibBuildOptionFromShell (FvHandleBuffer
[Index
], BdsBootOptionList
);
3394 if (FvHandleCount
!= 0) {
3395 FreePool (FvHandleBuffer
);
3398 // Make sure every boot only have one time
3399 // boot device enumerate
3401 Status
= BdsLibBuildOptionFromVar (BdsBootOptionList
, L
"BootOrder");
3402 mEnumBootDevice
= TRUE
;
3408 Build the boot option with the handle parsed in
3410 @param Handle The handle which present the device path to create
3412 @param BdsBootOptionList The header of the link list which indexed all
3413 current boot options
3414 @param String The description of the boot option.
3419 BdsLibBuildOptionFromHandle (
3420 IN EFI_HANDLE Handle
,
3421 IN LIST_ENTRY
*BdsBootOptionList
,
3425 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
3427 DevicePath
= DevicePathFromHandle (Handle
);
3430 // Create and register new boot option
3432 BdsLibRegisterNewOption (BdsBootOptionList
, DevicePath
, String
, L
"BootOrder");
3437 Build the on flash shell boot option with the handle parsed in.
3439 @param Handle The handle which present the device path to create
3440 on flash shell boot option
3441 @param BdsBootOptionList The header of the link list which indexed all
3442 current boot options
3447 BdsLibBuildOptionFromShell (
3448 IN EFI_HANDLE Handle
,
3449 IN OUT LIST_ENTRY
*BdsBootOptionList
3452 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
3453 MEDIA_FW_VOL_FILEPATH_DEVICE_PATH ShellNode
;
3455 DevicePath
= DevicePathFromHandle (Handle
);
3458 // Build the shell device path
3460 EfiInitializeFwVolDevicepathNode (&ShellNode
, PcdGetPtr(PcdShellFile
));
3462 DevicePath
= AppendDevicePathNode (DevicePath
, (EFI_DEVICE_PATH_PROTOCOL
*) &ShellNode
);
3465 // Create and register the shell boot option
3467 BdsLibRegisterNewOption (BdsBootOptionList
, DevicePath
, L
"EFI Internal Shell", L
"BootOrder");
3472 Boot from the UEFI spec defined "BootNext" variable.
3484 BDS_COMMON_OPTION
*BootOption
;
3485 LIST_ENTRY TempList
;
3490 // Init the boot option name buffer and temp link list
3492 InitializeListHead (&TempList
);
3493 ZeroMem (Buffer
, sizeof (Buffer
));
3495 BootNext
= BdsLibGetVariableAndSize (
3497 &gEfiGlobalVariableGuid
,
3502 // Clear the boot next variable first
3504 if (BootNext
!= NULL
) {
3507 &gEfiGlobalVariableGuid
,
3508 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
3514 // Start to build the boot option and try to boot
3516 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"Boot%04x", *BootNext
);
3517 BootOption
= BdsLibVariableToOption (&TempList
, Buffer
);
3518 ASSERT (BootOption
!= NULL
);
3519 BdsLibConnectDevicePath (BootOption
->DevicePath
);
3520 BdsLibBootViaBootOption (BootOption
, BootOption
->DevicePath
, &ExitDataSize
, &ExitData
);
3526 Return the bootable media handle.
3527 First, check the device is connected
3528 Second, check whether the device path point to a device which support SimpleFileSystemProtocol,
3529 Third, detect the the default boot file in the Media, and return the removable Media handle.
3531 @param DevicePath Device Path to a bootable device
3533 @return The bootable media handle. If the media on the DevicePath is not bootable, NULL will return.
3538 BdsLibGetBootableHandle (
3539 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
3544 EFI_DEVICE_PATH_PROTOCOL
*UpdatedDevicePath
;
3545 EFI_DEVICE_PATH_PROTOCOL
*DupDevicePath
;
3547 EFI_BLOCK_IO_PROTOCOL
*BlockIo
;
3549 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
3552 EFI_HANDLE ReturnHandle
;
3553 EFI_HANDLE
*SimpleFileSystemHandles
;
3555 UINTN NumberSimpleFileSystemHandles
;
3557 EFI_IMAGE_DOS_HEADER DosHeader
;
3558 EFI_IMAGE_OPTIONAL_HEADER_UNION HdrData
;
3559 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
;
3561 UpdatedDevicePath
= DevicePath
;
3564 // Enter to critical section to protect the acquired BlockIo instance
3565 // from getting released due to the USB mass storage hotplug event
3567 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
3570 // Check whether the device is connected
3572 Status
= gBS
->LocateDevicePath (&gEfiBlockIoProtocolGuid
, &UpdatedDevicePath
, &Handle
);
3573 if (EFI_ERROR (Status
)) {
3575 // Skip the case that the boot option point to a simple file protocol which does not consume block Io protocol,
3577 Status
= gBS
->LocateDevicePath (&gEfiSimpleFileSystemProtocolGuid
, &UpdatedDevicePath
, &Handle
);
3578 if (EFI_ERROR (Status
)) {
3580 // Fail to find the proper BlockIo and simple file protocol, maybe because device not present, we need to connect it firstly
3582 UpdatedDevicePath
= DevicePath
;
3583 Status
= gBS
->LocateDevicePath (&gEfiDevicePathProtocolGuid
, &UpdatedDevicePath
, &Handle
);
3584 gBS
->ConnectController (Handle
, NULL
, NULL
, TRUE
);
3588 // For removable device boot option, its contained device path only point to the removable device handle,
3589 // should make sure all its children handles (its child partion or media handles) are created and connected.
3591 gBS
->ConnectController (Handle
, NULL
, NULL
, TRUE
);
3593 // Get BlockIo protocol and check removable attribute
3595 Status
= gBS
->HandleProtocol (Handle
, &gEfiBlockIoProtocolGuid
, (VOID
**)&BlockIo
);
3596 ASSERT_EFI_ERROR (Status
);
3599 // Issue a dummy read to the device to check for media change.
3600 // When the removable media is changed, any Block IO read/write will
3601 // cause the BlockIo protocol be reinstalled and EFI_MEDIA_CHANGED is
3602 // returned. After the Block IO protocol is reinstalled, subsequent
3603 // Block IO read/write will success.
3605 Buffer
= AllocatePool (BlockIo
->Media
->BlockSize
);
3606 if (Buffer
!= NULL
) {
3607 BlockIo
->ReadBlocks (
3609 BlockIo
->Media
->MediaId
,
3611 BlockIo
->Media
->BlockSize
,
3619 // Detect the the default boot file from removable Media
3623 // 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
3624 // Try to locate the USB node device path first, if fail then use its previous PCI node to search
3626 DupDevicePath
= DuplicateDevicePath (DevicePath
);
3627 ASSERT (DupDevicePath
!= NULL
);
3629 UpdatedDevicePath
= DupDevicePath
;
3630 Status
= gBS
->LocateDevicePath (&gEfiDevicePathProtocolGuid
, &UpdatedDevicePath
, &Handle
);
3632 // 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
3633 // Acpi()/Pci()/Usb() --> Acpi()/Pci()
3635 if ((DevicePathType (UpdatedDevicePath
) == MESSAGING_DEVICE_PATH
) &&
3636 (DevicePathSubType (UpdatedDevicePath
) == MSG_USB_DP
)) {
3638 // Remove the usb node, let the device path only point to PCI node
3640 SetDevicePathEndNode (UpdatedDevicePath
);
3641 UpdatedDevicePath
= DupDevicePath
;
3643 UpdatedDevicePath
= DevicePath
;
3647 // Get the device path size of boot option
3649 Size
= GetDevicePathSize(UpdatedDevicePath
) - sizeof (EFI_DEVICE_PATH_PROTOCOL
); // minus the end node
3650 ReturnHandle
= NULL
;
3651 gBS
->LocateHandleBuffer (
3653 &gEfiSimpleFileSystemProtocolGuid
,
3655 &NumberSimpleFileSystemHandles
,
3656 &SimpleFileSystemHandles
3658 for (Index
= 0; Index
< NumberSimpleFileSystemHandles
; Index
++) {
3660 // Get the device path size of SimpleFileSystem handle
3662 TempDevicePath
= DevicePathFromHandle (SimpleFileSystemHandles
[Index
]);
3663 TempSize
= GetDevicePathSize (TempDevicePath
)- sizeof (EFI_DEVICE_PATH_PROTOCOL
); // minus the end node
3665 // Check whether the device path of boot option is part of the SimpleFileSystem handle's device path
3667 if (Size
<= TempSize
&& CompareMem (TempDevicePath
, UpdatedDevicePath
, Size
)==0) {
3669 // Load the default boot file \EFI\BOOT\boot{machinename}.EFI from removable Media
3670 // machinename is ia32, ia64, x64, ...
3672 Hdr
.Union
= &HdrData
;
3673 Status
= BdsLibGetImageHeader (
3674 SimpleFileSystemHandles
[Index
],
3675 EFI_REMOVABLE_MEDIA_FILE_NAME
,
3679 if (!EFI_ERROR (Status
) &&
3680 EFI_IMAGE_MACHINE_TYPE_SUPPORTED (Hdr
.Pe32
->FileHeader
.Machine
) &&
3681 Hdr
.Pe32
->OptionalHeader
.Subsystem
== EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION
) {
3682 ReturnHandle
= SimpleFileSystemHandles
[Index
];
3688 FreePool(DupDevicePath
);
3690 if (SimpleFileSystemHandles
!= NULL
) {
3691 FreePool(SimpleFileSystemHandles
);
3694 gBS
->RestoreTPL (OldTpl
);
3696 return ReturnHandle
;
3700 Check to see if the network cable is plugged in. If the DevicePath is not
3701 connected it will be connected.
3703 @param DevicePath Device Path to check
3705 @retval TRUE DevicePath points to an Network that is connected
3706 @retval FALSE DevicePath does not point to a bootable network
3710 BdsLibNetworkBootWithMediaPresent (
3711 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
3715 EFI_DEVICE_PATH_PROTOCOL
*UpdatedDevicePath
;
3717 EFI_SIMPLE_NETWORK_PROTOCOL
*Snp
;
3718 BOOLEAN MediaPresent
;
3719 UINT32 InterruptStatus
;
3721 MediaPresent
= FALSE
;
3723 UpdatedDevicePath
= DevicePath
;
3725 // Locate Load File Protocol for PXE boot option first
3727 Status
= gBS
->LocateDevicePath (&gEfiLoadFileProtocolGuid
, &UpdatedDevicePath
, &Handle
);
3728 if (EFI_ERROR (Status
)) {
3730 // Device not present so see if we need to connect it
3732 Status
= BdsLibConnectDevicePath (DevicePath
);
3733 if (!EFI_ERROR (Status
)) {
3735 // This one should work after we did the connect
3737 Status
= gBS
->LocateDevicePath (&gEfiLoadFileProtocolGuid
, &UpdatedDevicePath
, &Handle
);
3741 if (!EFI_ERROR (Status
)) {
3742 Status
= gBS
->HandleProtocol (Handle
, &gEfiSimpleNetworkProtocolGuid
, (VOID
**)&Snp
);
3743 if (EFI_ERROR (Status
)) {
3745 // Failed to open SNP from this handle, try to get SNP from parent handle
3747 UpdatedDevicePath
= DevicePathFromHandle (Handle
);
3748 if (UpdatedDevicePath
!= NULL
) {
3749 Status
= gBS
->LocateDevicePath (&gEfiSimpleNetworkProtocolGuid
, &UpdatedDevicePath
, &Handle
);
3750 if (!EFI_ERROR (Status
)) {
3752 // SNP handle found, get SNP from it
3754 Status
= gBS
->HandleProtocol (Handle
, &gEfiSimpleNetworkProtocolGuid
, (VOID
**) &Snp
);
3759 if (!EFI_ERROR (Status
)) {
3760 if (Snp
->Mode
->MediaPresentSupported
) {
3761 if (Snp
->Mode
->State
== EfiSimpleNetworkInitialized
) {
3763 // Invoke Snp->GetStatus() to refresh the media status
3765 Snp
->GetStatus (Snp
, &InterruptStatus
, NULL
);
3768 // In case some one else is using the SNP check to see if it's connected
3770 MediaPresent
= Snp
->Mode
->MediaPresent
;
3773 // No one is using SNP so we need to Start and Initialize so
3774 // MediaPresent will be valid.
3776 Status
= Snp
->Start (Snp
);
3777 if (!EFI_ERROR (Status
)) {
3778 Status
= Snp
->Initialize (Snp
, 0, 0);
3779 if (!EFI_ERROR (Status
)) {
3780 MediaPresent
= Snp
->Mode
->MediaPresent
;
3781 Snp
->Shutdown (Snp
);
3787 MediaPresent
= TRUE
;
3792 return MediaPresent
;
3796 For a bootable Device path, return its boot type.
3798 @param DevicePath The bootable device Path to check
3800 @retval BDS_EFI_MEDIA_HD_BOOT If given device path contains MEDIA_DEVICE_PATH type device path node
3801 which subtype is MEDIA_HARDDRIVE_DP
3802 @retval BDS_EFI_MEDIA_CDROM_BOOT If given device path contains MEDIA_DEVICE_PATH type device path node
3803 which subtype is MEDIA_CDROM_DP
3804 @retval BDS_EFI_ACPI_FLOPPY_BOOT If given device path contains ACPI_DEVICE_PATH type device path node
3805 which HID is floppy device.
3806 @retval BDS_EFI_MESSAGE_ATAPI_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node
3807 and its last device path node's subtype is MSG_ATAPI_DP.
3808 @retval BDS_EFI_MESSAGE_SCSI_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node
3809 and its last device path node's subtype is MSG_SCSI_DP.
3810 @retval BDS_EFI_MESSAGE_USB_DEVICE_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node
3811 and its last device path node's subtype is MSG_USB_DP.
3812 @retval BDS_EFI_MESSAGE_MISC_BOOT If the device path not contains any media device path node, and
3813 its last device path node point to a message device path node.
3814 @retval BDS_LEGACY_BBS_BOOT If given device path contains BBS_DEVICE_PATH type device path node.
3815 @retval BDS_EFI_UNSUPPORT An EFI Removable BlockIO device path not point to a media and message device,
3820 BdsGetBootTypeFromDevicePath (
3821 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
3824 ACPI_HID_DEVICE_PATH
*Acpi
;
3825 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
3826 EFI_DEVICE_PATH_PROTOCOL
*LastDeviceNode
;
3829 if (NULL
== DevicePath
) {
3830 return BDS_EFI_UNSUPPORT
;
3833 TempDevicePath
= DevicePath
;
3835 while (!IsDevicePathEndType (TempDevicePath
)) {
3836 switch (DevicePathType (TempDevicePath
)) {
3837 case BBS_DEVICE_PATH
:
3838 return BDS_LEGACY_BBS_BOOT
;
3839 case MEDIA_DEVICE_PATH
:
3840 if (DevicePathSubType (TempDevicePath
) == MEDIA_HARDDRIVE_DP
) {
3841 return BDS_EFI_MEDIA_HD_BOOT
;
3842 } else if (DevicePathSubType (TempDevicePath
) == MEDIA_CDROM_DP
) {
3843 return BDS_EFI_MEDIA_CDROM_BOOT
;
3846 case ACPI_DEVICE_PATH
:
3847 Acpi
= (ACPI_HID_DEVICE_PATH
*) TempDevicePath
;
3848 if (EISA_ID_TO_NUM (Acpi
->HID
) == 0x0604) {
3849 return BDS_EFI_ACPI_FLOPPY_BOOT
;
3852 case MESSAGING_DEVICE_PATH
:
3854 // Get the last device path node
3856 LastDeviceNode
= NextDevicePathNode (TempDevicePath
);
3857 if (DevicePathSubType(LastDeviceNode
) == MSG_DEVICE_LOGICAL_UNIT_DP
) {
3859 // if the next node type is Device Logical Unit, which specify the Logical Unit Number (LUN),
3862 LastDeviceNode
= NextDevicePathNode (LastDeviceNode
);
3865 // if the device path not only point to driver device, it is not a messaging device path,
3867 if (!IsDevicePathEndType (LastDeviceNode
)) {
3871 switch (DevicePathSubType (TempDevicePath
)) {
3873 BootType
= BDS_EFI_MESSAGE_ATAPI_BOOT
;
3877 BootType
= BDS_EFI_MESSAGE_USB_DEVICE_BOOT
;
3881 BootType
= BDS_EFI_MESSAGE_SCSI_BOOT
;
3885 BootType
= BDS_EFI_MESSAGE_SATA_BOOT
;
3888 case MSG_MAC_ADDR_DP
:
3892 BootType
= BDS_EFI_MESSAGE_MAC_BOOT
;
3896 BootType
= BDS_EFI_MESSAGE_MISC_BOOT
;
3904 TempDevicePath
= NextDevicePathNode (TempDevicePath
);
3907 return BDS_EFI_UNSUPPORT
;
3911 Check whether the Device path in a boot option point to a valid bootable device,
3912 And if CheckMedia is true, check the device is ready to boot now.
3914 @param DevPath the Device path in a boot option
3915 @param CheckMedia if true, check the device is ready to boot now.
3917 @retval TRUE the Device path is valid
3918 @retval FALSE the Device path is invalid .
3923 BdsLibIsValidEFIBootOptDevicePath (
3924 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
,
3925 IN BOOLEAN CheckMedia
3928 return BdsLibIsValidEFIBootOptDevicePathExt (DevPath
, CheckMedia
, NULL
);
3932 Check whether the Device path in a boot option point to a valid bootable device,
3933 And if CheckMedia is true, check the device is ready to boot now.
3934 If Description is not NULL and the device path point to a fixed BlockIo
3935 device, check the description whether conflict with other auto-created
3938 @param DevPath the Device path in a boot option
3939 @param CheckMedia if true, check the device is ready to boot now.
3940 @param Description the description in a boot option
3942 @retval TRUE the Device path is valid
3943 @retval FALSE the Device path is invalid .
3948 BdsLibIsValidEFIBootOptDevicePathExt (
3949 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
,
3950 IN BOOLEAN CheckMedia
,
3951 IN CHAR16
*Description
3956 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
3957 EFI_DEVICE_PATH_PROTOCOL
*LastDeviceNode
;
3958 EFI_BLOCK_IO_PROTOCOL
*BlockIo
;
3960 TempDevicePath
= DevPath
;
3961 LastDeviceNode
= DevPath
;
3964 // Check if it's a valid boot option for network boot device.
3965 // Check if there is EfiLoadFileProtocol installed.
3966 // If yes, that means there is a boot option for network.
3968 Status
= gBS
->LocateDevicePath (
3969 &gEfiLoadFileProtocolGuid
,
3973 if (EFI_ERROR (Status
)) {
3975 // Device not present so see if we need to connect it
3977 TempDevicePath
= DevPath
;
3978 BdsLibConnectDevicePath (TempDevicePath
);
3979 Status
= gBS
->LocateDevicePath (
3980 &gEfiLoadFileProtocolGuid
,
3986 if (!EFI_ERROR (Status
)) {
3987 if (!IsDevicePathEnd (TempDevicePath
)) {
3989 // LoadFile protocol is not installed on handle with exactly the same DevPath
3996 // Test if it is ready to boot now
3998 if (BdsLibNetworkBootWithMediaPresent(DevPath
)) {
4007 // If the boot option point to a file, it is a valid EFI boot option,
4008 // and assume it is ready to boot now
4010 while (!IsDevicePathEnd (TempDevicePath
)) {
4012 // If there is USB Class or USB WWID device path node, treat it as valid EFI
4013 // Boot Option. BdsExpandUsbShortFormDevicePath () will be used to expand it
4014 // to full device path.
4016 if ((DevicePathType (TempDevicePath
) == MESSAGING_DEVICE_PATH
) &&
4017 ((DevicePathSubType (TempDevicePath
) == MSG_USB_CLASS_DP
) ||
4018 (DevicePathSubType (TempDevicePath
) == MSG_USB_WWID_DP
))) {
4022 LastDeviceNode
= TempDevicePath
;
4023 TempDevicePath
= NextDevicePathNode (TempDevicePath
);
4025 if ((DevicePathType (LastDeviceNode
) == MEDIA_DEVICE_PATH
) &&
4026 (DevicePathSubType (LastDeviceNode
) == MEDIA_FILEPATH_DP
)) {
4031 // Check if it's a valid boot option for internal FV application
4033 if (EfiGetNameGuidFromFwVolDevicePathNode ((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
*) LastDeviceNode
) != NULL
) {
4035 // If the boot option point to internal FV application, make sure it is valid
4037 TempDevicePath
= DevPath
;
4038 Status
= BdsLibUpdateFvFileDevicePath (
4040 EfiGetNameGuidFromFwVolDevicePathNode ((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
*) LastDeviceNode
)
4042 if (Status
== EFI_ALREADY_STARTED
) {
4045 if (Status
== EFI_SUCCESS
) {
4046 FreePool (TempDevicePath
);
4053 // If the boot option point to a blockIO device:
4054 // if it is a removable blockIo device, it is valid.
4055 // if it is a fixed blockIo device, check its description confliction.
4057 TempDevicePath
= DevPath
;
4058 Status
= gBS
->LocateDevicePath (&gEfiBlockIoProtocolGuid
, &TempDevicePath
, &Handle
);
4059 if (EFI_ERROR (Status
)) {
4061 // Device not present so see if we need to connect it
4063 Status
= BdsLibConnectDevicePath (DevPath
);
4064 if (!EFI_ERROR (Status
)) {
4066 // Try again to get the Block Io protocol after we did the connect
4068 TempDevicePath
= DevPath
;
4069 Status
= gBS
->LocateDevicePath (&gEfiBlockIoProtocolGuid
, &TempDevicePath
, &Handle
);
4073 if (!EFI_ERROR (Status
)) {
4074 Status
= gBS
->HandleProtocol (Handle
, &gEfiBlockIoProtocolGuid
, (VOID
**)&BlockIo
);
4075 if (!EFI_ERROR (Status
)) {
4078 // Test if it is ready to boot now
4080 if (BdsLibGetBootableHandle (DevPath
) != NULL
) {
4089 // 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,
4091 Status
= gBS
->LocateDevicePath (&gEfiSimpleFileSystemProtocolGuid
, &TempDevicePath
, &Handle
);
4092 if (!EFI_ERROR (Status
)) {
4095 // Test if it is ready to boot now
4097 if (BdsLibGetBootableHandle (DevPath
) != NULL
) {
4111 According to a file guild, check a Fv file device path is valid. If it is invalid,
4112 try to return the valid device path.
4113 FV address maybe changes for memory layout adjust from time to time, use this function
4114 could promise the Fv file device path is right.
4116 @param DevicePath on input, the Fv file device path need to check on
4117 output, the updated valid Fv file device path
4118 @param FileGuid the Fv file guild
4120 @retval EFI_INVALID_PARAMETER the input DevicePath or FileGuid is invalid
4122 @retval EFI_UNSUPPORTED the input DevicePath does not contain Fv file
4124 @retval EFI_ALREADY_STARTED the input DevicePath has pointed to Fv file, it is
4126 @retval EFI_SUCCESS has successfully updated the invalid DevicePath,
4127 and return the updated device path in DevicePath
4132 BdsLibUpdateFvFileDevicePath (
4133 IN OUT EFI_DEVICE_PATH_PROTOCOL
** DevicePath
,
4134 IN EFI_GUID
*FileGuid
4137 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
4138 EFI_DEVICE_PATH_PROTOCOL
*LastDeviceNode
;
4140 EFI_GUID
*GuidPoint
;
4142 UINTN FvHandleCount
;
4143 EFI_HANDLE
*FvHandleBuffer
;
4144 EFI_FV_FILETYPE Type
;
4146 EFI_FV_FILE_ATTRIBUTES Attributes
;
4147 UINT32 AuthenticationStatus
;
4149 EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
;
4150 EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
;
4151 MEDIA_FW_VOL_FILEPATH_DEVICE_PATH FvFileNode
;
4152 EFI_HANDLE FoundFvHandle
;
4153 EFI_DEVICE_PATH_PROTOCOL
*NewDevicePath
;
4155 if ((DevicePath
== NULL
) || (*DevicePath
== NULL
)) {
4156 return EFI_INVALID_PARAMETER
;
4158 if (FileGuid
== NULL
) {
4159 return EFI_INVALID_PARAMETER
;
4163 // Check whether the device path point to the default the input Fv file
4165 TempDevicePath
= *DevicePath
;
4166 LastDeviceNode
= TempDevicePath
;
4167 while (!IsDevicePathEnd (TempDevicePath
)) {
4168 LastDeviceNode
= TempDevicePath
;
4169 TempDevicePath
= NextDevicePathNode (TempDevicePath
);
4171 GuidPoint
= EfiGetNameGuidFromFwVolDevicePathNode (
4172 (MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
*) LastDeviceNode
4174 if (GuidPoint
== NULL
) {
4176 // if this option does not points to a Fv file, just return EFI_UNSUPPORTED
4178 return EFI_UNSUPPORTED
;
4180 if (!CompareGuid (GuidPoint
, FileGuid
)) {
4182 // If the Fv file is not the input file guid, just return EFI_UNSUPPORTED
4184 return EFI_UNSUPPORTED
;
4188 // Check whether the input Fv file device path is valid
4190 TempDevicePath
= *DevicePath
;
4191 FoundFvHandle
= NULL
;
4192 Status
= gBS
->LocateDevicePath (
4193 &gEfiFirmwareVolume2ProtocolGuid
,
4197 if (!EFI_ERROR (Status
)) {
4198 Status
= gBS
->HandleProtocol (
4200 &gEfiFirmwareVolume2ProtocolGuid
,
4203 if (!EFI_ERROR (Status
)) {
4205 // Set FV ReadFile Buffer as NULL, only need to check whether input Fv file exist there
4207 Status
= Fv
->ReadFile (
4214 &AuthenticationStatus
4216 if (!EFI_ERROR (Status
)) {
4217 return EFI_ALREADY_STARTED
;
4223 // Look for the input wanted FV file in current FV
4224 // First, try to look for in Bds own FV. Bds and input wanted FV file usually are in the same FV
4227 FoundFvHandle
= NULL
;
4228 Status
= gBS
->HandleProtocol (
4230 &gEfiLoadedImageProtocolGuid
,
4231 (VOID
**) &LoadedImage
4233 if (!EFI_ERROR (Status
)) {
4234 Status
= gBS
->HandleProtocol (
4235 LoadedImage
->DeviceHandle
,
4236 &gEfiFirmwareVolume2ProtocolGuid
,
4239 if (!EFI_ERROR (Status
)) {
4240 Status
= Fv
->ReadFile (
4247 &AuthenticationStatus
4249 if (!EFI_ERROR (Status
)) {
4251 FoundFvHandle
= LoadedImage
->DeviceHandle
;
4256 // Second, if fail to find, try to enumerate all FV
4259 FvHandleBuffer
= NULL
;
4260 gBS
->LocateHandleBuffer (
4262 &gEfiFirmwareVolume2ProtocolGuid
,
4267 for (Index
= 0; Index
< FvHandleCount
; Index
++) {
4268 gBS
->HandleProtocol (
4269 FvHandleBuffer
[Index
],
4270 &gEfiFirmwareVolume2ProtocolGuid
,
4274 Status
= Fv
->ReadFile (
4281 &AuthenticationStatus
4283 if (EFI_ERROR (Status
)) {
4285 // Skip if input Fv file not in the FV
4290 FoundFvHandle
= FvHandleBuffer
[Index
];
4294 if (FvHandleBuffer
!= NULL
) {
4295 FreePool (FvHandleBuffer
);
4301 // Build the shell device path
4303 NewDevicePath
= DevicePathFromHandle (FoundFvHandle
);
4304 EfiInitializeFwVolDevicepathNode (&FvFileNode
, FileGuid
);
4305 NewDevicePath
= AppendDevicePathNode (NewDevicePath
, (EFI_DEVICE_PATH_PROTOCOL
*) &FvFileNode
);
4306 *DevicePath
= NewDevicePath
;
4309 return EFI_NOT_FOUND
;