2 BDS Lib functions which relate with create or process the boot option.
4 Copyright (c) 2004 - 2012, 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
;
1668 Status
= gBS
->LocateProtocol (&gEfiLegacyBiosProtocolGuid
, NULL
, (VOID
**) &LegacyBios
);
1669 if (EFI_ERROR (Status
)) {
1671 // If no LegacyBios protocol we do not support legacy boot
1673 return EFI_UNSUPPORTED
;
1676 // Notes: if we separate the int 19, then we don't need to refresh BBS
1678 BdsRefreshBbsTableForBoot (Option
);
1681 // Write boot to OS performance data for legacy boot.
1684 WriteBootToOsPerformanceData ();
1687 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Legacy Boot: %S\n", Option
->Description
));
1688 return LegacyBios
->LegacyBoot (
1690 (BBS_BBS_DEVICE_PATH
*) Option
->DevicePath
,
1691 Option
->LoadOptionsSize
,
1697 Internal function to check if the input boot option is a valid EFI NV Boot####.
1699 @param OptionToCheck Boot option to be checked.
1701 @retval TRUE This boot option matches a valid EFI NV Boot####.
1702 @retval FALSE If not.
1706 IsBootOptionValidNVVarialbe (
1707 IN BDS_COMMON_OPTION
*OptionToCheck
1710 LIST_ENTRY TempList
;
1711 BDS_COMMON_OPTION
*BootOption
;
1713 CHAR16 OptionName
[20];
1717 InitializeListHead (&TempList
);
1718 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Boot%04x", OptionToCheck
->BootCurrent
);
1720 BootOption
= BdsLibVariableToOption (&TempList
, OptionName
);
1721 if (BootOption
== NULL
) {
1726 // If the Boot Option Number and Device Path matches, OptionToCheck matches a
1727 // valid EFI NV Boot####.
1729 if ((OptionToCheck
->BootCurrent
== BootOption
->BootCurrent
) &&
1730 (CompareMem (OptionToCheck
->DevicePath
, BootOption
->DevicePath
, GetDevicePathSize (OptionToCheck
->DevicePath
)) == 0))
1735 FreePool (BootOption
);
1741 Check whether a USB device match the specified USB Class device path. This
1742 function follows "Load Option Processing" behavior in UEFI specification.
1744 @param UsbIo USB I/O protocol associated with the USB device.
1745 @param UsbClass The USB Class device path to match.
1747 @retval TRUE The USB device match the USB Class device path.
1748 @retval FALSE The USB device does not match the USB Class device path.
1753 IN EFI_USB_IO_PROTOCOL
*UsbIo
,
1754 IN USB_CLASS_DEVICE_PATH
*UsbClass
1758 EFI_USB_DEVICE_DESCRIPTOR DevDesc
;
1759 EFI_USB_INTERFACE_DESCRIPTOR IfDesc
;
1761 UINT8 DeviceSubClass
;
1762 UINT8 DeviceProtocol
;
1764 if ((DevicePathType (UsbClass
) != MESSAGING_DEVICE_PATH
) ||
1765 (DevicePathSubType (UsbClass
) != MSG_USB_CLASS_DP
)){
1770 // Check Vendor Id and Product Id.
1772 Status
= UsbIo
->UsbGetDeviceDescriptor (UsbIo
, &DevDesc
);
1773 if (EFI_ERROR (Status
)) {
1777 if ((UsbClass
->VendorId
!= 0xffff) &&
1778 (UsbClass
->VendorId
!= DevDesc
.IdVendor
)) {
1782 if ((UsbClass
->ProductId
!= 0xffff) &&
1783 (UsbClass
->ProductId
!= DevDesc
.IdProduct
)) {
1787 DeviceClass
= DevDesc
.DeviceClass
;
1788 DeviceSubClass
= DevDesc
.DeviceSubClass
;
1789 DeviceProtocol
= DevDesc
.DeviceProtocol
;
1790 if (DeviceClass
== 0) {
1792 // If Class in Device Descriptor is set to 0, use the Class, SubClass and
1793 // Protocol in Interface Descriptor instead.
1795 Status
= UsbIo
->UsbGetInterfaceDescriptor (UsbIo
, &IfDesc
);
1796 if (EFI_ERROR (Status
)) {
1800 DeviceClass
= IfDesc
.InterfaceClass
;
1801 DeviceSubClass
= IfDesc
.InterfaceSubClass
;
1802 DeviceProtocol
= IfDesc
.InterfaceProtocol
;
1806 // Check Class, SubClass and Protocol.
1808 if ((UsbClass
->DeviceClass
!= 0xff) &&
1809 (UsbClass
->DeviceClass
!= DeviceClass
)) {
1813 if ((UsbClass
->DeviceSubClass
!= 0xff) &&
1814 (UsbClass
->DeviceSubClass
!= DeviceSubClass
)) {
1818 if ((UsbClass
->DeviceProtocol
!= 0xff) &&
1819 (UsbClass
->DeviceProtocol
!= DeviceProtocol
)) {
1827 Check whether a USB device match the specified USB WWID device path. This
1828 function follows "Load Option Processing" behavior in UEFI specification.
1830 @param UsbIo USB I/O protocol associated with the USB device.
1831 @param UsbWwid The USB WWID device path to match.
1833 @retval TRUE The USB device match the USB WWID device path.
1834 @retval FALSE The USB device does not match the USB WWID device path.
1839 IN EFI_USB_IO_PROTOCOL
*UsbIo
,
1840 IN USB_WWID_DEVICE_PATH
*UsbWwid
1844 EFI_USB_DEVICE_DESCRIPTOR DevDesc
;
1845 EFI_USB_INTERFACE_DESCRIPTOR IfDesc
;
1846 UINT16
*LangIdTable
;
1851 CHAR16
*SerialNumberStr
;
1854 if ((DevicePathType (UsbWwid
) != MESSAGING_DEVICE_PATH
) ||
1855 (DevicePathSubType (UsbWwid
) != MSG_USB_WWID_DP
)){
1860 // Check Vendor Id and Product Id.
1862 Status
= UsbIo
->UsbGetDeviceDescriptor (UsbIo
, &DevDesc
);
1863 if (EFI_ERROR (Status
)) {
1866 if ((DevDesc
.IdVendor
!= UsbWwid
->VendorId
) ||
1867 (DevDesc
.IdProduct
!= UsbWwid
->ProductId
)) {
1872 // Check Interface Number.
1874 Status
= UsbIo
->UsbGetInterfaceDescriptor (UsbIo
, &IfDesc
);
1875 if (EFI_ERROR (Status
)) {
1878 if (IfDesc
.InterfaceNumber
!= UsbWwid
->InterfaceNumber
) {
1883 // Check Serial Number.
1885 if (DevDesc
.StrSerialNumber
== 0) {
1890 // Get all supported languages.
1894 Status
= UsbIo
->UsbGetSupportedLanguages (UsbIo
, &LangIdTable
, &TableSize
);
1895 if (EFI_ERROR (Status
) || (TableSize
== 0) || (LangIdTable
== NULL
)) {
1900 // Serial number in USB WWID device path is the last 64-or-less UTF-16 characters.
1902 CompareStr
= (CHAR16
*) (UINTN
) (UsbWwid
+ 1);
1903 CompareLen
= (DevicePathNodeLength (UsbWwid
) - sizeof (USB_WWID_DEVICE_PATH
)) / sizeof (CHAR16
);
1904 if (CompareStr
[CompareLen
- 1] == L
'\0') {
1909 // Compare serial number in each supported language.
1911 for (Index
= 0; Index
< TableSize
/ sizeof (UINT16
); Index
++) {
1912 SerialNumberStr
= NULL
;
1913 Status
= UsbIo
->UsbGetStringDescriptor (
1916 DevDesc
.StrSerialNumber
,
1919 if (EFI_ERROR (Status
) || (SerialNumberStr
== NULL
)) {
1923 Length
= StrLen (SerialNumberStr
);
1924 if ((Length
>= CompareLen
) &&
1925 (CompareMem (SerialNumberStr
+ Length
- CompareLen
, CompareStr
, CompareLen
* sizeof (CHAR16
)) == 0)) {
1926 FreePool (SerialNumberStr
);
1930 FreePool (SerialNumberStr
);
1937 Find a USB device path which match the specified short-form device path start
1938 with USB Class or USB WWID device path and load the boot file then return the
1939 image handle. If ParentDevicePath is NULL, this function will search in all USB
1940 devices of the platform. If ParentDevicePath is not NULL,this function will only
1941 search in its child devices.
1943 @param ParentDevicePath The device path of the parent.
1944 @param ShortFormDevicePath The USB Class or USB WWID device path to match.
1946 @return The image Handle if find load file from specified short-form device path
1947 or NULL if not found.
1952 IN EFI_DEVICE_PATH_PROTOCOL
*ParentDevicePath
,
1953 IN EFI_DEVICE_PATH_PROTOCOL
*ShortFormDevicePath
1957 UINTN UsbIoHandleCount
;
1958 EFI_HANDLE
*UsbIoHandleBuffer
;
1959 EFI_DEVICE_PATH_PROTOCOL
*UsbIoDevicePath
;
1960 EFI_USB_IO_PROTOCOL
*UsbIo
;
1964 EFI_HANDLE ImageHandle
;
1966 EFI_DEVICE_PATH_PROTOCOL
*FullDevicePath
;
1967 EFI_DEVICE_PATH_PROTOCOL
*NextDevicePath
;
1969 FullDevicePath
= NULL
;
1973 // Get all UsbIo Handles.
1975 UsbIoHandleCount
= 0;
1976 UsbIoHandleBuffer
= NULL
;
1977 Status
= gBS
->LocateHandleBuffer (
1979 &gEfiUsbIoProtocolGuid
,
1984 if (EFI_ERROR (Status
) || (UsbIoHandleCount
== 0) || (UsbIoHandleBuffer
== NULL
)) {
1988 ParentSize
= (ParentDevicePath
== NULL
) ? 0 : GetDevicePathSize (ParentDevicePath
);
1989 for (Index
= 0; Index
< UsbIoHandleCount
; Index
++) {
1991 // Get the Usb IO interface.
1993 Status
= gBS
->HandleProtocol(
1994 UsbIoHandleBuffer
[Index
],
1995 &gEfiUsbIoProtocolGuid
,
1998 if (EFI_ERROR (Status
)) {
2002 UsbIoDevicePath
= DevicePathFromHandle (UsbIoHandleBuffer
[Index
]);
2003 if (UsbIoDevicePath
== NULL
) {
2007 if (ParentDevicePath
!= NULL
) {
2009 // Compare starting part of UsbIoHandle's device path with ParentDevicePath.
2011 Size
= GetDevicePathSize (UsbIoDevicePath
);
2012 if ((Size
< ParentSize
) ||
2013 (CompareMem (UsbIoDevicePath
, ParentDevicePath
, ParentSize
- END_DEVICE_PATH_LENGTH
) != 0)) {
2018 if (BdsMatchUsbClass (UsbIo
, (USB_CLASS_DEVICE_PATH
*) ShortFormDevicePath
) ||
2019 BdsMatchUsbWwid (UsbIo
, (USB_WWID_DEVICE_PATH
*) ShortFormDevicePath
)) {
2021 // Try to find if there is the boot file in this DevicePath
2023 NextDevicePath
= NextDevicePathNode (ShortFormDevicePath
);
2024 if (!IsDevicePathEnd (NextDevicePath
)) {
2025 FullDevicePath
= AppendDevicePath (UsbIoDevicePath
, NextDevicePath
);
2027 // Connect the full device path, so that Simple File System protocol
2028 // could be installed for this USB device.
2030 BdsLibConnectDevicePath (FullDevicePath
);
2031 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, PcdGet32 (PcdProgressCodeOsLoaderLoad
));
2032 Status
= gBS
->LoadImage (
2040 FreePool (FullDevicePath
);
2042 FullDevicePath
= UsbIoDevicePath
;
2043 Status
= EFI_NOT_FOUND
;
2047 // If we didn't find an image directly, we need to try as if it is a removable device boot option
2048 // and load the image according to the default boot behavior for removable device.
2050 if (EFI_ERROR (Status
)) {
2052 // check if there is a bootable removable media could be found in this device path ,
2053 // and get the bootable media handle
2055 Handle
= BdsLibGetBootableHandle(UsbIoDevicePath
);
2056 if (Handle
== NULL
) {
2060 // Load the default boot file \EFI\BOOT\boot{machinename}.EFI from removable Media
2061 // machinename is ia32, ia64, x64, ...
2063 FullDevicePath
= FileDevicePath (Handle
, EFI_REMOVABLE_MEDIA_FILE_NAME
);
2064 if (FullDevicePath
!= NULL
) {
2065 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, PcdGet32 (PcdProgressCodeOsLoaderLoad
));
2066 Status
= gBS
->LoadImage (
2074 if (EFI_ERROR (Status
)) {
2076 // The DevicePath failed, and it's not a valid
2077 // removable media device.
2089 FreePool (UsbIoHandleBuffer
);
2094 Expand USB Class or USB WWID device path node to be full device path of a USB
2095 device in platform then load the boot file on this full device path and return the
2098 This function support following 4 cases:
2099 1) Boot Option device path starts with a USB Class or USB WWID device path,
2100 and there is no Media FilePath device path in the end.
2101 In this case, it will follow Removable Media Boot Behavior.
2102 2) Boot Option device path starts with a USB Class or USB WWID device path,
2103 and ended with Media FilePath device path.
2104 3) Boot Option device path starts with a full device path to a USB Host Controller,
2105 contains a USB Class or USB WWID device path node, while not ended with Media
2106 FilePath device path. In this case, it will follow Removable Media Boot Behavior.
2107 4) Boot Option device path starts with a full device path to a USB Host Controller,
2108 contains a USB Class or USB WWID device path node, and ended with Media
2109 FilePath device path.
2111 @param DevicePath The Boot Option device path.
2113 @return The image handle of boot file, or NULL if there is no boot file found in
2114 the specified USB Class or USB WWID device path.
2118 BdsExpandUsbShortFormDevicePath (
2119 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
2122 EFI_HANDLE
*ImageHandle
;
2123 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
2124 EFI_DEVICE_PATH_PROTOCOL
*ShortFormDevicePath
;
2127 // Search for USB Class or USB WWID device path node.
2129 ShortFormDevicePath
= NULL
;
2131 TempDevicePath
= DevicePath
;
2132 while (!IsDevicePathEnd (TempDevicePath
)) {
2133 if ((DevicePathType (TempDevicePath
) == MESSAGING_DEVICE_PATH
) &&
2134 ((DevicePathSubType (TempDevicePath
) == MSG_USB_CLASS_DP
) ||
2135 (DevicePathSubType (TempDevicePath
) == MSG_USB_WWID_DP
))) {
2136 ShortFormDevicePath
= TempDevicePath
;
2139 TempDevicePath
= NextDevicePathNode (TempDevicePath
);
2142 if (ShortFormDevicePath
== NULL
) {
2144 // No USB Class or USB WWID device path node found, do nothing.
2149 if (ShortFormDevicePath
== DevicePath
) {
2151 // Boot Option device path starts with USB Class or USB WWID device path.
2153 ImageHandle
= BdsFindUsbDevice (NULL
, ShortFormDevicePath
);
2154 if (ImageHandle
== NULL
) {
2156 // Failed to find a match in existing devices, connect the short form USB
2157 // device path and try again.
2159 BdsLibConnectUsbDevByShortFormDP (0xff, ShortFormDevicePath
);
2160 ImageHandle
= BdsFindUsbDevice (NULL
, ShortFormDevicePath
);
2164 // Boot Option device path contains USB Class or USB WWID device path node.
2168 // Prepare the parent device path for search.
2170 TempDevicePath
= DuplicateDevicePath (DevicePath
);
2171 ASSERT (TempDevicePath
!= NULL
);
2172 SetDevicePathEndNode (((UINT8
*) TempDevicePath
) + ((UINTN
) ShortFormDevicePath
- (UINTN
) DevicePath
));
2175 // The USB Host Controller device path is already in Boot Option device path
2176 // and USB Bus driver already support RemainingDevicePath starts with USB
2177 // Class or USB WWID device path, so just search in existing USB devices and
2178 // doesn't perform ConnectController here.
2180 ImageHandle
= BdsFindUsbDevice (TempDevicePath
, ShortFormDevicePath
);
2181 FreePool (TempDevicePath
);
2188 Process the boot option follow the UEFI specification and
2189 special treat the legacy boot option with BBS_DEVICE_PATH.
2191 @param Option The boot option need to be processed
2192 @param DevicePath The device path which describe where to load the
2193 boot image or the legacy BBS device path to boot
2195 @param ExitDataSize The size of exit data.
2196 @param ExitData Data returned when Boot image failed.
2198 @retval EFI_SUCCESS Boot from the input boot option successfully.
2199 @retval EFI_NOT_FOUND If the Device Path is not found in the system
2204 BdsLibBootViaBootOption (
2205 IN BDS_COMMON_OPTION
*Option
,
2206 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
2207 OUT UINTN
*ExitDataSize
,
2208 OUT CHAR16
**ExitData OPTIONAL
2212 EFI_STATUS StatusLogo
;
2214 EFI_HANDLE ImageHandle
;
2215 EFI_DEVICE_PATH_PROTOCOL
*FilePath
;
2216 EFI_LOADED_IMAGE_PROTOCOL
*ImageInfo
;
2217 EFI_DEVICE_PATH_PROTOCOL
*WorkingDevicePath
;
2218 EFI_ACPI_S3_SAVE_PROTOCOL
*AcpiS3Save
;
2219 LIST_ENTRY TempBootLists
;
2220 EFI_BOOT_LOGO_PROTOCOL
*BootLogo
;
2223 // Record the performance data for End of BDS
2225 PERF_END(NULL
, "BDS", NULL
, 0);
2231 // Notes: this code can be remove after the s3 script table
2232 // hook on the event EVT_SIGNAL_READY_TO_BOOT or
2233 // EVT_SIGNAL_LEGACY_BOOT
2235 Status
= gBS
->LocateProtocol (&gEfiAcpiS3SaveProtocolGuid
, NULL
, (VOID
**) &AcpiS3Save
);
2236 if (!EFI_ERROR (Status
)) {
2237 AcpiS3Save
->S3Save (AcpiS3Save
, NULL
);
2240 // If it's Device Path that starts with a hard drive path, append it with the front part to compose a
2243 WorkingDevicePath
= NULL
;
2244 if ((DevicePathType (DevicePath
) == MEDIA_DEVICE_PATH
) &&
2245 (DevicePathSubType (DevicePath
) == MEDIA_HARDDRIVE_DP
)) {
2246 WorkingDevicePath
= BdsExpandPartitionPartialDevicePathToFull (
2247 (HARDDRIVE_DEVICE_PATH
*)DevicePath
2249 if (WorkingDevicePath
!= NULL
) {
2250 DevicePath
= WorkingDevicePath
;
2257 if (IsBootOptionValidNVVarialbe (Option
)) {
2259 // For a temporary boot (i.e. a boot by selected a EFI Shell using "Boot From File"), Boot Current is actually not valid.
2260 // In this case, "BootCurrent" is not created.
2261 // Only create the BootCurrent variable when it points to a valid Boot#### variable.
2265 &gEfiGlobalVariableGuid
,
2266 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
2268 &Option
->BootCurrent
2273 // Signal the EVT_SIGNAL_READY_TO_BOOT event
2275 EfiSignalEventReadyToBoot();
2278 // Expand USB Class or USB WWID device path node to be full device path of a USB
2279 // device in platform then load the boot file on this full device path and get the
2282 ImageHandle
= BdsExpandUsbShortFormDevicePath (DevicePath
);
2285 // Adjust the different type memory page number just before booting
2286 // and save the updated info into the variable for next boot to use
2288 BdsSetMemoryTypeInformationVariable ();
2291 // By expanding the USB Class or WWID device path, the ImageHandle has returnned.
2292 // Here get the ImageHandle for the non USB class or WWID device path.
2294 if (ImageHandle
== NULL
) {
2295 ASSERT (Option
->DevicePath
!= NULL
);
2296 if ((DevicePathType (Option
->DevicePath
) == BBS_DEVICE_PATH
) &&
2297 (DevicePathSubType (Option
->DevicePath
) == BBS_BBS_DP
)
2300 // Check to see if we should legacy BOOT. If yes then do the legacy boot
2302 return BdsLibDoLegacyBoot (Option
);
2306 // If the boot option point to Internal FV shell, make sure it is valid
2308 Status
= BdsLibUpdateFvFileDevicePath (&DevicePath
, PcdGetPtr(PcdShellFile
));
2309 if (!EFI_ERROR(Status
)) {
2310 if (Option
->DevicePath
!= NULL
) {
2311 FreePool(Option
->DevicePath
);
2313 Option
->DevicePath
= AllocateZeroPool (GetDevicePathSize (DevicePath
));
2314 ASSERT(Option
->DevicePath
!= NULL
);
2315 CopyMem (Option
->DevicePath
, DevicePath
, GetDevicePathSize (DevicePath
));
2317 // Update the shell boot option
2319 InitializeListHead (&TempBootLists
);
2320 BdsLibRegisterNewOption (&TempBootLists
, DevicePath
, L
"EFI Internal Shell", L
"BootOrder");
2323 // free the temporary device path created by BdsLibUpdateFvFileDevicePath()
2325 FreePool (DevicePath
);
2326 DevicePath
= Option
->DevicePath
;
2331 if (Option
->Description
== NULL
) {
2332 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Booting from unknown device path\n"));
2334 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Booting %S\n", Option
->Description
));
2340 // Report status code for OS Loader LoadImage.
2342 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, PcdGet32 (PcdProgressCodeOsLoaderLoad
));
2343 Status
= gBS
->LoadImage (
2353 // If we didn't find an image directly, we need to try as if it is a removable device boot option
2354 // and load the image according to the default boot behavior for removable device.
2356 if (EFI_ERROR (Status
)) {
2358 // check if there is a bootable removable media could be found in this device path ,
2359 // and get the bootable media handle
2361 Handle
= BdsLibGetBootableHandle(DevicePath
);
2362 if (Handle
== NULL
) {
2366 // Load the default boot file \EFI\BOOT\boot{machinename}.EFI from removable Media
2367 // machinename is ia32, ia64, x64, ...
2369 FilePath
= FileDevicePath (Handle
, EFI_REMOVABLE_MEDIA_FILE_NAME
);
2370 if (FilePath
!= NULL
) {
2371 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, PcdGet32 (PcdProgressCodeOsLoaderLoad
));
2372 Status
= gBS
->LoadImage (
2380 if (EFI_ERROR (Status
)) {
2382 // The DevicePath failed, and it's not a valid
2383 // removable media device.
2390 if (EFI_ERROR (Status
)) {
2392 // It there is any error from the Boot attempt exit now.
2398 // Provide the image with it's load options
2400 if (ImageHandle
== NULL
) {
2403 Status
= gBS
->HandleProtocol (ImageHandle
, &gEfiLoadedImageProtocolGuid
, (VOID
**) &ImageInfo
);
2404 ASSERT_EFI_ERROR (Status
);
2406 if (Option
->LoadOptionsSize
!= 0) {
2407 ImageInfo
->LoadOptionsSize
= Option
->LoadOptionsSize
;
2408 ImageInfo
->LoadOptions
= Option
->LoadOptions
;
2412 // Clean to NULL because the image is loaded directly from the firmwares boot manager.
2414 ImageInfo
->ParentHandle
= NULL
;
2417 // Before calling the image, enable the Watchdog Timer for
2418 // the 5 Minute period
2420 gBS
->SetWatchdogTimer (5 * 60, 0x0000, 0x00, NULL
);
2423 // Write boot to OS performance data for UEFI boot
2426 WriteBootToOsPerformanceData ();
2430 // Report status code for OS Loader StartImage.
2432 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, PcdGet32 (PcdProgressCodeOsLoaderStart
));
2434 Status
= gBS
->StartImage (ImageHandle
, ExitDataSize
, ExitData
);
2435 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Image Return Status = %r\n", Status
));
2438 // Clear the Watchdog Timer after the image returns
2440 gBS
->SetWatchdogTimer (0x0000, 0x0000, 0x0000, NULL
);
2444 // Set Logo status invalid after trying one boot option
2447 StatusLogo
= gBS
->LocateProtocol (&gEfiBootLogoProtocolGuid
, NULL
, (VOID
**) &BootLogo
);
2448 if (!EFI_ERROR (StatusLogo
) && (BootLogo
!= NULL
)) {
2449 BootLogo
->SetBootLogo (BootLogo
, NULL
, 0, 0, 0, 0);
2453 // Clear Boot Current
2457 &gEfiGlobalVariableGuid
,
2458 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
2460 &Option
->BootCurrent
2468 Expand a device path that starts with a hard drive media device path node to be a
2469 full device path that includes the full hardware path to the device. We need
2470 to do this so it can be booted. As an optimization the front match (the part point
2471 to the partition node. E.g. ACPI() /PCI()/ATA()/Partition() ) is saved in a variable
2472 so a connect all is not required on every boot. All successful history device path
2473 which point to partition node (the front part) will be saved.
2475 @param HardDriveDevicePath EFI Device Path to boot, if it starts with a hard
2476 drive media device path.
2477 @return A Pointer to the full device path or NULL if a valid Hard Drive devic path
2481 EFI_DEVICE_PATH_PROTOCOL
*
2483 BdsExpandPartitionPartialDevicePathToFull (
2484 IN HARDDRIVE_DEVICE_PATH
*HardDriveDevicePath
2488 UINTN BlockIoHandleCount
;
2489 EFI_HANDLE
*BlockIoBuffer
;
2490 EFI_DEVICE_PATH_PROTOCOL
*FullDevicePath
;
2491 EFI_DEVICE_PATH_PROTOCOL
*BlockIoDevicePath
;
2492 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
2495 EFI_DEVICE_PATH_PROTOCOL
*CachedDevicePath
;
2496 EFI_DEVICE_PATH_PROTOCOL
*TempNewDevicePath
;
2497 UINTN CachedDevicePathSize
;
2498 BOOLEAN DeviceExist
;
2500 EFI_DEVICE_PATH_PROTOCOL
*Instance
;
2503 FullDevicePath
= NULL
;
2505 // Check if there is prestore HD_BOOT_DEVICE_PATH_VARIABLE_NAME variable.
2506 // If exist, search the front path which point to partition node in the variable instants.
2507 // If fail to find or HD_BOOT_DEVICE_PATH_VARIABLE_NAME not exist, reconnect all and search in all system
2509 CachedDevicePath
= BdsLibGetVariableAndSize (
2510 HD_BOOT_DEVICE_PATH_VARIABLE_NAME
,
2511 &gHdBootDevicePathVariablGuid
,
2512 &CachedDevicePathSize
2515 if (CachedDevicePath
!= NULL
) {
2516 TempNewDevicePath
= CachedDevicePath
;
2517 DeviceExist
= FALSE
;
2521 // Check every instance of the variable
2522 // First, check whether the instance contain the partition node, which is needed for distinguishing multi
2523 // partial partition boot option. Second, check whether the instance could be connected.
2525 Instance
= GetNextDevicePathInstance (&TempNewDevicePath
, &Size
);
2526 if (MatchPartitionDevicePathNode (Instance
, HardDriveDevicePath
)) {
2528 // Connect the device path instance, the device path point to hard drive media device path node
2529 // e.g. ACPI() /PCI()/ATA()/Partition()
2531 Status
= BdsLibConnectDevicePath (Instance
);
2532 if (!EFI_ERROR (Status
)) {
2538 // Come here means the first instance is not matched
2542 } while (TempNewDevicePath
!= NULL
);
2546 // Find the matched device path.
2547 // Append the file path information from the boot option and return the fully expanded device path.
2549 DevicePath
= NextDevicePathNode ((EFI_DEVICE_PATH_PROTOCOL
*) HardDriveDevicePath
);
2550 FullDevicePath
= AppendDevicePath (Instance
, DevicePath
);
2553 // Adjust the HD_BOOT_DEVICE_PATH_VARIABLE_NAME instances sequence if the matched one is not first one.
2557 // First delete the matched instance.
2559 TempNewDevicePath
= CachedDevicePath
;
2560 CachedDevicePath
= BdsLibDelPartMatchInstance (CachedDevicePath
, Instance
);
2561 FreePool (TempNewDevicePath
);
2564 // Second, append the remaining path after the matched instance
2566 TempNewDevicePath
= CachedDevicePath
;
2567 CachedDevicePath
= AppendDevicePathInstance (Instance
, CachedDevicePath
);
2568 FreePool (TempNewDevicePath
);
2570 // Save the matching Device Path so we don't need to do a connect all next time
2572 Status
= gRT
->SetVariable (
2573 HD_BOOT_DEVICE_PATH_VARIABLE_NAME
,
2574 &gHdBootDevicePathVariablGuid
,
2575 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
2576 GetDevicePathSize (CachedDevicePath
),
2581 FreePool (Instance
);
2582 FreePool (CachedDevicePath
);
2583 return FullDevicePath
;
2588 // If we get here we fail to find or HD_BOOT_DEVICE_PATH_VARIABLE_NAME not exist, and now we need
2589 // to search all devices in the system for a matched partition
2591 BdsLibConnectAllDriversToAllControllers ();
2592 Status
= gBS
->LocateHandleBuffer (ByProtocol
, &gEfiBlockIoProtocolGuid
, NULL
, &BlockIoHandleCount
, &BlockIoBuffer
);
2593 if (EFI_ERROR (Status
) || BlockIoHandleCount
== 0 || BlockIoBuffer
== NULL
) {
2595 // If there was an error or there are no device handles that support
2596 // the BLOCK_IO Protocol, then return.
2601 // Loop through all the device handles that support the BLOCK_IO Protocol
2603 for (Index
= 0; Index
< BlockIoHandleCount
; Index
++) {
2605 Status
= gBS
->HandleProtocol (BlockIoBuffer
[Index
], &gEfiDevicePathProtocolGuid
, (VOID
*) &BlockIoDevicePath
);
2606 if (EFI_ERROR (Status
) || BlockIoDevicePath
== NULL
) {
2610 if (MatchPartitionDevicePathNode (BlockIoDevicePath
, HardDriveDevicePath
)) {
2612 // Find the matched partition device path
2614 DevicePath
= NextDevicePathNode ((EFI_DEVICE_PATH_PROTOCOL
*) HardDriveDevicePath
);
2615 FullDevicePath
= AppendDevicePath (BlockIoDevicePath
, DevicePath
);
2618 // Save the matched partition device path in HD_BOOT_DEVICE_PATH_VARIABLE_NAME variable
2620 if (CachedDevicePath
!= NULL
) {
2622 // Save the matched partition device path as first instance of HD_BOOT_DEVICE_PATH_VARIABLE_NAME variable
2624 if (BdsLibMatchDevicePaths (CachedDevicePath
, BlockIoDevicePath
)) {
2625 TempNewDevicePath
= CachedDevicePath
;
2626 CachedDevicePath
= BdsLibDelPartMatchInstance (CachedDevicePath
, BlockIoDevicePath
);
2627 FreePool(TempNewDevicePath
);
2629 TempNewDevicePath
= CachedDevicePath
;
2630 CachedDevicePath
= AppendDevicePathInstance (BlockIoDevicePath
, CachedDevicePath
);
2631 if (TempNewDevicePath
!= NULL
) {
2632 FreePool(TempNewDevicePath
);
2635 TempNewDevicePath
= CachedDevicePath
;
2636 CachedDevicePath
= AppendDevicePathInstance (BlockIoDevicePath
, CachedDevicePath
);
2637 FreePool(TempNewDevicePath
);
2640 // Here limit the device path instance number to 12, which is max number for a system support 3 IDE controller
2641 // If the user try to boot many OS in different HDs or partitions, in theory,
2642 // the HD_BOOT_DEVICE_PATH_VARIABLE_NAME variable maybe become larger and larger.
2645 ASSERT (CachedDevicePath
!= NULL
);
2646 TempNewDevicePath
= CachedDevicePath
;
2647 while (!IsDevicePathEnd (TempNewDevicePath
)) {
2648 TempNewDevicePath
= NextDevicePathNode (TempNewDevicePath
);
2650 // Parse one instance
2652 while (!IsDevicePathEndType (TempNewDevicePath
)) {
2653 TempNewDevicePath
= NextDevicePathNode (TempNewDevicePath
);
2657 // If the CachedDevicePath variable contain too much instance, only remain 12 instances.
2659 if (InstanceNum
>= 12) {
2660 SetDevicePathEndNode (TempNewDevicePath
);
2665 CachedDevicePath
= DuplicateDevicePath (BlockIoDevicePath
);
2669 // Save the matching Device Path so we don't need to do a connect all next time
2671 Status
= gRT
->SetVariable (
2672 HD_BOOT_DEVICE_PATH_VARIABLE_NAME
,
2673 &gHdBootDevicePathVariablGuid
,
2674 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
2675 GetDevicePathSize (CachedDevicePath
),
2683 if (CachedDevicePath
!= NULL
) {
2684 FreePool (CachedDevicePath
);
2686 if (BlockIoBuffer
!= NULL
) {
2687 FreePool (BlockIoBuffer
);
2689 return FullDevicePath
;
2693 Check whether there is a instance in BlockIoDevicePath, which contain multi device path
2694 instances, has the same partition node with HardDriveDevicePath device path
2696 @param BlockIoDevicePath Multi device path instances which need to check
2697 @param HardDriveDevicePath A device path which starts with a hard drive media
2700 @retval TRUE There is a matched device path instance.
2701 @retval FALSE There is no matched device path instance.
2706 MatchPartitionDevicePathNode (
2707 IN EFI_DEVICE_PATH_PROTOCOL
*BlockIoDevicePath
,
2708 IN HARDDRIVE_DEVICE_PATH
*HardDriveDevicePath
2711 HARDDRIVE_DEVICE_PATH
*TmpHdPath
;
2712 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
2714 EFI_DEVICE_PATH_PROTOCOL
*BlockIoHdDevicePathNode
;
2716 if ((BlockIoDevicePath
== NULL
) || (HardDriveDevicePath
== NULL
)) {
2721 // Make PreviousDevicePath == the device path node before the end node
2723 DevicePath
= BlockIoDevicePath
;
2724 BlockIoHdDevicePathNode
= NULL
;
2727 // find the partition device path node
2729 while (!IsDevicePathEnd (DevicePath
)) {
2730 if ((DevicePathType (DevicePath
) == MEDIA_DEVICE_PATH
) &&
2731 (DevicePathSubType (DevicePath
) == MEDIA_HARDDRIVE_DP
)
2733 BlockIoHdDevicePathNode
= DevicePath
;
2737 DevicePath
= NextDevicePathNode (DevicePath
);
2740 if (BlockIoHdDevicePathNode
== NULL
) {
2744 // See if the harddrive device path in blockio matches the orig Hard Drive Node
2746 TmpHdPath
= (HARDDRIVE_DEVICE_PATH
*) BlockIoHdDevicePathNode
;
2750 // Check for the match
2752 if ((TmpHdPath
->MBRType
== HardDriveDevicePath
->MBRType
) &&
2753 (TmpHdPath
->SignatureType
== HardDriveDevicePath
->SignatureType
)) {
2754 switch (TmpHdPath
->SignatureType
) {
2755 case SIGNATURE_TYPE_GUID
:
2756 Match
= CompareGuid ((EFI_GUID
*)TmpHdPath
->Signature
, (EFI_GUID
*)HardDriveDevicePath
->Signature
);
2758 case SIGNATURE_TYPE_MBR
:
2759 Match
= (BOOLEAN
)(*((UINT32
*)(&(TmpHdPath
->Signature
[0]))) == ReadUnaligned32((UINT32
*)(&(HardDriveDevicePath
->Signature
[0]))));
2771 Delete the boot option associated with the handle passed in.
2773 @param Handle The handle which present the device path to create
2776 @retval EFI_SUCCESS Delete the boot option success
2777 @retval EFI_NOT_FOUND If the Device Path is not found in the system
2778 @retval EFI_OUT_OF_RESOURCES Lack of memory resource
2779 @retval Other Error return value from SetVariable()
2783 BdsLibDeleteOptionFromHandle (
2784 IN EFI_HANDLE Handle
2788 UINT8
*BootOptionVar
;
2789 UINTN BootOrderSize
;
2790 UINTN BootOptionSize
;
2793 UINT16 BootOption
[BOOT_OPTION_MAX_CHAR
];
2794 UINTN DevicePathSize
;
2795 UINTN OptionDevicePathSize
;
2796 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
2797 EFI_DEVICE_PATH_PROTOCOL
*OptionDevicePath
;
2800 Status
= EFI_SUCCESS
;
2805 // Check "BootOrder" variable, if no, means there is no any boot order.
2807 BootOrder
= BdsLibGetVariableAndSize (
2809 &gEfiGlobalVariableGuid
,
2812 if (BootOrder
== NULL
) {
2813 return EFI_NOT_FOUND
;
2817 // Convert device handle to device path protocol instance
2819 DevicePath
= DevicePathFromHandle (Handle
);
2820 if (DevicePath
== NULL
) {
2821 return EFI_NOT_FOUND
;
2823 DevicePathSize
= GetDevicePathSize (DevicePath
);
2826 // Loop all boot order variable and find the matching device path
2829 while (Index
< BootOrderSize
/ sizeof (UINT16
)) {
2830 UnicodeSPrint (BootOption
, sizeof (BootOption
), L
"Boot%04x", BootOrder
[Index
]);
2831 BootOptionVar
= BdsLibGetVariableAndSize (
2833 &gEfiGlobalVariableGuid
,
2837 if (BootOptionVar
== NULL
) {
2838 FreePool (BootOrder
);
2839 return EFI_OUT_OF_RESOURCES
;
2842 if (!ValidateOption(BootOptionVar
, BootOptionSize
)) {
2843 BdsDeleteBootOption (BootOrder
[Index
], BootOrder
, &BootOrderSize
);
2844 FreePool (BootOptionVar
);
2849 TempPtr
= BootOptionVar
;
2850 TempPtr
+= sizeof (UINT32
) + sizeof (UINT16
);
2851 TempPtr
+= StrSize ((CHAR16
*) TempPtr
);
2852 OptionDevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) TempPtr
;
2853 OptionDevicePathSize
= GetDevicePathSize (OptionDevicePath
);
2856 // Check whether the device path match
2858 if ((OptionDevicePathSize
== DevicePathSize
) &&
2859 (CompareMem (DevicePath
, OptionDevicePath
, DevicePathSize
) == 0)) {
2860 BdsDeleteBootOption (BootOrder
[Index
], BootOrder
, &BootOrderSize
);
2861 FreePool (BootOptionVar
);
2865 FreePool (BootOptionVar
);
2870 // Adjust number of boot option for "BootOrder" variable.
2872 Status
= gRT
->SetVariable (
2874 &gEfiGlobalVariableGuid
,
2875 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
2880 FreePool (BootOrder
);
2887 Delete all invalid EFI boot options.
2889 @retval EFI_SUCCESS Delete all invalid boot option success
2890 @retval EFI_NOT_FOUND Variable "BootOrder" is not found
2891 @retval EFI_OUT_OF_RESOURCES Lack of memory resource
2892 @retval Other Error return value from SetVariable()
2896 BdsDeleteAllInvalidEfiBootOption (
2901 UINT8
*BootOptionVar
;
2902 UINTN BootOrderSize
;
2903 UINTN BootOptionSize
;
2907 UINT16 BootOption
[BOOT_OPTION_MAX_CHAR
];
2908 EFI_DEVICE_PATH_PROTOCOL
*OptionDevicePath
;
2910 CHAR16
*Description
;
2913 Status
= EFI_SUCCESS
;
2916 OptionDevicePath
= NULL
;
2921 // Check "BootOrder" variable firstly, this variable hold the number of boot options
2923 BootOrder
= BdsLibGetVariableAndSize (
2925 &gEfiGlobalVariableGuid
,
2928 if (NULL
== BootOrder
) {
2929 return EFI_NOT_FOUND
;
2933 while (Index
< BootOrderSize
/ sizeof (UINT16
)) {
2934 UnicodeSPrint (BootOption
, sizeof (BootOption
), L
"Boot%04x", BootOrder
[Index
]);
2935 BootOptionVar
= BdsLibGetVariableAndSize (
2937 &gEfiGlobalVariableGuid
,
2940 if (NULL
== BootOptionVar
) {
2941 FreePool (BootOrder
);
2942 return EFI_OUT_OF_RESOURCES
;
2945 if (!ValidateOption(BootOptionVar
, BootOptionSize
)) {
2948 TempPtr
= BootOptionVar
;
2949 TempPtr
+= sizeof (UINT32
) + sizeof (UINT16
);
2950 Description
= (CHAR16
*) TempPtr
;
2951 TempPtr
+= StrSize ((CHAR16
*) TempPtr
);
2952 OptionDevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) TempPtr
;
2955 // Skip legacy boot option (BBS boot device)
2957 if ((DevicePathType (OptionDevicePath
) == BBS_DEVICE_PATH
) &&
2958 (DevicePathSubType (OptionDevicePath
) == BBS_BBS_DP
)) {
2959 FreePool (BootOptionVar
);
2965 if (Corrupted
|| !BdsLibIsValidEFIBootOptDevicePathExt (OptionDevicePath
, FALSE
, Description
)) {
2967 // Delete this invalid boot option "Boot####"
2969 Status
= gRT
->SetVariable (
2971 &gEfiGlobalVariableGuid
,
2972 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
2977 // Mark this boot option in boot order as deleted
2979 BootOrder
[Index
] = 0xffff;
2983 FreePool (BootOptionVar
);
2988 // Adjust boot order array
2991 for (Index
= 0; Index
< BootOrderSize
/ sizeof (UINT16
); Index
++) {
2992 if (BootOrder
[Index
] != 0xffff) {
2993 BootOrder
[Index2
] = BootOrder
[Index
];
2997 Status
= gRT
->SetVariable (
2999 &gEfiGlobalVariableGuid
,
3000 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
3001 Index2
* sizeof (UINT16
),
3005 FreePool (BootOrder
);
3012 For EFI boot option, BDS separate them as six types:
3013 1. Network - The boot option points to the SimpleNetworkProtocol device.
3014 Bds will try to automatically create this type boot option when enumerate.
3015 2. Shell - The boot option points to internal flash shell.
3016 Bds will try to automatically create this type boot option when enumerate.
3017 3. Removable BlockIo - The boot option only points to the removable media
3018 device, like USB flash disk, DVD, Floppy etc.
3019 These device should contain a *removable* blockIo
3020 protocol in their device handle.
3021 Bds will try to automatically create this type boot option
3023 4. Fixed BlockIo - The boot option only points to a Fixed blockIo device,
3025 These device should contain a *fixed* blockIo
3026 protocol in their device handle.
3027 BDS will skip fixed blockIo devices, and NOT
3028 automatically create boot option for them. But BDS
3029 will help to delete those fixed blockIo boot option,
3030 whose description rule conflict with other auto-created
3032 5. Non-BlockIo Simplefile - The boot option points to a device whose handle
3033 has SimpleFileSystem Protocol, but has no blockio
3034 protocol. These devices do not offer blockIo
3035 protocol, but BDS still can get the
3036 \EFI\BOOT\boot{machinename}.EFI by SimpleFileSystem
3038 6. File - The boot option points to a file. These boot options are usually
3039 created by user manually or OS loader. BDS will not delete or modify
3042 This function will enumerate all possible boot device in the system, and
3043 automatically create boot options for Network, Shell, Removable BlockIo,
3044 and Non-BlockIo Simplefile devices.
3045 It will only execute once of every boot.
3047 @param BdsBootOptionList The header of the link list which indexed all
3048 current boot options
3050 @retval EFI_SUCCESS Finished all the boot device enumerate and create
3051 the boot option base on that boot device
3053 @retval EFI_OUT_OF_RESOURCES Failed to enumerate the boot device and create the boot option list
3057 BdsLibEnumerateAllBootOption (
3058 IN OUT LIST_ENTRY
*BdsBootOptionList
3062 UINT16 FloppyNumber
;
3063 UINT16 HarddriveNumber
;
3068 UINT16 NonBlockNumber
;
3069 UINTN NumberBlockIoHandles
;
3070 EFI_HANDLE
*BlockIoHandles
;
3071 EFI_BLOCK_IO_PROTOCOL
*BlkIo
;
3072 BOOLEAN Removable
[2];
3073 UINTN RemovableIndex
;
3075 UINTN NumOfLoadFileHandles
;
3076 EFI_HANDLE
*LoadFileHandles
;
3077 UINTN FvHandleCount
;
3078 EFI_HANDLE
*FvHandleBuffer
;
3079 EFI_FV_FILETYPE Type
;
3081 EFI_FV_FILE_ATTRIBUTES Attributes
;
3082 UINT32 AuthenticationStatus
;
3083 EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
;
3084 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
3085 UINTN DevicePathType
;
3087 EFI_HANDLE
*FileSystemHandles
;
3088 UINTN NumberFileSystemHandles
;
3090 EFI_IMAGE_DOS_HEADER DosHeader
;
3093 EFI_IMAGE_OPTIONAL_HEADER_UNION HdrData
;
3094 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
;
3097 HarddriveNumber
= 0;
3104 ZeroMem (Buffer
, sizeof (Buffer
));
3107 // If the boot device enumerate happened, just get the boot
3108 // device from the boot order variable
3110 if (mEnumBootDevice
) {
3111 GetVariable2 (LAST_ENUM_LANGUAGE_VARIABLE_NAME
, &gLastEnumLangGuid
, (VOID
**)&LastLang
, NULL
);
3112 GetEfiGlobalVariable2 (L
"PlatformLang", (VOID
**)&PlatLang
, NULL
);
3113 ASSERT (PlatLang
!= NULL
);
3114 if ((LastLang
!= NULL
) && (AsciiStrCmp (LastLang
, PlatLang
) == 0)) {
3115 Status
= BdsLibBuildOptionFromVar (BdsBootOptionList
, L
"BootOrder");
3116 FreePool (LastLang
);
3117 FreePool (PlatLang
);
3120 Status
= gRT
->SetVariable (
3121 LAST_ENUM_LANGUAGE_VARIABLE_NAME
,
3123 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
3124 AsciiStrSize (PlatLang
),
3127 ASSERT_EFI_ERROR (Status
);
3129 if (LastLang
!= NULL
) {
3130 FreePool (LastLang
);
3132 FreePool (PlatLang
);
3137 // Notes: this dirty code is to get the legacy boot option from the
3138 // BBS table and create to variable as the EFI boot option, it should
3139 // be removed after the CSM can provide legacy boot option directly
3141 REFRESH_LEGACY_BOOT_OPTIONS
;
3144 // Delete invalid boot option
3146 BdsDeleteAllInvalidEfiBootOption ();
3149 // Parse removable media followed by fixed media.
3150 // The Removable[] array is used by the for-loop below to create removable media boot options
3151 // at first, and then to create fixed media boot options.
3153 Removable
[0] = FALSE
;
3154 Removable
[1] = TRUE
;
3156 gBS
->LocateHandleBuffer (
3158 &gEfiBlockIoProtocolGuid
,
3160 &NumberBlockIoHandles
,
3164 for (RemovableIndex
= 0; RemovableIndex
< 2; RemovableIndex
++) {
3165 for (Index
= 0; Index
< NumberBlockIoHandles
; Index
++) {
3166 Status
= gBS
->HandleProtocol (
3167 BlockIoHandles
[Index
],
3168 &gEfiBlockIoProtocolGuid
,
3172 // skip the fixed block io then the removable block io
3174 if (EFI_ERROR (Status
) || (BlkIo
->Media
->RemovableMedia
== Removable
[RemovableIndex
])) {
3177 DevicePath
= DevicePathFromHandle (BlockIoHandles
[Index
]);
3178 DevicePathType
= BdsGetBootTypeFromDevicePath (DevicePath
);
3180 switch (DevicePathType
) {
3181 case BDS_EFI_ACPI_FLOPPY_BOOT
:
3182 if (FloppyNumber
!= 0) {
3183 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_FLOPPY
)), FloppyNumber
);
3185 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_FLOPPY
)));
3187 BdsLibBuildOptionFromHandle (BlockIoHandles
[Index
], BdsBootOptionList
, Buffer
);
3192 // Assume a removable SATA device should be the DVD/CD device, a fixed SATA device should be the Hard Drive device.
3194 case BDS_EFI_MESSAGE_ATAPI_BOOT
:
3195 case BDS_EFI_MESSAGE_SATA_BOOT
:
3196 if (BlkIo
->Media
->RemovableMedia
) {
3197 if (CdromNumber
!= 0) {
3198 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_CD_DVD
)), CdromNumber
);
3200 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_CD_DVD
)));
3204 if (HarddriveNumber
!= 0) {
3205 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_HARDDRIVE
)), HarddriveNumber
);
3207 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_HARDDRIVE
)));
3211 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Buffer: %S\n", Buffer
));
3212 BdsLibBuildOptionFromHandle (BlockIoHandles
[Index
], BdsBootOptionList
, Buffer
);
3215 case BDS_EFI_MESSAGE_USB_DEVICE_BOOT
:
3216 if (UsbNumber
!= 0) {
3217 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_USB
)), UsbNumber
);
3219 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_USB
)));
3221 BdsLibBuildOptionFromHandle (BlockIoHandles
[Index
], BdsBootOptionList
, Buffer
);
3225 case BDS_EFI_MESSAGE_SCSI_BOOT
:
3226 if (ScsiNumber
!= 0) {
3227 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_SCSI
)), ScsiNumber
);
3229 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_SCSI
)));
3231 BdsLibBuildOptionFromHandle (BlockIoHandles
[Index
], BdsBootOptionList
, Buffer
);
3235 case BDS_EFI_MESSAGE_MISC_BOOT
:
3236 if (MiscNumber
!= 0) {
3237 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_MISC
)), MiscNumber
);
3239 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_MISC
)));
3241 BdsLibBuildOptionFromHandle (BlockIoHandles
[Index
], BdsBootOptionList
, Buffer
);
3251 if (NumberBlockIoHandles
!= 0) {
3252 FreePool (BlockIoHandles
);
3256 // If there is simple file protocol which does not consume block Io protocol, create a boot option for it here.
3259 gBS
->LocateHandleBuffer (
3261 &gEfiSimpleFileSystemProtocolGuid
,
3263 &NumberFileSystemHandles
,
3266 for (Index
= 0; Index
< NumberFileSystemHandles
; Index
++) {
3267 Status
= gBS
->HandleProtocol (
3268 FileSystemHandles
[Index
],
3269 &gEfiBlockIoProtocolGuid
,
3272 if (!EFI_ERROR (Status
)) {
3274 // Skip if the file system handle supports a BlkIo protocol,
3280 // Do the removable Media thing. \EFI\BOOT\boot{machinename}.EFI
3281 // machinename is ia32, ia64, x64, ...
3283 Hdr
.Union
= &HdrData
;
3285 Status
= BdsLibGetImageHeader (
3286 FileSystemHandles
[Index
],
3287 EFI_REMOVABLE_MEDIA_FILE_NAME
,
3291 if (!EFI_ERROR (Status
) &&
3292 EFI_IMAGE_MACHINE_TYPE_SUPPORTED (Hdr
.Pe32
->FileHeader
.Machine
) &&
3293 Hdr
.Pe32
->OptionalHeader
.Subsystem
== EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION
) {
3299 // No such file or the file is not a EFI application, delete this boot option
3301 BdsLibDeleteOptionFromHandle (FileSystemHandles
[Index
]);
3303 if (NonBlockNumber
!= 0) {
3304 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NON_BLOCK
)), NonBlockNumber
);
3306 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NON_BLOCK
)));
3308 BdsLibBuildOptionFromHandle (FileSystemHandles
[Index
], BdsBootOptionList
, Buffer
);
3313 if (NumberFileSystemHandles
!= 0) {
3314 FreePool (FileSystemHandles
);
3318 // Parse Network Boot Device
3320 NumOfLoadFileHandles
= 0;
3322 // Search Load File protocol for PXE boot option.
3324 gBS
->LocateHandleBuffer (
3326 &gEfiLoadFileProtocolGuid
,
3328 &NumOfLoadFileHandles
,
3332 for (Index
= 0; Index
< NumOfLoadFileHandles
; Index
++) {
3334 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s %d", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NETWORK
)), Index
);
3336 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"%s", BdsLibGetStringById (STRING_TOKEN (STR_DESCRIPTION_NETWORK
)));
3338 BdsLibBuildOptionFromHandle (LoadFileHandles
[Index
], BdsBootOptionList
, Buffer
);
3341 if (NumOfLoadFileHandles
!= 0) {
3342 FreePool (LoadFileHandles
);
3346 // Check if we have on flash shell
3348 gBS
->LocateHandleBuffer (
3350 &gEfiFirmwareVolume2ProtocolGuid
,
3355 for (Index
= 0; Index
< FvHandleCount
; Index
++) {
3356 gBS
->HandleProtocol (
3357 FvHandleBuffer
[Index
],
3358 &gEfiFirmwareVolume2ProtocolGuid
,
3362 Status
= Fv
->ReadFile (
3364 PcdGetPtr(PcdShellFile
),
3369 &AuthenticationStatus
3371 if (EFI_ERROR (Status
)) {
3373 // Skip if no shell file in the FV
3378 // Build the shell boot option
3380 BdsLibBuildOptionFromShell (FvHandleBuffer
[Index
], BdsBootOptionList
);
3383 if (FvHandleCount
!= 0) {
3384 FreePool (FvHandleBuffer
);
3387 // Make sure every boot only have one time
3388 // boot device enumerate
3390 Status
= BdsLibBuildOptionFromVar (BdsBootOptionList
, L
"BootOrder");
3391 mEnumBootDevice
= TRUE
;
3397 Build the boot option with the handle parsed in
3399 @param Handle The handle which present the device path to create
3401 @param BdsBootOptionList The header of the link list which indexed all
3402 current boot options
3403 @param String The description of the boot option.
3408 BdsLibBuildOptionFromHandle (
3409 IN EFI_HANDLE Handle
,
3410 IN LIST_ENTRY
*BdsBootOptionList
,
3414 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
3416 DevicePath
= DevicePathFromHandle (Handle
);
3419 // Create and register new boot option
3421 BdsLibRegisterNewOption (BdsBootOptionList
, DevicePath
, String
, L
"BootOrder");
3426 Build the on flash shell boot option with the handle parsed in.
3428 @param Handle The handle which present the device path to create
3429 on flash shell boot option
3430 @param BdsBootOptionList The header of the link list which indexed all
3431 current boot options
3436 BdsLibBuildOptionFromShell (
3437 IN EFI_HANDLE Handle
,
3438 IN OUT LIST_ENTRY
*BdsBootOptionList
3441 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
3442 MEDIA_FW_VOL_FILEPATH_DEVICE_PATH ShellNode
;
3444 DevicePath
= DevicePathFromHandle (Handle
);
3447 // Build the shell device path
3449 EfiInitializeFwVolDevicepathNode (&ShellNode
, PcdGetPtr(PcdShellFile
));
3451 DevicePath
= AppendDevicePathNode (DevicePath
, (EFI_DEVICE_PATH_PROTOCOL
*) &ShellNode
);
3454 // Create and register the shell boot option
3456 BdsLibRegisterNewOption (BdsBootOptionList
, DevicePath
, L
"EFI Internal Shell", L
"BootOrder");
3461 Boot from the UEFI spec defined "BootNext" variable.
3473 BDS_COMMON_OPTION
*BootOption
;
3474 LIST_ENTRY TempList
;
3479 // Init the boot option name buffer and temp link list
3481 InitializeListHead (&TempList
);
3482 ZeroMem (Buffer
, sizeof (Buffer
));
3484 BootNext
= BdsLibGetVariableAndSize (
3486 &gEfiGlobalVariableGuid
,
3491 // Clear the boot next variable first
3493 if (BootNext
!= NULL
) {
3496 &gEfiGlobalVariableGuid
,
3497 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
3503 // Start to build the boot option and try to boot
3505 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"Boot%04x", *BootNext
);
3506 BootOption
= BdsLibVariableToOption (&TempList
, Buffer
);
3507 ASSERT (BootOption
!= NULL
);
3508 BdsLibConnectDevicePath (BootOption
->DevicePath
);
3509 BdsLibBootViaBootOption (BootOption
, BootOption
->DevicePath
, &ExitDataSize
, &ExitData
);
3515 Return the bootable media handle.
3516 First, check the device is connected
3517 Second, check whether the device path point to a device which support SimpleFileSystemProtocol,
3518 Third, detect the the default boot file in the Media, and return the removable Media handle.
3520 @param DevicePath Device Path to a bootable device
3522 @return The bootable media handle. If the media on the DevicePath is not bootable, NULL will return.
3527 BdsLibGetBootableHandle (
3528 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
3533 EFI_DEVICE_PATH_PROTOCOL
*UpdatedDevicePath
;
3534 EFI_DEVICE_PATH_PROTOCOL
*DupDevicePath
;
3536 EFI_BLOCK_IO_PROTOCOL
*BlockIo
;
3538 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
3541 EFI_HANDLE ReturnHandle
;
3542 EFI_HANDLE
*SimpleFileSystemHandles
;
3544 UINTN NumberSimpleFileSystemHandles
;
3546 EFI_IMAGE_DOS_HEADER DosHeader
;
3547 EFI_IMAGE_OPTIONAL_HEADER_UNION HdrData
;
3548 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
;
3550 UpdatedDevicePath
= DevicePath
;
3553 // Enter to critical section to protect the acquired BlockIo instance
3554 // from getting released due to the USB mass storage hotplug event
3556 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
3559 // Check whether the device is connected
3561 Status
= gBS
->LocateDevicePath (&gEfiBlockIoProtocolGuid
, &UpdatedDevicePath
, &Handle
);
3562 if (EFI_ERROR (Status
)) {
3564 // Skip the case that the boot option point to a simple file protocol which does not consume block Io protocol,
3566 Status
= gBS
->LocateDevicePath (&gEfiSimpleFileSystemProtocolGuid
, &UpdatedDevicePath
, &Handle
);
3567 if (EFI_ERROR (Status
)) {
3569 // Fail to find the proper BlockIo and simple file protocol, maybe because device not present, we need to connect it firstly
3571 UpdatedDevicePath
= DevicePath
;
3572 Status
= gBS
->LocateDevicePath (&gEfiDevicePathProtocolGuid
, &UpdatedDevicePath
, &Handle
);
3573 gBS
->ConnectController (Handle
, NULL
, NULL
, TRUE
);
3577 // For removable device boot option, its contained device path only point to the removable device handle,
3578 // should make sure all its children handles (its child partion or media handles) are created and connected.
3580 gBS
->ConnectController (Handle
, NULL
, NULL
, TRUE
);
3582 // Get BlockIo protocol and check removable attribute
3584 Status
= gBS
->HandleProtocol (Handle
, &gEfiBlockIoProtocolGuid
, (VOID
**)&BlockIo
);
3585 ASSERT_EFI_ERROR (Status
);
3588 // Issue a dummy read to the device to check for media change.
3589 // When the removable media is changed, any Block IO read/write will
3590 // cause the BlockIo protocol be reinstalled and EFI_MEDIA_CHANGED is
3591 // returned. After the Block IO protocol is reinstalled, subsequent
3592 // Block IO read/write will success.
3594 Buffer
= AllocatePool (BlockIo
->Media
->BlockSize
);
3595 if (Buffer
!= NULL
) {
3596 BlockIo
->ReadBlocks (
3598 BlockIo
->Media
->MediaId
,
3600 BlockIo
->Media
->BlockSize
,
3608 // Detect the the default boot file from removable Media
3612 // 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
3613 // Try to locate the USB node device path first, if fail then use its previous PCI node to search
3615 DupDevicePath
= DuplicateDevicePath (DevicePath
);
3616 ASSERT (DupDevicePath
!= NULL
);
3618 UpdatedDevicePath
= DupDevicePath
;
3619 Status
= gBS
->LocateDevicePath (&gEfiDevicePathProtocolGuid
, &UpdatedDevicePath
, &Handle
);
3621 // 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
3622 // Acpi()/Pci()/Usb() --> Acpi()/Pci()
3624 if ((DevicePathType (UpdatedDevicePath
) == MESSAGING_DEVICE_PATH
) &&
3625 (DevicePathSubType (UpdatedDevicePath
) == MSG_USB_DP
)) {
3627 // Remove the usb node, let the device path only point to PCI node
3629 SetDevicePathEndNode (UpdatedDevicePath
);
3630 UpdatedDevicePath
= DupDevicePath
;
3632 UpdatedDevicePath
= DevicePath
;
3636 // Get the device path size of boot option
3638 Size
= GetDevicePathSize(UpdatedDevicePath
) - sizeof (EFI_DEVICE_PATH_PROTOCOL
); // minus the end node
3639 ReturnHandle
= NULL
;
3640 gBS
->LocateHandleBuffer (
3642 &gEfiSimpleFileSystemProtocolGuid
,
3644 &NumberSimpleFileSystemHandles
,
3645 &SimpleFileSystemHandles
3647 for (Index
= 0; Index
< NumberSimpleFileSystemHandles
; Index
++) {
3649 // Get the device path size of SimpleFileSystem handle
3651 TempDevicePath
= DevicePathFromHandle (SimpleFileSystemHandles
[Index
]);
3652 TempSize
= GetDevicePathSize (TempDevicePath
)- sizeof (EFI_DEVICE_PATH_PROTOCOL
); // minus the end node
3654 // Check whether the device path of boot option is part of the SimpleFileSystem handle's device path
3656 if (Size
<= TempSize
&& CompareMem (TempDevicePath
, UpdatedDevicePath
, Size
)==0) {
3658 // Load the default boot file \EFI\BOOT\boot{machinename}.EFI from removable Media
3659 // machinename is ia32, ia64, x64, ...
3661 Hdr
.Union
= &HdrData
;
3662 Status
= BdsLibGetImageHeader (
3663 SimpleFileSystemHandles
[Index
],
3664 EFI_REMOVABLE_MEDIA_FILE_NAME
,
3668 if (!EFI_ERROR (Status
) &&
3669 EFI_IMAGE_MACHINE_TYPE_SUPPORTED (Hdr
.Pe32
->FileHeader
.Machine
) &&
3670 Hdr
.Pe32
->OptionalHeader
.Subsystem
== EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION
) {
3671 ReturnHandle
= SimpleFileSystemHandles
[Index
];
3677 FreePool(DupDevicePath
);
3679 if (SimpleFileSystemHandles
!= NULL
) {
3680 FreePool(SimpleFileSystemHandles
);
3683 gBS
->RestoreTPL (OldTpl
);
3685 return ReturnHandle
;
3689 Check to see if the network cable is plugged in. If the DevicePath is not
3690 connected it will be connected.
3692 @param DevicePath Device Path to check
3694 @retval TRUE DevicePath points to an Network that is connected
3695 @retval FALSE DevicePath does not point to a bootable network
3699 BdsLibNetworkBootWithMediaPresent (
3700 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
3704 EFI_DEVICE_PATH_PROTOCOL
*UpdatedDevicePath
;
3706 EFI_SIMPLE_NETWORK_PROTOCOL
*Snp
;
3707 BOOLEAN MediaPresent
;
3708 UINT32 InterruptStatus
;
3710 MediaPresent
= FALSE
;
3712 UpdatedDevicePath
= DevicePath
;
3714 // Locate Load File Protocol for PXE boot option first
3716 Status
= gBS
->LocateDevicePath (&gEfiLoadFileProtocolGuid
, &UpdatedDevicePath
, &Handle
);
3717 if (EFI_ERROR (Status
)) {
3719 // Device not present so see if we need to connect it
3721 Status
= BdsLibConnectDevicePath (DevicePath
);
3722 if (!EFI_ERROR (Status
)) {
3724 // This one should work after we did the connect
3726 Status
= gBS
->LocateDevicePath (&gEfiLoadFileProtocolGuid
, &UpdatedDevicePath
, &Handle
);
3730 if (!EFI_ERROR (Status
)) {
3731 Status
= gBS
->HandleProtocol (Handle
, &gEfiSimpleNetworkProtocolGuid
, (VOID
**)&Snp
);
3732 if (EFI_ERROR (Status
)) {
3734 // Failed to open SNP from this handle, try to get SNP from parent handle
3736 UpdatedDevicePath
= DevicePathFromHandle (Handle
);
3737 if (UpdatedDevicePath
!= NULL
) {
3738 Status
= gBS
->LocateDevicePath (&gEfiSimpleNetworkProtocolGuid
, &UpdatedDevicePath
, &Handle
);
3739 if (!EFI_ERROR (Status
)) {
3741 // SNP handle found, get SNP from it
3743 Status
= gBS
->HandleProtocol (Handle
, &gEfiSimpleNetworkProtocolGuid
, (VOID
**) &Snp
);
3748 if (!EFI_ERROR (Status
)) {
3749 if (Snp
->Mode
->MediaPresentSupported
) {
3750 if (Snp
->Mode
->State
== EfiSimpleNetworkInitialized
) {
3752 // Invoke Snp->GetStatus() to refresh the media status
3754 Snp
->GetStatus (Snp
, &InterruptStatus
, NULL
);
3757 // In case some one else is using the SNP check to see if it's connected
3759 MediaPresent
= Snp
->Mode
->MediaPresent
;
3762 // No one is using SNP so we need to Start and Initialize so
3763 // MediaPresent will be valid.
3765 Status
= Snp
->Start (Snp
);
3766 if (!EFI_ERROR (Status
)) {
3767 Status
= Snp
->Initialize (Snp
, 0, 0);
3768 if (!EFI_ERROR (Status
)) {
3769 MediaPresent
= Snp
->Mode
->MediaPresent
;
3770 Snp
->Shutdown (Snp
);
3776 MediaPresent
= TRUE
;
3781 return MediaPresent
;
3785 For a bootable Device path, return its boot type.
3787 @param DevicePath The bootable device Path to check
3789 @retval BDS_EFI_MEDIA_HD_BOOT If given device path contains MEDIA_DEVICE_PATH type device path node
3790 which subtype is MEDIA_HARDDRIVE_DP
3791 @retval BDS_EFI_MEDIA_CDROM_BOOT If given device path contains MEDIA_DEVICE_PATH type device path node
3792 which subtype is MEDIA_CDROM_DP
3793 @retval BDS_EFI_ACPI_FLOPPY_BOOT If given device path contains ACPI_DEVICE_PATH type device path node
3794 which HID is floppy device.
3795 @retval BDS_EFI_MESSAGE_ATAPI_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node
3796 and its last device path node's subtype is MSG_ATAPI_DP.
3797 @retval BDS_EFI_MESSAGE_SCSI_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node
3798 and its last device path node's subtype is MSG_SCSI_DP.
3799 @retval BDS_EFI_MESSAGE_USB_DEVICE_BOOT If given device path contains MESSAGING_DEVICE_PATH type device path node
3800 and its last device path node's subtype is MSG_USB_DP.
3801 @retval BDS_EFI_MESSAGE_MISC_BOOT If the device path not contains any media device path node, and
3802 its last device path node point to a message device path node.
3803 @retval BDS_LEGACY_BBS_BOOT If given device path contains BBS_DEVICE_PATH type device path node.
3804 @retval BDS_EFI_UNSUPPORT An EFI Removable BlockIO device path not point to a media and message device,
3809 BdsGetBootTypeFromDevicePath (
3810 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
3813 ACPI_HID_DEVICE_PATH
*Acpi
;
3814 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
3815 EFI_DEVICE_PATH_PROTOCOL
*LastDeviceNode
;
3818 if (NULL
== DevicePath
) {
3819 return BDS_EFI_UNSUPPORT
;
3822 TempDevicePath
= DevicePath
;
3824 while (!IsDevicePathEndType (TempDevicePath
)) {
3825 switch (DevicePathType (TempDevicePath
)) {
3826 case BBS_DEVICE_PATH
:
3827 return BDS_LEGACY_BBS_BOOT
;
3828 case MEDIA_DEVICE_PATH
:
3829 if (DevicePathSubType (TempDevicePath
) == MEDIA_HARDDRIVE_DP
) {
3830 return BDS_EFI_MEDIA_HD_BOOT
;
3831 } else if (DevicePathSubType (TempDevicePath
) == MEDIA_CDROM_DP
) {
3832 return BDS_EFI_MEDIA_CDROM_BOOT
;
3835 case ACPI_DEVICE_PATH
:
3836 Acpi
= (ACPI_HID_DEVICE_PATH
*) TempDevicePath
;
3837 if (EISA_ID_TO_NUM (Acpi
->HID
) == 0x0604) {
3838 return BDS_EFI_ACPI_FLOPPY_BOOT
;
3841 case MESSAGING_DEVICE_PATH
:
3843 // Get the last device path node
3845 LastDeviceNode
= NextDevicePathNode (TempDevicePath
);
3846 if (DevicePathSubType(LastDeviceNode
) == MSG_DEVICE_LOGICAL_UNIT_DP
) {
3848 // if the next node type is Device Logical Unit, which specify the Logical Unit Number (LUN),
3851 LastDeviceNode
= NextDevicePathNode (LastDeviceNode
);
3854 // if the device path not only point to driver device, it is not a messaging device path,
3856 if (!IsDevicePathEndType (LastDeviceNode
)) {
3860 switch (DevicePathSubType (TempDevicePath
)) {
3862 BootType
= BDS_EFI_MESSAGE_ATAPI_BOOT
;
3866 BootType
= BDS_EFI_MESSAGE_USB_DEVICE_BOOT
;
3870 BootType
= BDS_EFI_MESSAGE_SCSI_BOOT
;
3874 BootType
= BDS_EFI_MESSAGE_SATA_BOOT
;
3877 case MSG_MAC_ADDR_DP
:
3881 BootType
= BDS_EFI_MESSAGE_MAC_BOOT
;
3885 BootType
= BDS_EFI_MESSAGE_MISC_BOOT
;
3893 TempDevicePath
= NextDevicePathNode (TempDevicePath
);
3896 return BDS_EFI_UNSUPPORT
;
3900 Check whether the Device path in a boot option point to a valid bootable device,
3901 And if CheckMedia is true, check the device is ready to boot now.
3903 @param DevPath the Device path in a boot option
3904 @param CheckMedia if true, check the device is ready to boot now.
3906 @retval TRUE the Device path is valid
3907 @retval FALSE the Device path is invalid .
3912 BdsLibIsValidEFIBootOptDevicePath (
3913 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
,
3914 IN BOOLEAN CheckMedia
3917 return BdsLibIsValidEFIBootOptDevicePathExt (DevPath
, CheckMedia
, NULL
);
3921 Check whether the Device path in a boot option point to a valid bootable device,
3922 And if CheckMedia is true, check the device is ready to boot now.
3923 If Description is not NULL and the device path point to a fixed BlockIo
3924 device, check the description whether conflict with other auto-created
3927 @param DevPath the Device path in a boot option
3928 @param CheckMedia if true, check the device is ready to boot now.
3929 @param Description the description in a boot option
3931 @retval TRUE the Device path is valid
3932 @retval FALSE the Device path is invalid .
3937 BdsLibIsValidEFIBootOptDevicePathExt (
3938 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
,
3939 IN BOOLEAN CheckMedia
,
3940 IN CHAR16
*Description
3945 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
3946 EFI_DEVICE_PATH_PROTOCOL
*LastDeviceNode
;
3947 EFI_BLOCK_IO_PROTOCOL
*BlockIo
;
3949 TempDevicePath
= DevPath
;
3950 LastDeviceNode
= DevPath
;
3953 // Check if it's a valid boot option for network boot device.
3954 // Check if there is EfiLoadFileProtocol installed.
3955 // If yes, that means there is a boot option for network.
3957 Status
= gBS
->LocateDevicePath (
3958 &gEfiLoadFileProtocolGuid
,
3962 if (EFI_ERROR (Status
)) {
3964 // Device not present so see if we need to connect it
3966 TempDevicePath
= DevPath
;
3967 BdsLibConnectDevicePath (TempDevicePath
);
3968 Status
= gBS
->LocateDevicePath (
3969 &gEfiLoadFileProtocolGuid
,
3975 if (!EFI_ERROR (Status
)) {
3976 if (!IsDevicePathEnd (TempDevicePath
)) {
3978 // LoadFile protocol is not installed on handle with exactly the same DevPath
3985 // Test if it is ready to boot now
3987 if (BdsLibNetworkBootWithMediaPresent(DevPath
)) {
3996 // If the boot option point to a file, it is a valid EFI boot option,
3997 // and assume it is ready to boot now
3999 while (!IsDevicePathEnd (TempDevicePath
)) {
4001 // If there is USB Class or USB WWID device path node, treat it as valid EFI
4002 // Boot Option. BdsExpandUsbShortFormDevicePath () will be used to expand it
4003 // to full device path.
4005 if ((DevicePathType (TempDevicePath
) == MESSAGING_DEVICE_PATH
) &&
4006 ((DevicePathSubType (TempDevicePath
) == MSG_USB_CLASS_DP
) ||
4007 (DevicePathSubType (TempDevicePath
) == MSG_USB_WWID_DP
))) {
4011 LastDeviceNode
= TempDevicePath
;
4012 TempDevicePath
= NextDevicePathNode (TempDevicePath
);
4014 if ((DevicePathType (LastDeviceNode
) == MEDIA_DEVICE_PATH
) &&
4015 (DevicePathSubType (LastDeviceNode
) == MEDIA_FILEPATH_DP
)) {
4020 // Check if it's a valid boot option for internal FV application
4022 if (EfiGetNameGuidFromFwVolDevicePathNode ((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
*) LastDeviceNode
) != NULL
) {
4024 // If the boot option point to internal FV application, make sure it is valid
4026 TempDevicePath
= DevPath
;
4027 Status
= BdsLibUpdateFvFileDevicePath (
4029 EfiGetNameGuidFromFwVolDevicePathNode ((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
*) LastDeviceNode
)
4031 if (Status
== EFI_ALREADY_STARTED
) {
4034 if (Status
== EFI_SUCCESS
) {
4035 FreePool (TempDevicePath
);
4042 // If the boot option point to a blockIO device:
4043 // if it is a removable blockIo device, it is valid.
4044 // if it is a fixed blockIo device, check its description confliction.
4046 TempDevicePath
= DevPath
;
4047 Status
= gBS
->LocateDevicePath (&gEfiBlockIoProtocolGuid
, &TempDevicePath
, &Handle
);
4048 if (EFI_ERROR (Status
)) {
4050 // Device not present so see if we need to connect it
4052 Status
= BdsLibConnectDevicePath (DevPath
);
4053 if (!EFI_ERROR (Status
)) {
4055 // Try again to get the Block Io protocol after we did the connect
4057 TempDevicePath
= DevPath
;
4058 Status
= gBS
->LocateDevicePath (&gEfiBlockIoProtocolGuid
, &TempDevicePath
, &Handle
);
4062 if (!EFI_ERROR (Status
)) {
4063 Status
= gBS
->HandleProtocol (Handle
, &gEfiBlockIoProtocolGuid
, (VOID
**)&BlockIo
);
4064 if (!EFI_ERROR (Status
)) {
4067 // Test if it is ready to boot now
4069 if (BdsLibGetBootableHandle (DevPath
) != NULL
) {
4078 // 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,
4080 Status
= gBS
->LocateDevicePath (&gEfiSimpleFileSystemProtocolGuid
, &TempDevicePath
, &Handle
);
4081 if (!EFI_ERROR (Status
)) {
4084 // Test if it is ready to boot now
4086 if (BdsLibGetBootableHandle (DevPath
) != NULL
) {
4100 According to a file guild, check a Fv file device path is valid. If it is invalid,
4101 try to return the valid device path.
4102 FV address maybe changes for memory layout adjust from time to time, use this function
4103 could promise the Fv file device path is right.
4105 @param DevicePath on input, the Fv file device path need to check on
4106 output, the updated valid Fv file device path
4107 @param FileGuid the Fv file guild
4109 @retval EFI_INVALID_PARAMETER the input DevicePath or FileGuid is invalid
4111 @retval EFI_UNSUPPORTED the input DevicePath does not contain Fv file
4113 @retval EFI_ALREADY_STARTED the input DevicePath has pointed to Fv file, it is
4115 @retval EFI_SUCCESS has successfully updated the invalid DevicePath,
4116 and return the updated device path in DevicePath
4121 BdsLibUpdateFvFileDevicePath (
4122 IN OUT EFI_DEVICE_PATH_PROTOCOL
** DevicePath
,
4123 IN EFI_GUID
*FileGuid
4126 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
4127 EFI_DEVICE_PATH_PROTOCOL
*LastDeviceNode
;
4129 EFI_GUID
*GuidPoint
;
4131 UINTN FvHandleCount
;
4132 EFI_HANDLE
*FvHandleBuffer
;
4133 EFI_FV_FILETYPE Type
;
4135 EFI_FV_FILE_ATTRIBUTES Attributes
;
4136 UINT32 AuthenticationStatus
;
4138 EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
;
4139 EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
;
4140 MEDIA_FW_VOL_FILEPATH_DEVICE_PATH FvFileNode
;
4141 EFI_HANDLE FoundFvHandle
;
4142 EFI_DEVICE_PATH_PROTOCOL
*NewDevicePath
;
4144 if ((DevicePath
== NULL
) || (*DevicePath
== NULL
)) {
4145 return EFI_INVALID_PARAMETER
;
4147 if (FileGuid
== NULL
) {
4148 return EFI_INVALID_PARAMETER
;
4152 // Check whether the device path point to the default the input Fv file
4154 TempDevicePath
= *DevicePath
;
4155 LastDeviceNode
= TempDevicePath
;
4156 while (!IsDevicePathEnd (TempDevicePath
)) {
4157 LastDeviceNode
= TempDevicePath
;
4158 TempDevicePath
= NextDevicePathNode (TempDevicePath
);
4160 GuidPoint
= EfiGetNameGuidFromFwVolDevicePathNode (
4161 (MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
*) LastDeviceNode
4163 if (GuidPoint
== NULL
) {
4165 // if this option does not points to a Fv file, just return EFI_UNSUPPORTED
4167 return EFI_UNSUPPORTED
;
4169 if (!CompareGuid (GuidPoint
, FileGuid
)) {
4171 // If the Fv file is not the input file guid, just return EFI_UNSUPPORTED
4173 return EFI_UNSUPPORTED
;
4177 // Check whether the input Fv file device path is valid
4179 TempDevicePath
= *DevicePath
;
4180 FoundFvHandle
= NULL
;
4181 Status
= gBS
->LocateDevicePath (
4182 &gEfiFirmwareVolume2ProtocolGuid
,
4186 if (!EFI_ERROR (Status
)) {
4187 Status
= gBS
->HandleProtocol (
4189 &gEfiFirmwareVolume2ProtocolGuid
,
4192 if (!EFI_ERROR (Status
)) {
4194 // Set FV ReadFile Buffer as NULL, only need to check whether input Fv file exist there
4196 Status
= Fv
->ReadFile (
4203 &AuthenticationStatus
4205 if (!EFI_ERROR (Status
)) {
4206 return EFI_ALREADY_STARTED
;
4212 // Look for the input wanted FV file in current FV
4213 // First, try to look for in Bds own FV. Bds and input wanted FV file usually are in the same FV
4216 FoundFvHandle
= NULL
;
4217 Status
= gBS
->HandleProtocol (
4219 &gEfiLoadedImageProtocolGuid
,
4220 (VOID
**) &LoadedImage
4222 if (!EFI_ERROR (Status
)) {
4223 Status
= gBS
->HandleProtocol (
4224 LoadedImage
->DeviceHandle
,
4225 &gEfiFirmwareVolume2ProtocolGuid
,
4228 if (!EFI_ERROR (Status
)) {
4229 Status
= Fv
->ReadFile (
4236 &AuthenticationStatus
4238 if (!EFI_ERROR (Status
)) {
4240 FoundFvHandle
= LoadedImage
->DeviceHandle
;
4245 // Second, if fail to find, try to enumerate all FV
4248 FvHandleBuffer
= NULL
;
4249 gBS
->LocateHandleBuffer (
4251 &gEfiFirmwareVolume2ProtocolGuid
,
4256 for (Index
= 0; Index
< FvHandleCount
; Index
++) {
4257 gBS
->HandleProtocol (
4258 FvHandleBuffer
[Index
],
4259 &gEfiFirmwareVolume2ProtocolGuid
,
4263 Status
= Fv
->ReadFile (
4270 &AuthenticationStatus
4272 if (EFI_ERROR (Status
)) {
4274 // Skip if input Fv file not in the FV
4279 FoundFvHandle
= FvHandleBuffer
[Index
];
4283 if (FvHandleBuffer
!= NULL
) {
4284 FreePool (FvHandleBuffer
);
4290 // Build the shell device path
4292 NewDevicePath
= DevicePathFromHandle (FoundFvHandle
);
4293 EfiInitializeFwVolDevicepathNode (&FvFileNode
, FileGuid
);
4294 NewDevicePath
= AppendDevicePathNode (NewDevicePath
, (EFI_DEVICE_PATH_PROTOCOL
*) &FvFileNode
);
4295 *DevicePath
= NewDevicePath
;
4298 return EFI_NOT_FOUND
;